mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
Restructuing odo docs.
Co-Authored-By: Kathryn Alexander <37149781+kalexand-rh@users.noreply.github.com>
This commit is contained in:
Yana Hontyk
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
7d3c9d34ff
commit
1231f9160c
@@ -15,7 +15,7 @@ the service. If this YAML has placeholder values or sample values, a service can
|
||||
** Note that the configuration of the cluster determines the services available to you. To access the Operator services, a cluster administrator must install the respective Operator on the cluster first. To learn more, see xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Adding Operators to the cluster].
|
||||
* Install the `{odo-title}` CLI.
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-listing-available-services-from-the-operators-installed-on-the-cluster.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-a-service-from-an-operator.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-services-from-yaml-files.adoc[leveloffset=+1]
|
||||
|
||||
@@ -9,13 +9,13 @@ toc::[]
|
||||
|
||||
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
|
||||
.Prerequisites
|
||||
|
||||
* `{odo-title}` 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.
|
||||
* Maven is installed.
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/developer-cli-odo-deploying-the-back-end-component.adoc[leveloffset=+1]
|
||||
|
||||
@@ -7,12 +7,12 @@ toc::[]
|
||||
|
||||
With `{odo-title}`, you can create and deploy applications on clusters.
|
||||
|
||||
== Prerequisites
|
||||
.Prerequisites
|
||||
|
||||
* `{odo-title}` is installed.
|
||||
* You have a running cluster. You can use link:https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[CodeReady Containers (CRC)] to deploy a local cluster quickly.
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc[leveloffset=+1]
|
||||
|
||||
@@ -7,7 +7,7 @@ toc::[]
|
||||
|
||||
This example describes how to deploy and connect a database to a front-end application.
|
||||
|
||||
== Prerequisites
|
||||
.Prerequisites
|
||||
|
||||
* `{odo-title}` is installed.
|
||||
* `oc` client is installed.
|
||||
@@ -19,8 +19,7 @@ This example describes how to deploy and connect a database to a front-end appli
|
||||
Service Catalog is deprecated on {product-title} 4 and later.
|
||||
====
|
||||
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/developer-cli-odo-deploying-the-front-end-component.adoc[leveloffset=+1]
|
||||
|
||||
@@ -29,5 +28,3 @@ include::modules/developer-cli-odo-deploying-a-database-in-interactive-mode.adoc
|
||||
include::modules/developer-cli-odo-deploying-a-database-manually.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/developer-cli-odo-connecting-the-database.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,10 @@
|
||||
[id='deleting-applications']
|
||||
= Deleting applications
|
||||
include::modules/developer-cli-odo-attributes.adoc[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: deleting-applications
|
||||
toc::[]
|
||||
|
||||
You can delete applications and all components associated with the application in your project.
|
||||
|
||||
include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="using-sample-applications"]
|
||||
= Using sample applications
|
||||
[id="sample-applications"]
|
||||
= Sample applications
|
||||
include::modules/developer-cli-odo-attributes.adoc[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: using-sample-applications
|
||||
@@ -9,12 +9,12 @@ include::modules/developer-cli-odo-about-devfiles-in-odo.adoc[leveloffset=+1]
|
||||
|
||||
== Creating a Java application by using a devfile
|
||||
|
||||
== Prerequisites
|
||||
.Prerequisites
|
||||
|
||||
* You have installed `{odo-title}`.
|
||||
* You must know your ingress domain cluster name. Contact your cluster administrator if you do not know it. For example, `apps-crc.testing` is the cluster domain name for https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[Red Hat CodeReady Containers].
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+2]
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/developer-cli-odo-listing-available-devfile-components.adoc[leveloffset=+2]
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
[id="working-with-projects"]
|
||||
= Working with projects
|
||||
include::modules/developer-cli-odo-attributes.adoc[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: working-with-projects
|
||||
toc::[]
|
||||
|
||||
Project keeps your source code, tests, and libraries organized in a separate single unit.
|
||||
|
||||
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,10 @@
|
||||
[id='working-with-storage']
|
||||
= Working with storage
|
||||
include::modules/developer-cli-odo-attributes.adoc[]
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: working-with-storage
|
||||
toc::[]
|
||||
|
||||
Persistent storage keeps data available between restarts of `{odo-title}`.
|
||||
|
||||
include::modules/developer-cli-odo-adding-storage-to-the-application-components.adoc[leveloffset=+1]
|
||||
@@ -8,16 +8,16 @@ toc::[]
|
||||
[id="odo-notable-improvements_{context}"]
|
||||
== Notable changes and improvements in `{odo-title}`
|
||||
|
||||
* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles].
|
||||
* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles].
|
||||
|
||||
* The default deployment mechanism in `{odo-title}` is the devfile deployment now.
|
||||
|
||||
* Added documentation about converting S2I to devfile. See, xref:../../cli_reference/developer_cli_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
|
||||
* Added documentation about converting S2I to devfile. See, xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
|
||||
|
||||
* Added commands to display JSON output for devfile components.
|
||||
|
||||
* `odo debug` is no longer a Technology Preview feature and is now fully supported.
|
||||
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].
|
||||
To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.html#debugging-an-application_debugging-applications-in-odo[Debugging applications in odo].
|
||||
|
||||
* `{odo-title}` integration with Operators is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc[Creating instances of services managed by Operators].
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ After you push the `init` image to a cluster with a mirrored registry, you must
|
||||
== Prerequisites
|
||||
|
||||
* Install `oc` on the client operating system.
|
||||
* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux[Install `{odo-title}`] on the client operating system.
|
||||
* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux_installing-odo[Install `{odo-title}`] on the client operating system.
|
||||
* Access to an restricted cluster with a configured internal registry or a mirror registry.
|
||||
* xref:../../../cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc#pushing-the-odo-init-image-to-a-mirror-registry_pushing-the-odo-init-image-to-the-restricted-cluster-registry[Push the `odo` init image to your cluster registry].
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Depending on the configuration of your cluster and your operating system you can
|
||||
== Prerequisites
|
||||
|
||||
* Install `oc` on the client operating system.
|
||||
* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux[Install `{odo-title}`] on the client operating system.
|
||||
* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux_installing-odo[Install `{odo-title}`] on the client operating system.
|
||||
* Access to a restricted cluster with a configured internal registry or a mirror registry.
|
||||
|
||||
include::modules/developer-cli-odo-pushing-the-odo-init-image-to-a-mirror-registry.adoc[leveloffset=+1]
|
||||
|
||||
Reference in New Issue
Block a user