openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-07 09:46:53 +01:00
Code Issues Releases Activity

Small formatting fixes and fixes from the minimalism sessions.

Browse Source
This commit is contained in:
Yana Hontyk
2020-01-30 14:08:48 +01:00
parent 06d5d30f37
commit cbef794110
16 changed files with 95 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cli_reference/openshift_developer_cli/creating-a-multicomponent-application-with-odo.adoc
View File

@@ -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.

11
cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc
View File

@@ -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]

2
cli_reference/openshift_developer_cli/creating-an-application-with-a-database.adoc
View File

@@ -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.

4
cli_reference/openshift_developer_cli/installing-odo.adoc
View File

@@ -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.
====

2
cli_reference/openshift_developer_cli/managing-environment-variables-in-odo.adoc
View File

@@ -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]

2
cli_reference/openshift_developer_cli/odo-architecture.adoc
View File

@@ -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]

14
cli_reference/openshift_developer_cli/odo-release-notes.adoc
View File

@@ -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 <seconds>` 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}.

14
cli_reference/openshift_developer_cli/understanding-odo.adoc
View File

@@ -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

34
cli_reference/openshift_developer_cli/using-sample-applications.adoc Normal file
View File

@@ -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]