alihan/odo
1
0
Fork 0
mirror of https://github.com/redhat-developer/odo.git synced 2025-10-19 03:06:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add machine output documentation (#2678)

Browse Source 
**What type of PR is this?**

> /kind documentation

**What does does this PR do / why we need it**:

Adds a table and references to machine output documentation

**Which issue(s) this PR fixes**:

N/A

**How to test changes / Special notes to the reviewer**:

View the doc

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
This commit is contained in:
Charlie Drage
2020-03-13 14:47:53 -04:00
committed by GitHub
parent eeda934eca
commit b9bdb6bbbb
2 changed files with 295 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

326
docs/dev/machine-output.md → docs/dev/machine-output.adoc
View File

@@ -1,10 +1,173 @@
# Machine Readable Output = Machine readable output
This document outlines all the machine readable output options and examples. This document outlines all the machine readable output options and examples.
`odo app describe -o json | jq` See the below table for a list of all possible machine readable output commands:
```json |===
| Command | Subcommand | Implemented?
| application
| delete
| N
|
| <<application-describe,describe>>
| Y
|
| <<application-list,list>>
| Y
| catalog
| describe
| N
|
| search
| N
|
| <<catalog-list-components,list components>>
| Y
|
| <<catalog-list-services,list services>>
| Y
| component
| <<component-create,create>>
| Y
|
| delete
| N
|
| describe
| N
|
| link
| N
|
| list
| N
|
| log
| N
|
| push
| N
|
| unlink
| N
|
| update
| N
|
| watch
| N
| config
| set
| N
|
| unset
| N
|
| view
| N
| debug
| info
| N
|
| port-forward
| N
| preference
| set
| N
|
| unset
| N
|
| view
| N
| project
| <<project-create,create>>
| Y
|
| <<project-delete,delete>>
| Y
|
| get
| N
|
| <<project-list,list>>
| Y
|
| set
| N
| service
| <<service-create,create>>
| Y
|
| delete
| N
|
| <<service-list,list>>
| Y
| storage
| <<storage-create,create>>
| Y
|
| delete
| N
|
| <<storage-list,list>>
| Y
| url
| create
| N
|
| delete
| N
|
| <<url-list,list>>
| Y
|===
== application describe
[source,json]
----
{ {
"kind": "Application", "kind": "Application",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -18,12 +181,12 @@ This document outlines all the machine readable output options and examples.
"active": false "active": false
} }
} }
``` ----
== application list
`odo app list -o json | jq` [source,json]
----
```json
{ {
"kind": "List", "kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -48,40 +211,12 @@ This document outlines all the machine readable output options and examples.
} }
] ]
} }
``` ----
== component describe
`odo app list --project myproject -o json | jq` [source,json]
----
```json
{
"kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1",
"metadata": {},
"items": [
{
"kind": "app",
"apiVersion": "odo.openshift.io/v1alpha1",
"metadata": {
"name": "app",
"namespace": "myproject",
"creationTimestamp": null
},
"spec": {
"components": [
"app-nodejs-komz"
]
}
}
]
}
```
`odo component describe -o json | jq`
```json
{ {
"kind": "Component", "kind": "Component",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -105,69 +240,12 @@ This document outlines all the machine readable output options and examples.
"state": "Pushed" "state": "Pushed"
} }
} }
``` ----
== component list
`odo component list --output json | jq` [source,json]
----
```json
{
"kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1",
"metadata": {},
"items": [
{
"kind": "Component",
"apiVersion": "odo.openshift.io/v1alpha1",
"metadata": {
"name": "nodejs-vzae",
"creationTimestamp": null
},
"spec": {
"type": "nodejs",
"source": "file://./"
},
"status": {
"state": "Pushed"
}
}
]
}
```
`odo describe -o json | jq`
```json
{
"kind": "Component",
"apiVersion": "odo.openshift.io/v1alpha1",
"metadata": {
"name": "nodejs-nvnh",
"creationTimestamp": null
},
"spec": {
"type": "nodejs",
"source": "file://./",
"url": [
"example",
"json",
"nodejs-nvnh-8080"
],
"storage": [
"mystorage"
]
},
"status": {
"state": "Pushed"
}
}
```
`odo list -o json | jq`
```json
{ {
"kind": "List", "kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -198,12 +276,12 @@ This document outlines all the machine readable output options and examples.
} }
] ]
} }
``` ----
== project list
`odo project list -o json | jq` [source,json]
----
```json
{ {
"kind": "List", "kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -227,12 +305,12 @@ This document outlines all the machine readable output options and examples.
} }
] ]
} }
``` ----
== storage create
`$ odo storage create mystorage --path /opt/foobar --size=1Gi -o json | jq` [source,json]
----
```json
{ {
"kind": "storage", "kind": "storage",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -243,14 +321,14 @@ This document outlines all the machine readable output options and examples.
"spec": { "spec": {
"size": "1Gi" "size": "1Gi"
"path": "/opt/foobar" "path": "/opt/foobar"
} },
} }
``` ----
== storage list
`$ odo storage list -o json | jq` [source,json]
----
```json
{ {
"kind": "List", "kind": "List",
"apiVersion": "odo.openshift.io/v1aplha1", "apiVersion": "odo.openshift.io/v1aplha1",
@@ -266,16 +344,16 @@ This document outlines all the machine readable output options and examples.
"spec": { "spec": {
"size": "1Gi" "size": "1Gi"
"path": "/opt/foobar" "path": "/opt/foobar"
} },
} }
] ]
} }
``` ----
== url create
`$ odo url create -o json | jq` [source,json]
----
```json
{ {
"kind": "url", "kind": "url",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -289,12 +367,12 @@ This document outlines all the machine readable output options and examples.
"port": 8080 "port": 8080
} }
} }
``` ----
== url list
`$ odo url list -o json | jq` [source,json]
----
```json
{ {
"kind": "List", "kind": "List",
"apiVersion": "odo.openshift.io/v1alpha1", "apiVersion": "odo.openshift.io/v1alpha1",
@@ -315,4 +393,4 @@ This document outlines all the machine readable output options and examples.
} }
] ]
} }
``` ----

93
scripts/generate-machineooutput-doc.sh Executable file
View File

@@ -0,0 +1,93 @@
#!/bin/bash
set -e
asciioutput() {
OUTPUT=`${@}`
ALLOUTPUT="== ${@}
[source,json]
----
${OUTPUT}
----
"
echo ${ALLOUTPUT} > test.adoc
}
tmpdir=`mktemp -d`
cd $tmpdir
git clone https://github.com/openshift/nodejs-ex
cd nodejs-ex
# Commands that don't have json support
# app delete
# catalog describe
# catalog search
# component create
# component delete
# component link
# component log
# component push
# component unlink
# component update
# component watch
# config set
# config unset
# config view
# debug port-forward
# preference set
# preference unset
# preference view
# service create
# service delete
# storage delete
# url create
# url delete
# login
# logout
# utils *
# version
# Alphabetical order for json output...
# Preliminary?
odo project delete foobar -f || true
sleep 5
odo project create foobar
sleep 5
odo create nodejs
odo push
# app
asciioutput odo app describe app -o json
odo app list -o json
# catalog
odo catalog list components -o json
odo catalog list services -o json
# component
odo component delete -o json
odo component push
# project
odo project create foobar -o json
odo project delete foobar -o json
odo project list -o json
# service
## preliminary
odo service create mongodb-persistent mongodb --plan default --wait -p DATABASE_SERVICE_NAME=mongodb -p MEMORY_LIMIT=512Mi -p MONGODB_DATABASE=sampledb -p VOLUME_CAPACITY=1Gi
odo service list -o json
# storage
odo storage create mystorage --path=/opt/app-root/src/storage/ --size=1Gi -o json
odo storage list -o json
odo storage delete
# url
odo url create myurl
odo url list -o json
odo url delete myurl