Review JSON output for all odo commands

[kadel]

One more acceptance criteria would be to

• JSON Output for devfile needs to have long term design as we cannot break it after v2

• review existing commands as mentioned below

List of all commands that vscode adapter uses - https://github.com/redhat-developer/vscode-openshift-tools/blob/8b9baa56a77d02a54a37fd4532a3d1948ed53a01/src/odo.ts#L36

listProjects

vscode plugin executes: oc get project -o jsonpath="{range .items[?(.status.phase == \\"Active\\" )]}{.metadata.name}{\\"\\n\\"}{end}"'

odo project list -o json

Note: (we don't need/have --project flag for odo project list )

Question: do we need this flag to retrieve specific project (equivalent can be odo project get)

{
    "kind": "List",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {},
    "items": [
        {
            "kind": "Project",
            "apiVersion": "odo.openshift.io/v1alpha1",
            "metadata": {
                "name": "myproject",
            },
            "spec": {
                "apps": [
                    "myapp",
                ]
            },
           "status": {
              "active": false
            }
        }
    ]
}

TODO:

• remove status.active field

listApplications

vscode plugin executes: odo application list --project ${project} -o json

{
    "kind": "List",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "items": [
        {
            "kind": "Application",
            "apiVersion": "odo.openshift.io/v1alpha1",
            "metadata": {
                "name": "app",
                "namespace": "myproject"
            },
            "spec": {
                "components": [
                    "java-jpxy",
                    "nodejs-ngrl",
                    "nodejs-yvnq"
                ]
            }
        }
    ]
}

TODO:

• remove status.active field
• Issue: Remove active field from application resource #1866

deleteProject

vscode plugin executes: odo project delete ${name} -f

odo project delete ${name} -f -o json
On success:

• exitcode 0, and no other output on stdout or stderr.

On failure:

• exitcode >0, json output on stderr

{
    "kind": "Error",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "namespace": "myproject",
    },
    "message": "Unable to delete project myproject"
}

TODO:

• Add -o json

waitForProjectToBeGone

vscode plugin executes: oc wait project/${project} --for delete

This command should not be needed, as odo project delete should wait for the project to be deleted.

TODO:

• implement --wait flag

createProject

vscode plugin executes: odo project create ${name}

odo project create ${name} -o json

{
    "kind": "Project",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "name": "myproject",
        "namespace": "myproject",
    }
}

if error, return error exit code (>0) and stderr :

{
    "kind": "Error",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "namespace": "myproject",
    },
    "message": "Unable to create project myproject"
}

TODO:

• implement -o json

listComponents

odo list --app ${app} --project ${project} -o json

STATUS: we already have this

listCatalogComponents

odo catalog list components

STATUS: we already have this & we don't need json for this

listCatalogServices

odo catalog list services

STATUS: we already have this & we don't need json for this

listStorageNames

odo storage list --app ${app} --project ${project} --component ${component} -o json

listServiceInstances:

oc get ServiceInstance -o jsonpath="{range .items[?(.metadata.labels.app == \\"${app}\\")]}{.metadata.labels.app\\.kubernetes\\.io/component-name}{\\"\\n\\"}{end}" --namespace ${project}

createApplication

odo app create ${app} --project ${project}

describeApplication

odo app describe ${app} --project ${project}

STATUS: we already have this command and json output

deleteApplication

odo app delete ${app} --project ${project} -f,

createStorage

odo storage create ${storageName} --path=${mountPath} --size=${storageSize} --project ${project} --app ${app} --component ${component}

deleteStorage

odo storage delete ${storage} -f --project ${project} --app ${app} --component ${component}

waitForStorageToBeGone

oc wait pvc/${storage}-${app}-pvc --for=delete --namespace ${project}

deleteComponent

odo delete ${component} -f --app ${app} --project ${project}

describeComponent

odo describe ${component} --app ${app} --project ${project}

STATUS: we already have this command & json output

describeService

odo catalog describe service ${service}

STATUS: we already have this command & we don't need json output for this

showLog

odo log ${component} --app ${app} --project ${project}

STATUS: we already have this command & we don't need json output for this

showLogAndFollow

odo log ${component} -f --app ${app} --project ${project}

STATUS: we already have this command & we don't need json output for this

listComponentPorts

oc get service ${component}-${app} --namespace ${project} -o jsonpath="{range .spec.ports[*]}{.port}{','}{end}"

STATUS: I think #1828 will solve this problem partially. as after this PR, odo create will get all the ports and put it in localconfig files, from their, vscode extensions can grab.

linkComponentTo

odo project set ${project} && odo application set ${app} && odo component set ${component} && odo link ${componentToLink} --wait${port ? ' --port ' + port : ''}

pushComponent

odo push ${component} --app ${app} --project ${project}

ALERT:

• we don't have --app and --project flag to odo push instead we have --context flag

pushLocalComponent

${Command.pushComponent(project, app, component)} --local ${location}

watchComponent

odo watch ${component} --app ${app} --project ${project}

STATUS: we already have this & we don't need json output for this

getRouteHostName

oc get route --namespace ${namespace} -o jsonpath="{range .items[?(.metadata.labels.app\\.kubernetes\\.io/component-name=='${component}')]}{.spec.host}{end}"

TODO:

equivalent command should be odo url list --component nodejs-zeaa --project myproject -q

• here, we need to add -q flag which will return url

createLocalComponent

odo create ${type}:${version} ${name} --local ${folder} --app ${app} --project ${project}

createGitComponent

odo create ${type}:${version} ${name} --git ${git} --ref ${ref} --app ${app} --project ${project}

createBinaryComponent

odo create ${type}:${version} ${name} --binary ${binary} --app ${app} --project ${project}

createService

odo service create ${template} --plan ${plan} ${name} --app ${app} --project ${project} -w

deleteService

odo service delete ${name} -f --project ${project} --app ${app}

getServiceTemplate

oc get ServiceInstance ${service} --namespace ${project} -o jsonpath="{$.metadata.labels.app\\.kubernetes\\.io/component-type}"

waitForServiceToBeGone

oc wait ServiceInstance/${service} --for delete --namespace ${project}

createComponentCustomUrl

odo url create ${name} --port ${port} --project ${project} --app ${app} --component ${component}

STATUS: odo url create just modifies local config, so I think we don't need json output

getComponentUrl

odo url list --component ${component} --app ${app} --project ${project} -o json

STATUS: we already have this

getComponentJson

oc get service ${component}-${app} --namespace ${project} -o json

QUERY: why we need output of service ?

[kadel]

/priority high

[surajnarwade]

listProjects
vscode plugin executes: oc get project -o jsonpath="{range .items[?(.status.phase == \"Active\" )]}{.metadata.name}{\"\n\"}{end}"'

odo project list --project ${project} -o json

if we want single project json, we can use odo project get

[surajnarwade]

Tracking

• listProjects (Added in Added machine readable struct for odo project list #1370)
• listApplications (resolved in Removed active field for application #1867)
• deleteProject
• waitForProjectToBeGone (TODO: Implement --wait flag for odo project delete #1884)
• createProject
• listComponents (Added in Machine Readable Output #1196)
• listCatalogComponents (issue Machine output in case of catalog list operation #1357) (TODO: Machine output in case of catalog list operation #1357 (comment))
• listCatalogServices (issue Machine output in case of catalog list operation #1357) (TODO: Machine output in case of catalog list operation #1357 (comment))
• listStorageNames (Added in Machine Readable Output #1196)
• listServiceInstances
• createApplication
• describeApplication (Added in Machine Readable Output #1196)
• deleteApplication (added in Add -o json flag to odo app delete  #1456, might need little bit improvement)
• createStorage
• deleteStorage
• waitForStorageToBeGone (TODO: Implement --wait flag for odo storage delete #1942 )
• deleteComponent
• describeComponent (Added in Machine Readable Output #1196)
• describeService
• showLog (we don't need machine output for odo log)
• showLogAndFollow (we don't need machine output for odo log)
• listComponentPorts (TODO: Add ports information into odo describe <componentName> #1481)
• linkComponentTo
• pushComponent (TODO: Update odo push flags vscode-openshift-tools#918, not sure about json output)
• pushLocalComponent (I think we don't need json output for push)
• watchComponent (we don't need machine output for odo watch)
• getRouteHostName (as @kadel mentioed here Review JSON output for all odo commands #1739 (comment), can be done using also odo url list -o json)
• createLocalComponent
• createGitComponent
• createBinaryComponent
• createService
• deleteService
• getServiceTemplate
• waitForServiceToBeGone (TODO: Implement --wait flag for odo service delete #1943)
• createComponentCustomUrl (odo url create just modifies local config, still do we need json output ❓ )
• getComponentUrl (Added in Machine Readable Output #1196)
• getComponentJson (why we need this ❓ )

[cdrage]

Charlie's list

Other stuff being done:

• [x] Make --output a global parameter Make --output a global parameter, disable logging, fix bug #1898

Functions to go over

Crossed out = it's done / PR merged in

• [x] listProjects (see Remove status from machine output #1870)
• [x] listApplications (see Remove active field from application resource #1866 / @surajnarwade 's PR)
• [x] deleteProject (see Add odo project delete -o json #1960)
• waitForProjectToBeGone (TODO: Implement --wait flag for odo project delete #1884)
• [x] createProject (added via Adds odo create project -o json output #1916)
• [x] listComponents (added in Machine Readable Output #1196)
• [x] listCatalogComponents (TODO: see Machine output in case of catalog list operation #1357)
• [x] listCatalogServices (TODO: see Machine output in case of catalog list operation #1357)
• [x] listStorageNames (added Machine Readable Output #1196)
• [x] listServiceInstances (discussion here: Implement odo services list -o json / listServiceInstances #2054)
• [x] createApplication (we no longer use createApplication... deprecated)
• [x] describeApplication (added via Machine Readable Output #1196)
• [x] deleteApplication (added Add -o json flag to odo app delete  #1456)
• [x] createStorage (already implemented)
• deleteStorage (TODO: Added -o json for storage creation / deletion / waiting #2055)
• waitForStorageToBeGone (TODO: Added -o json for storage creation / deletion / waiting #2055)
• deleteComponent (TODO: Add odo delete -o json functionality #2056)
• describeComponent (added Machine Readable Output #1196)
• [ ] describeService (TODO: Add odo catalog describe service $FOOBAR -o json output #2057)
• [x] showLog (we dont need this / deprecated)
• [x] showLogAndFollow (we dont need this / deprecated)
• listComponentPorts (this has been partially solved within --port is no longer mandatory for odo url create #1828 however it would need to be fixed / implemented downstream)
• [ ] linkComponentTo (TODO: see Shortcut for linking a component? #2058) this will not be implemented, see issue
• [x] pushComponent (fixed: redhat-developer/vscode-openshift-tools@9de60c2)
• [x] pushLocalComponent (no json output needed for this...)
• [x] watchComponent (don't need machine output for odo watch)
• [x] getRouteHostName (can be done using -o json with odo url list)
• [x] createLocalComponent (json already implemented for this but not used upstream...)
• [x] createGitComponent (json already implemented for this but not used upstream...)
• [x] createBinaryComponent (json already implemented for this but not used upstream...)
• createService (TODO: opened issue Add json support for odo service delete #2076)
• deleteService (TODO: opened issue Add json support for odo service delete #2076)
• [ ] getServiceTemplate (TODO, same as: Implement odo services list -o json / listServiceInstances #2054) closed via Adds odo service list -o json #2098
• waitForServiceToBeGone (TODO, see: Add wait command for deleting service #2077)
• createComponentCustomUrl (TODO, investigate, but probably dont need this...)
• [x] getComponentUrl (already completed)
• getComponentJson (TODO, need to investigate, but may not need this)

Other todo:

• Update documentation on machine readable output

[kadel]

listComponentPorts

oc get service ${component}-${app} --namespace ${project} -o jsonpath="{range .spec.ports[*]}{.port}{','}{end}"

STATUS: I think #1828 will solve this problem partially. as after this PR, odo create will get all the ports and put it in localconfig files, from their, vscode extensions can grab.

odo will need command to display this information. The extensions should never read the localconfig files directly.
I think that odo component describe is a good place where this information should be shown

[kadel]

getRouteHostName

oc get route --namespace ${namespace} -o jsonpath="{range .items[?(.metadata.labels.app\\.kubernetes\\.io/component-name=='${component}')]}{.spec.host}{end}"

TODO:

equivalent command should be odo url list --component nodejs-zeaa --project myproject -q

• here, we need to add -q flag which will return url

-q won't be needed.
It should be possible to pick up the hostname from odo url list --component nodejs-zeaa --project myproject -o json output

[cdrage]

Hey @dgolovin I'm going over deleteProject right now...

I was thinking of this in terms of implementation, or of course something similar, this is a super rough draft...

    "kind": "Success",
    "apiVersion": "odo.openshift.io/v1alpha1",
    "metadata": {
        "namespace": "myproject",
    },
    "message": "Deleted foobar"
    "project": foobar,
}

Or is there something specific we should implement in a certain way?

[cdrage]

Update:

So currently I have to implement a few changes in order to correctly add creation / deletion json output for odo project create/delete commands. I just want to give a quick update to both @surajnarwade @tkral and @degolovi that in order to do so I have to:

• Add a json global parameter so we can detect if we are indeed doing machine readable output. This would of been added anyways since we have to have json output for (almost) every command for odo
• Change how logging works by detecting if we're using -o json and disabling ANY form of logging in order to prevent malformed json (normal output + json)

[kadel]

/label points/13

/unassign @cdrage

[openshift-ci-robot]

@kadel: The label(s) /label points/13 cannot be applied. These labels are supported: platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga

In response to this:

/label points/13

/unassign @cdrage

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[cdrage]

/lifecycle frozen

[kadel]

This issues is not valid anymore. With coming v3 the json output will have to be reworked in a completely different way.

[kadel]

This issues is not valid anymore. With coming v3 the json output will have to be reworked in a completely different way.

[kadel]

This issues is not valid anymore. With coming v3 the json output will have to be reworked in a completely different way.