From cb5e6c82be69f9b3d2de387273286297f3f79e53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Fri, 17 Mar 2023 15:20:12 -0400 Subject: [PATCH] OSDOCS-5553: moving content ffrom config to running apps --- _topic_maps/_topic_map_ms.yml | 8 +++-- .../microshift-using-config-tools.adoc | 5 ++- .../microshift-applications.adoc | 12 +++++++ .../microshift-operators.adoc | 13 ++++--- ...icroshift-applying-manifests-example.adoc} | 34 ++++--------------- modules/microshift-deploying-operators.adoc | 15 -------- modules/microshift-manifests-overview.adoc | 26 ++++++++++++++ 7 files changed, 60 insertions(+), 53 deletions(-) create mode 100644 microshift_running_apps/microshift-applications.adoc rename modules/{microshift-config-auto-apply-manifests.adoc => microshift-applying-manifests-example.adoc} (56%) delete mode 100644 modules/microshift-deploying-operators.adoc create mode 100644 modules/microshift-manifests-overview.adoc diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index fbcece6d24..b7916f7843 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -97,7 +97,7 @@ Name: Configuring Dir: microshift_configuring Distros: microshift Topics: -- Name: Configuring +- Name: Using configuration tools File: microshift-using-config-tools --- Name: Networking @@ -138,8 +138,10 @@ Name: Running applications Dir: microshift_running_apps Distros: microshift Topics: - - Name: Running applications - File: microshift-operators +- Name: Application deployment + File: microshift-applications +- Name: Operators + File: microshift-operators # --- # Name: Networking # Dir: networking diff --git a/microshift_configuring/microshift-using-config-tools.adoc b/microshift_configuring/microshift-using-config-tools.adoc index bba86f43b8..f3e7647d42 100644 --- a/microshift_configuring/microshift-using-config-tools.adoc +++ b/microshift_configuring/microshift-using-config-tools.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="microshift-using-config-tools"] -= Using configuration tools += How configuration tools work include::_attributes/attributes-microshift.adoc[] :context: microshift-configuring @@ -9,5 +9,4 @@ toc::[] A YAML file customizes {product-title} instances with your preferences, settings, and parameters. include::modules/microshift-config-yaml.adoc[leveloffset=+1] -include::modules/microshift-config-auto-apply-manifests.adoc[leveloffset=+1] -include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+1] +include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+1] \ No newline at end of file diff --git a/microshift_running_apps/microshift-applications.adoc b/microshift_running_apps/microshift-applications.adoc new file mode 100644 index 0000000000..aa25d0c153 --- /dev/null +++ b/microshift_running_apps/microshift-applications.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="applications-with-microshift"] += Application deployment with {product-title} +include::_attributes/attributes-microshift.adoc[] +:context: applications-microshift + +toc::[] + +You can use the `kustomize` configuration management tool to deploy applications. Read through the following procedure for an example of how this tool works in {product-title}. + +include::modules/microshift-manifests-overview.adoc[leveloffset=+1] +include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1] \ No newline at end of file diff --git a/microshift_running_apps/microshift-operators.adoc b/microshift_running_apps/microshift-operators.adoc index 39e447ac79..010c272388 100644 --- a/microshift_running_apps/microshift-operators.adoc +++ b/microshift_running_apps/microshift-operators.adoc @@ -1,13 +1,18 @@ :_content-type: ASSEMBLY [id="operators-with-microshift"] -= Using Operators += How Operators work with {product-title} include::_attributes/attributes-microshift.adoc[] :context: operators-microshift toc::[] -Operators integrate with Kubernetes APIs and CLI tools such as `kubectl` and `oc`. Operators provide the means to manage applications and their resources, such as deploying a database or message bus. To minimize the footprint of {product-title}, Operators are installed directly with manifests instead of through the Operator Lifecycle Manager (OLM). +You can use Operators with {product-title} to create applications that monitor the running services in your cluster. Operators can manage applications and their resources, such as deploying a database or message bus. As customized software running inside your cluster, Operators can be used to implement and automate common operations. -Operators offer a more granular configuration experience. You configure each component by modifying the API that the Operator exposes instead of modifying a global configuration file. {product-title} applications are generally deployed in static environments, but Operators are available for you to use. +Operators offer a more localized configuration experience and integrate with Kubernetes APIs and CLI tools such as `kubectl` and `oc`. Operators are designed specifically for your applications. Operators enable you to configure components instead of modifying a global configuration file. -include::modules/microshift-deploying-operators.adoc[leveloffset=+1] \ No newline at end of file +{product-title} applications are generally expected to be deployed in static environments. However, Operators are available if helpful in your use case. To determine an Operator's compatibility with {product-title}, check the Operator's documentation. + +To minimize the footprint of {product-title}, Operators are installed directly with manifests instead of using the Operator Lifecycle Manager (OLM). The following examples provide instructions on how you can use the `kustomize` configuration management tool with {product-title} to deploy an application. Use the same steps to install Operators with manifests. + +include::modules/microshift-manifests-overview.adoc[leveloffset=+1] +include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/microshift-config-auto-apply-manifests.adoc b/modules/microshift-applying-manifests-example.adoc similarity index 56% rename from modules/microshift-config-auto-apply-manifests.adoc rename to modules/microshift-applying-manifests-example.adoc index 1528f249da..82c846c3a0 100644 --- a/modules/microshift-config-auto-apply-manifests.adoc +++ b/modules/microshift-applying-manifests-example.adoc @@ -1,32 +1,10 @@ // Module included in the following assemblies: // -// * microshift/using-config-tools.adoc - -:_content-type: CONCEPT -[id="microshift-auto-apply-manifests_{context}"] -= Automatically applying manifests with the kustomize tool - -Providing multiple directories allows a flexible method of managing {product-title} workloads. When you run the `kustomize` configuration management tool, {product-title} searches the `/etc/microshift/manifests` and `/usr/lib/microshift/` manifest directories for a `kustomization.yaml` file. If it finds one, {product-title} automatically runs the `kubectl apply -k` command to apply the manifests to the cluster. - -[IMPORTANT] -==== -The `kustomize` tool must be either running as a separate step in the boot process, or it must be part of the {product-title} image. -==== - -[cols="2",options="header"] -|=== -|Location -|Intent - -|`/etc/microshift/manifests` -|Read-write location for configuration management systems or development. - -|`/usr/lib/microshift/manifests` -|Read-only location for embedding configuration manifests on OSTree-based systems. -|=== +// * microshift/running_applications/microshift-operators.adoc +:_content-type: PROCEDURE [id="microshift-manifests-example_{context}"] -== Manifest example += Using manifests example This example demonstrates automatic deployment of a BusyBox container using `kustomize` manifests in the `/etc/microshift/manifests` directory. .Procedure @@ -78,8 +56,8 @@ spec: - "3600" EOF ---- -.Procedure -. Create the `kustomize` manifest files by running the following commands: + +. Next, create the `kustomize` manifest files by running the following commands: + .. Place the YAML file in the directory: + @@ -105,7 +83,7 @@ EOF $ sudo systemctl restart microshift ---- + -. Apply the manifests and start the BusyBox pod by running the following command: +. Apply the manifests and start the `busybox` pod by running the following command: + [source,terminal] ---- diff --git a/modules/microshift-deploying-operators.adoc b/modules/microshift-deploying-operators.adoc deleted file mode 100644 index 3ba4dc2017..0000000000 --- a/modules/microshift-deploying-operators.adoc +++ /dev/null @@ -1,15 +0,0 @@ -// Module included in the following assemblies: -// -// * microshift_operators/microshift-deploying-operators.adoc - -:_content-type: PROCEDURE -[id="microshift-deploying-operators_{context}"] -= Deploying Operators using manifests - -You can use Operators with {product-title} to create applications that monitor the running services in the cluster. Operators are designed specifically for your applications. These customized pieces of software running inside your cluster can be used to implement and automate common operations. - -//add examples - -//.Procedure -//adding operators with manifests - diff --git a/modules/microshift-manifests-overview.adoc b/modules/microshift-manifests-overview.adoc new file mode 100644 index 0000000000..f4da0eff07 --- /dev/null +++ b/modules/microshift-manifests-overview.adoc @@ -0,0 +1,26 @@ +// Module included in the following assemblies: +// +// * microshift/using-config-tools.adoc + +:_content-type: CONCEPT +[id="microshift-manifests-overview_{context}"] += How manifests work with kustomize + +Providing multiple directories allows a flexible method of managing {product-title} workloads. When you run the `kustomize` configuration management tool, {product-title} searches the `/etc/microshift/manifests` and `/usr/lib/microshift/` manifest directories for a `kustomization.yaml` file. If it finds one, {product-title} automatically runs the `kubectl apply -k` command to apply the manifests to the cluster. + +[IMPORTANT] +==== +The `kustomize` tool must be either running as a separate step in the boot process, or it must be part of the {product-title} image. +==== + +[cols="2",options="header"] +|=== +|Location +|Intent + +|`/etc/microshift/manifests` +|Read-write location for configuration management systems or development. + +|`/usr/lib/microshift/manifests` +|Read-only location for embedding configuration manifests on OSTree-based systems. +|=== \ No newline at end of file