From cbef7941105b62aaa66623ab092e35878346348f Mon Sep 17 00:00:00 2001 From: Yana Hontyk Date: Thu, 30 Jan 2020 14:08:48 +0100 Subject: [PATCH] Small formatting fixes and fixes from the minimalism sessions. --- _topic_map.yml | 2 + ...a-multicomponent-application-with-odo.adoc | 6 +- ...single-component-application-with-odo.adoc | 11 ++-- ...eating-an-application-with-a-database.adoc | 2 +- .../installing-odo.adoc | 4 +- ...managing-environment-variables-in-odo.adoc | 2 +- .../odo-architecture.adoc | 2 +- .../odo-release-notes.adoc | 14 ++--- .../understanding-odo.adoc | 14 ++--- .../using-sample-applications.adoc | 34 +++++++++++ ...stom-builder-to-specify-a-build-image.adoc | 11 ++-- ...storage-to-the-application-components.adoc | 9 ++- ...vices-using-openshift-service-catalog.adoc | 4 +- ...ploying-a-nodejs-application-with-odo.adoc | 2 +- ...ift-developer-cli-sample-applications.adoc | 56 +++++-------------- ...eveloper-cli-using-command-completion.adoc | 5 +- 16 files changed, 95 insertions(+), 83 deletions(-) create mode 100644 cli_reference/openshift_developer_cli/using-sample-applications.adoc diff --git a/_topic_map.yml b/_topic_map.yml index c467ab59d8..487c96a538 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1168,6 +1168,8 @@ Topics: File: creating-a-multicomponent-application-with-odo - Name: Creating an application with a database File: creating-an-application-with-a-database + - Name: Using sample applications + File: using-sample-applications - Name: Managing environment variables in odo File: managing-environment-variables-in-odo - Name: Configuring the odo CLI diff --git a/cli_reference/openshift_developer_cli/creating-a-multicomponent-application-with-odo.adoc b/cli_reference/openshift_developer_cli/creating-a-multicomponent-application-with-odo.adoc index 5901d61485..746af66c57 100644 --- a/cli_reference/openshift_developer_cli/creating-a-multicomponent-application-with-odo.adoc +++ b/cli_reference/openshift_developer_cli/creating-a-multicomponent-application-with-odo.adoc @@ -1,17 +1,17 @@ [id='creating-a-multicomponent-application-with-odo'] -= Creating a multicomponent application with {odo-title} += Creating a multicomponent application with `{odo-title}` include::modules/openshift-developer-cli-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-a-multicomponent-application-with-odo toc::[] -{odo-title} allows you to create a multicomponent application, modify it, and link its components in an easy and automated way. +`{odo-title}` allows you to create a multicomponent application, modify it, and link its components in an easy and automated way. This example describes how to deploy a multicomponent application - a shooter game. The application consists of a front-end Node.js component and a back-end Java component. .Prerequisites -* {odo-title} is installed. +* `{odo-title}` is installed. * You have a running {product-title} cluster. Developers can use link:https://cloud.redhat.com/openshift/install/crc/installer-provisioned?intcmp=7013a000002CtetAAC[CodeReady Containers (CRC)] to deploy a local {product-title} cluster quickly. * Maven is installed. diff --git a/cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc b/cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc index 9af185505f..6706019a0f 100644 --- a/cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc +++ b/cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc @@ -1,16 +1,16 @@ [id='creating-a-single-component-application-with-odo'] -= Creating a single-component application with {odo-title} += Creating a single-component application with `{odo-title}` include::modules/openshift-developer-cli-attributes.adoc[] include::modules/common-attributes.adoc[] :context: creating-a-single-component-application-with-odo toc::[] -{odo-title} allows you to easily create and deploy applications on {product-title} clusters. +With `{odo-title}`, you can create and deploy applications on {product-title} clusters. .Prerequisites -* {odo-title} is installed. -* You have a running {product-title} cluster. Developers can use link:https://cloud.redhat.com/openshift/install/crc/installer-provisioned?intcmp=7013a000002CtetAAC[CodeReady Containers (CRC)] to deploy a local {product-title} cluster quickly. +* `{odo-title}` is installed. +* You have a running {product-title} cluster. You can use link:https://cloud.redhat.com/openshift/install/crc/installer-provisioned?intcmp=7013a000002CtetAAC[CodeReady Containers (CRC)] to deploy a local {product-title} cluster quickly. include::modules/openshift-developer-cli-creating-a-project-in-odo.adoc[leveloffset=+1] @@ -25,6 +25,3 @@ include::modules/openshift-developer-cli-adding-a-custom-builder-to-specify-a-bu include::modules/openshift-developer-cli-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc[leveloffset=+1] include::modules/openshift-developer-cli-deleting-an-application.adoc[leveloffset=+1] - -include::modules/openshift-developer-cli-sample-applications.adoc[leveloffset=+1] - diff --git a/cli_reference/openshift_developer_cli/creating-an-application-with-a-database.adoc b/cli_reference/openshift_developer_cli/creating-an-application-with-a-database.adoc index e2c3b989ba..22f9a9c538 100644 --- a/cli_reference/openshift_developer_cli/creating-an-application-with-a-database.adoc +++ b/cli_reference/openshift_developer_cli/creating-an-application-with-a-database.adoc @@ -9,7 +9,7 @@ This example describes how to deploy and connect a database to a front-end appli .Prerequisites -* {odo-title} is installed. +* `{odo-title}` is installed. * `oc` client is installed. * You have a running {product-title} cluster. Developers can use link:https://cloud.redhat.com/openshift/install/crc/installer-provisioned?intcmp=7013a000002CtetAAC[CodeReady Containers (CRC)] to deploy a local {product-title} cluster quickly. * Service Catalog is enabled. diff --git a/cli_reference/openshift_developer_cli/installing-odo.adoc b/cli_reference/openshift_developer_cli/installing-odo.adoc index 37a38116f6..92640147b3 100644 --- a/cli_reference/openshift_developer_cli/installing-odo.adoc +++ b/cli_reference/openshift_developer_cli/installing-odo.adoc @@ -5,11 +5,11 @@ include::modules/common-attributes.adoc[] :context: installing-odo toc::[] -The following section describes how to install {odo-title} on different platforms. +The following section describes how to install `{odo-title}` on different platforms. [NOTE] ==== -Currently, {odo-title} does not support installation in a restricted network environment. +Currently, `{odo-title}` does not support installation in a restricted network environment. ==== diff --git a/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.adoc b/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.adoc index a741000f84..0797326093 100644 --- a/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.adoc +++ b/cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.adoc @@ -5,6 +5,6 @@ include::modules/common-attributes.adoc[] :context: managing-environment-variables toc::[] -{odo-title} stores component-specific configurations and environment variables in the `config` file. You can use the `odo config` command to set, unset, and list environment variables for components without the need to modify the `config` file. +`{odo-title}` stores component-specific configurations and environment variables in the `config` file. You can use the `odo config` command to set, unset, and list environment variables for components without the need to modify the `config` file. include::modules/openshift-developer-cli-setting-and-unsetting-environment-variables.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cli_reference/openshift_developer_cli/odo-architecture.adoc b/cli_reference/openshift_developer_cli/odo-architecture.adoc index a69df663d4..c048d9ef8e 100644 --- a/cli_reference/openshift_developer_cli/odo-architecture.adoc +++ b/cli_reference/openshift_developer_cli/odo-architecture.adoc @@ -5,7 +5,7 @@ include::modules/common-attributes.adoc[] :context: odo-architecture toc::[] -This section describes {odo-title} architecture and how {odo-title} manages {product-title} resources on a cluster. +This section describes `{odo-title}` architecture and how `{odo-title}` manages {product-title} resources on a cluster. include::modules/openshift-developer-cli-developer-setup.adoc[leveloffset=+1] include::modules/openshift-developer-cli-openshift-source-to-image.adoc[leveloffset=+1] diff --git a/cli_reference/openshift_developer_cli/odo-release-notes.adoc b/cli_reference/openshift_developer_cli/odo-release-notes.adoc index 908aa69770..1f33627ff9 100644 --- a/cli_reference/openshift_developer_cli/odo-release-notes.adoc +++ b/cli_reference/openshift_developer_cli/odo-release-notes.adoc @@ -1,27 +1,27 @@ [id='odo-release-notes'] -= {odo-title}{nbsp}{odo-ver} release notes += `{odo-title}`{nbsp}{odo-ver} release notes include::modules/openshift-developer-cli-attributes.adoc[] include::modules/common-attributes.adoc[] :context: odo-release-notes toc::[] [id="odo-notable-improvements_{context}"] -== Notable improvements in {odo-title}{nbsp}{odo-ver} +== Notable improvements in `{odo-title}`{nbsp}{odo-ver} * IBM Z and PowerPC architecture binaries are now available. * `odo catalog` has been improved to provide more useful output information. * Information prompts have been added to the `odo service create` command, providing possible next step scenarios. * Log verbosity can now be set with an environment variable `ODO_LOG_LEVEL`. * Use `odo preference set PushTimeout ` to specify the number of seconds `odo` waits for a component Pod to be deployed before the command fails. -* Overall documentation improvements. The documentation now includes a description of {odo-title}'s inner architecture. +* Overall documentation improvements. The documentation now includes a description of `{odo-title}`'s inner architecture. //// = Notable features in odo for the OCP 4.2 release -{odo-title}{nbsp}{odo-ver} offers a simple way to develop applications on {product-title}. {odo-title} is completely client-based and requires no server within {product-title} cluster. +`{odo-title}`{nbsp}{odo-ver} offers a simple way to develop applications on {product-title}. `{odo-title}` is completely client-based and requires no server within {product-title} cluster. -{odo-title}{nbsp}{odo-ver} comes with: +`{odo-title}`{nbsp}{odo-ver} comes with: * Simple syntax and design centered around concepts familiar to developers such as projects, applications and components. * Compatibility with any language or runtime within the OpenShift catalog of component types. @@ -42,7 +42,7 @@ If you find an error or have suggestions for improving the documentation, file a .For Product -If you find an error, encountered a bug, or have suggestions for improving the functionality of {odo-title}, file an issue in link:http://bugzilla.redhat.com[Bugzilla]. Choose the *Red Hat odo for {product-title}* product type. +If you find an error, encountered a bug, or have suggestions for improving the functionality of `{odo-title}`, file an issue in link:http://bugzilla.redhat.com[Bugzilla]. Choose the *Red Hat odo for {product-title}* product type. Provide as many details in the issue description as possible. @@ -83,7 +83,7 @@ Provide as many details in the issue description as possible. * link:https://bugzilla.redhat.com/show_bug.cgi?id=1761440[Bug 1761440] It is not possible to create two Services of the same type in one project. [id="odo-technology-preview_{context}"] -== Technology Preview features in {odo-title}{nbsp}{odo-ver} +== Technology Preview features in `{odo-title}`{nbsp}{odo-ver} `odo debug` is a feature that allows users to attach a local debugger to a component running in the Pod on {product-title}. diff --git a/cli_reference/openshift_developer_cli/understanding-odo.adoc b/cli_reference/openshift_developer_cli/understanding-odo.adoc index eb7542103f..9abe58eb05 100644 --- a/cli_reference/openshift_developer_cli/understanding-odo.adoc +++ b/cli_reference/openshift_developer_cli/understanding-odo.adoc @@ -5,15 +5,15 @@ include::modules/common-attributes.adoc[] :context: understanding-odo toc::[] -{odo-title-full} ({odo-title}) is a fast and easy-to-use CLI tool for creating applications on {product-title}. {odo-title} allows developers to concentrate on creating applications without the need to administrate an {product-title} cluster itself. -Creating deployment configurations, build configurations, service routes and other {product-title} elements are all automated by {odo-title}. +{odo-title-full} (`{odo-title}`) is a fast and easy-to-use CLI tool for creating applications on {product-title}. `{odo-title}` allows developers to concentrate on creating applications without the need to administrate an {product-title} cluster itself. +Creating deployment configurations, build configurations, service routes and other {product-title} elements are all automated by `{odo-title}`. -Existing tools such as `oc` are more operations-focused and require a deep understanding of Kubernetes and {product-title} concepts. {odo-title} abstracts away complex Kubernetes and {product-title} concepts allowing developers to focus on what is most important to them: code. +Existing tools such as `oc` are more operations-focused and require a deep understanding of Kubernetes and {product-title} concepts. `{odo-title}` abstracts away complex Kubernetes and {product-title} concepts allowing developers to focus on what is most important to them: code. [id="odo-key-features"] == Key features -{odo-title} is designed to be simple and concise with the following key features: +`{odo-title}` is designed to be simple and concise with the following key features: * Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components. * Completely client based. No server is required within the {product-title} cluster for deployment. @@ -35,7 +35,7 @@ Examples of components: Node.js, Pearl, PHP, Python, Ruby. Service:: A service is software that your component links to or depends on. Examples of services: MariaDB, Jenkins, MySQL. -In {odo-title}, services are provisioned from the OpenShift Service Catalog and must be enabled within your cluster. +In `{odo-title}`, services are provisioned from the OpenShift Service Catalog and must be enabled within your cluster. [id="odo-supported-languages-and-images"] === Officially supported languages and corresponding container images @@ -62,13 +62,13 @@ The list of available container images is sourced from the cluster's internal co To list the available components and associated container images for your cluster: -. Log in to the {product-title} cluster with {odo-title}: +. Log in to the {product-title} cluster with `{odo-title}`: + ---- $ odo login -u developer -p developer ---- -. List the available {odo-title} supported and unsupported components and corresponding container images: +. List the available `{odo-title}` supported and unsupported components and corresponding container images: + ---------------------------------------------------- $ odo catalog list components diff --git a/cli_reference/openshift_developer_cli/using-sample-applications.adoc b/cli_reference/openshift_developer_cli/using-sample-applications.adoc new file mode 100644 index 0000000000..23f1bc6b0e --- /dev/null +++ b/cli_reference/openshift_developer_cli/using-sample-applications.adoc @@ -0,0 +1,34 @@ +[id="using-sample-applications"] += Using sample applications +include::modules/openshift-developer-cli-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: using-sample-applications +toc::[] + +`{odo-title}` offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example: + +---- +NAME PROJECT TAGS +dotnet openshift 2.0,latest +httpd openshift 2.4,latest +java openshift 8,latest +nginx openshift 1.10,1.12,1.8,latest +nodejs openshift 0.10,4,6,8,latest +perl openshift 5.16,5.20,5.24,latest +php openshift 5.5,5.6,7.0,7.1,latest +python openshift 2.7,3.3,3.4,3.5,3.6,latest +ruby openshift 2.0,2.2,2.3,2.4,latest +wildfly openshift 10.0,10.1,8.1,9.0,latest +---- + +[NOTE] +==== +For `{odo-title}`{nbsp}{odo-ver} Java and Node.js are the officialy supported component types. +Run `odo catalog list components` to verify the officially supported component types. +==== + +In order to access the component over the web, create a URL using `odo url create`. + + + +include::modules/openshift-developer-cli-sample-applications.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/openshift-developer-cli-adding-a-custom-builder-to-specify-a-build-image.adoc b/modules/openshift-developer-cli-adding-a-custom-builder-to-specify-a-build-image.adoc index e2c0a5896a..476ba9bbb2 100644 --- a/modules/openshift-developer-cli-adding-a-custom-builder-to-specify-a-build-image.adoc +++ b/modules/openshift-developer-cli-adding-a-custom-builder-to-specify-a-build-image.adoc @@ -5,7 +5,7 @@ [id="adding-a-custom-builder-to-specify-a-build-image_{context}"] = Adding a custom builder to specify a build image -{product-title} enables you to add a custom image to bridge the gap between the creation of custom images. +With {product-title}, you can add a custom image to bridge the gap between the creation of custom images. The following example demonstrates the successful import and use of the `redhat-openjdk-18` image: @@ -17,17 +17,20 @@ The following example demonstrates the successful import and use of the `redhat- . Import the image into {product-title}: + ---- -$ oc import-image openjdk18 --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift --confirm +$ oc import-image openjdk18 \ +--from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift \ +--confirm ---- . Tag the image to make it accessible to {odo-title}: + ---- $ oc annotate istag/openjdk18:latest tags=builder ---- -. Deploy it with {odo-title}: +. Deploy the image with {odo-title}: + ---- -$ odo create openjdk18 --git https://github.com/openshift-evangelists/Wild-West-Backend +$ odo create openjdk18 --git \ +https://github.com/openshift-evangelists/Wild-West-Backend ---- diff --git a/modules/openshift-developer-cli-adding-storage-to-the-application-components.adoc b/modules/openshift-developer-cli-adding-storage-to-the-application-components.adoc index c077e7ae78..04a60ae808 100644 --- a/modules/openshift-developer-cli-adding-storage-to-the-application-components.adoc +++ b/modules/openshift-developer-cli-adding-storage-to-the-application-components.adoc @@ -5,11 +5,14 @@ [id="adding-storage-to-the-application-components_{context}"] = Adding storage to the application components -Persistent storage keeps data available between restarts of {odo-title}. -The `odo storage` command allows you to add storage to your components: +Persistent storage keeps data available between restarts of {odo-title}. You can add storage to your components with the `odo storage` command. +.Procedure + +* Add storage to your components: ++ ---- $ odo storage create nodestorage --path=/opt/app-root/src/storage/ --size=1Gi ---- -This adds storage to your component with an allocated size of 1 GB. +Your component now has 1 GB storage. diff --git a/modules/openshift-developer-cli-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc b/modules/openshift-developer-cli-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc index 569a6482c3..10d576b6f0 100644 --- a/modules/openshift-developer-cli-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc +++ b/modules/openshift-developer-cli-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc @@ -6,7 +6,7 @@ = Connecting your application to multiple services using OpenShift Service Catalog -The OpenShift service catalog is an implementation of the Open Service Broker API (OSB API) for Kubernetes. This allows you to connect applications deployed in {product-title} to a variety of services. +The OpenShift service catalog is an implementation of the Open Service Broker API (OSB API) for Kubernetes. You can use it to connect applications deployed in {product-title} to a variety of services. .Prerequisites @@ -15,7 +15,7 @@ The OpenShift service catalog is an implementation of the Open Service Broker AP .Procedure -* To list the services, use: +* To list the services: + ---- $ odo catalog list services diff --git a/modules/openshift-developer-cli-creating-and-deploying-a-nodejs-application-with-odo.adoc b/modules/openshift-developer-cli-creating-and-deploying-a-nodejs-application-with-odo.adoc index 0da1a1325f..b700e153c2 100644 --- a/modules/openshift-developer-cli-creating-and-deploying-a-nodejs-application-with-odo.adoc +++ b/modules/openshift-developer-cli-creating-and-deploying-a-nodejs-application-with-odo.adoc @@ -19,7 +19,7 @@ $ cd $ odo create nodejs ---- + -NOTE: By default, the latest image is used. You can also explicitly supply an image version by using `odo create openshift/nodejs:8`. +NOTE: By default, the latest image is used. You can also explicitly specify an image version by using `odo create openshift/nodejs:8`. . Push the initial source code to the component: + diff --git a/modules/openshift-developer-cli-sample-applications.adoc b/modules/openshift-developer-cli-sample-applications.adoc index ff52dda579..bba77ffae2 100644 --- a/modules/openshift-developer-cli-sample-applications.adoc +++ b/modules/openshift-developer-cli-sample-applications.adoc @@ -1,40 +1,12 @@ // Module included in the following assemblies: // -// * cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc +// * cli_reference/openshift_developer_cli/using-sample-applications.adoc -[id='odo-sample-applications'] -= Sample applications -include::openshift-developer-cli-attributes.adoc[] +[id="odo-sample-applications_{context}"] -:context: odo-sample-applications += Examples from Git repositories -{odo-title} offers partial compatibility with any language or runtime listed within the OpenShift catalog of component types. For example: - ----- -NAME PROJECT TAGS -dotnet openshift 2.0,latest -httpd openshift 2.4,latest -java openshift 8,latest -nginx openshift 1.10,1.12,1.8,latest -nodejs openshift 0.10,4,6,8,latest -perl openshift 5.16,5.20,5.24,latest -php openshift 5.5,5.6,7.0,7.1,latest -python openshift 2.7,3.3,3.4,3.5,3.6,latest -ruby openshift 2.0,2.2,2.3,2.4,latest -wildfly openshift 10.0,10.1,8.1,9.0,latest ----- - -[NOTE] -==== -For {odo-title}{nbsp}{odo-ver} Java and Node.js are the officialy supported component types. -Run `odo catalog list components` to verify the officially supported component types. -==== - -In order to access the component over the web, create a URL using `odo url create`. - -== Examples from Git repositories - -=== httpd +== httpd This example helps build and serve static content using httpd on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/sclorg/httpd-container/blob/master/2.4/root/usr/share/container-scripts/httpd/README.md[Apache HTTP Server container image repository]. @@ -42,7 +14,7 @@ This example helps build and serve static content using httpd on CentOS 7. For m $ odo create httpd --git https://github.com/openshift/httpd-ex.git ---- -=== java +== java This example helps build and run fat JAR Java applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/fabric8io-images/s2i/blob/master/README.md[Java S2I Builder image]. @@ -50,7 +22,7 @@ This example helps build and run fat JAR Java applications on CentOS 7. For more $ odo create java --git https://github.com/spring-projects/spring-petclinic.git ---- -=== nodejs +== nodejs Build and run Node.js applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/sclorg/s2i-nodejs-container/blob/master/8/README.md[Node.js 8 container image]. @@ -58,7 +30,7 @@ Build and run Node.js applications on CentOS 7. For more information about using $ odo create nodejs --git https://github.com/openshift/nodejs-ex.git ---- -=== perl +== perl This example helps build and run Perl applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/sclorg/s2i-perl-container/blob/master/5.26/README.md[Perl 5.26 container image]. @@ -66,7 +38,7 @@ This example helps build and run Perl applications on CentOS 7. For more informa $ odo create perl --git https://github.com/openshift/dancer-ex.git ---- -=== php +== php This example helps build and run PHP applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/sclorg/s2i-php-container/blob/master/7.1/README.md[PHP 7.1 Docker image]. @@ -74,7 +46,7 @@ This example helps build and run PHP applications on CentOS 7. For more informat $ odo create php --git https://github.com/openshift/cakephp-ex.git ---- -=== python +== python This example helps build and run Python applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/sclorg/s2i-python-container/blob/master/3.6/README.md[Python 3.6 container image]. @@ -82,7 +54,7 @@ This example helps build and run Python applications on CentOS 7. For more infor $ odo create python --git https://github.com/openshift/django-ex.git ---- -=== ruby +== ruby This example helps build and run Ruby applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see link:https://github.com/sclorg/s2i-ruby-container/blob/master/2.5/README.md[Ruby 2.5 container image]. @@ -90,7 +62,7 @@ This example helps build and run Ruby applications on CentOS 7. For more informa $ odo create ruby --git https://github.com/openshift/ruby-ex.git ---- -=== wildfly +== wildfly This example helps build and run WildFly applications on CentOS 7. For more information about using this builder image, including {product-title} considerations, see the link:https://github.com/wildfly/wildfly-s2i/blob/master/README.md[Wildfly - CentOS Docker images for OpenShift]. @@ -98,9 +70,9 @@ This example helps build and run WildFly applications on CentOS 7. For more info $ odo create wildfly --git https://github.com/openshift/openshift-jee-sample.git ---- -== Binary examples += Binary examples -=== java +== java Java can be used to deploy a binary artifact as follows: @@ -112,7 +84,7 @@ $ odo create java test3 --binary target/*.jar $ odo push ---- -=== wildfly +== wildfly WildFly can be used to deploy a binary application as follows: diff --git a/modules/openshift-developer-cli-using-command-completion.adoc b/modules/openshift-developer-cli-using-command-completion.adoc index 2c11538ae7..783d78806d 100644 --- a/modules/openshift-developer-cli-using-command-completion.adoc +++ b/modules/openshift-developer-cli-using-command-completion.adoc @@ -15,7 +15,7 @@ Currently command completion is only supported for bash, zsh, and fish shells. .Procedure * To install command completion automatically: -. Run: +. Run: + ---- $ odo --complete @@ -25,7 +25,8 @@ $ odo --complete * To install the completion hook manually, add `complete -o nospace -C odo` to your shell configuration file. After any modification to your shell configuration file, restart your shell. -* To disable completion, run: +* To disable completion: +. Run: + ---- $ odo --uncomplete