1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Separating command and output for odo CLI docs

This commit is contained in:
Andrea Hoffer
2020-08-05 13:52:43 -04:00
committed by openshift-cherrypick-robot
parent 2d67cc2a8e
commit 137dbaf94e
36 changed files with 552 additions and 146 deletions

View File

@@ -13,6 +13,7 @@ This example describes how to deploy and connect a database to a front-end appli
* `oc` client is installed.
* You have a running cluster. Developers can use link:https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[CodeReady Containers (CRC)] to deploy a local cluster quickly.
* The Service Catalog is installed and enabled on your cluster.
+
[NOTE]
====
Service Catalog is deprecated on {product-title} 4 and later.

View File

@@ -8,10 +8,11 @@ toc::[]
[id="odo-notable-improvements_{context}"]
== Notable changes and improvements in `{odo-title}`
* The `--devfile` flag is added to `odo create`. Run `odo create <component name> --devfile <devfile path>` to specify your devfile location. This flag is only available in the Experimental Mode. See xref:odo-technology-preview_odo-release-notes[Technology Preview features] to learn how to enable it.
* The `--devfile` flag is added to `odo create`. Run `odo create <component name> --devfile <devfile path>` to specify your devfile location. This flag is only available in the Experimental Mode. See xref:odo-technology-preview_odo-release-notes[Technology Preview features] to learn how to enable it.
* Dynamic registry support. Now you can configure your own registries with the following commands:
+
[source,terminal]
----
# Add a registry to the registry list
odo registry add <registry name> <registry URL>
@@ -34,20 +35,20 @@ odo create <component type> --registry <registry name>
* The `--starter` flag is added to `odo create`. Run `odo create nodejs --starter <project-name>` to download the source code of a project specified in the devfile. If no project name is specified, `odo` downloads the first one.
* The `--context` flag is added to `odo push`. With `--context`, you can trigger `odo push` from outside the source code directory. Run `odo push --devfile <path to the devfile> --context <directory with your component>` to specify the directory of your component.
* The `--context` flag is added to `odo push`. With `--context`, you can trigger `odo push` from outside the source code directory. Run `odo push --devfile <path to the devfile> --context <directory with your component>` to specify the directory of your component.
* Performance improvement for `odo catalog list components` when using the devfiles.
* The `--now` flag is added for `odo url delete` when using the devfiles.
* `odo url delete --now` now works with the devfiles.
* `odo url delete --now` now works with the devfiles.
* The `--debug` flag now works with the devfiles.
* Added machine-readable output for listing Operator-backed services. Run `odo catalog list services -o json` to display information about Operators and services in JSON format.
* Added machine-readable output for debugging. Run `odo debug info -o json` to display the debugging information in JSON format.
* Added machine-readable output for `odo push`. Run `odo push -o json` to display event notifications in JSON format.
* Added machine-readable output for `odo push`. Run `odo push -o json` to display event notifications in JSON format.
[id="odo-getting-support_{context}"]
@@ -87,6 +88,7 @@ Provide as many details in the issue description as possible.
+
Workaround: specify your .NET project file by running:
+
[source,terminal]
----
$ odo config set --env DOTNET_STARTUP_PROJECT=<path to your project file>
----
@@ -94,7 +96,7 @@ $ odo config set --env DOTNET_STARTUP_PROJECT=<path to your project file>
[id="odo-technology-preview_{context}"]
== Technology Preview features `{odo-title}`
* `odo debug` is a feature that allows users to attach a local debugger to a component running in the Pod.
* `odo debug` is a feature that allows users to attach a local debugger to a component running in the Pod.
To learn more, see xref:../../cli_reference/developer_cli_odo/debugging-applications-in-odo.html#debugging-an-application_debugging-applications-in-odo[Debugging applications in odo].
:FeatureName: odo debug

View File

@@ -92,14 +92,21 @@ To list the available components and associated container images for your cluste
. Log in to the cluster with `{odo-title}`:
+
[source,terminal]
----
$ odo login -u developer -p developer
----
. List the available `{odo-title}` supported and unsupported components and corresponding container images:
+
----------------------------------------------------
[source,terminal]
----
$ odo catalog list components
----
+
.Example output
[source,terminal]
----
Odo Supported OpenShift Components:
NAME PROJECT TAGS
java openshift 8,latest
@@ -109,6 +116,6 @@ Odo Unsupported OpenShift Components:
NAME PROJECT TAGS
dotnet openshift 1.0,1.1,2.1,2.2,latest
fuse7-eap-openshift openshift 1.3
----------------------------------------------------
----
+
The `TAGS` column represents the available image versions, for example, `10` represents the `rhoar-nodejs/nodejs-10` container image.

View File

@@ -7,6 +7,7 @@ toc::[]
`{odo-title}` offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example:
[source,terminal]
----
NAME PROJECT TAGS
dotnet openshift 2.0,latest