Skip to content

Commit 2a99281

Browse files
committed
OSDOCS-5553: moving content ffrom config to running apps
1 parent 184cbd7 commit 2a99281

File tree

7 files changed

+60
-53
lines changed

7 files changed

+60
-53
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Name: Configuring
9797
Dir: microshift_configuring
9898
Distros: microshift
9999
Topics:
100-
- Name: Configuring
100+
- Name: Using configuration tools
101101
File: microshift-using-config-tools
102102
---
103103
Name: Networking
@@ -138,8 +138,10 @@ Name: Running applications
138138
Dir: microshift_running_apps
139139
Distros: microshift
140140
Topics:
141-
- Name: Running applications
142-
File: microshift-operators
141+
- Name: Application deployment
142+
File: microshift-applications
143+
- Name: Operators
144+
File: microshift-operators
143145
# ---
144146
# Name: Networking
145147
# Dir: networking
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="microshift-using-config-tools"]
3-
= Using configuration tools
3+
= How configuration tools work
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-configuring
66

@@ -9,5 +9,4 @@ toc::[]
99
A YAML file customizes {product-title} instances with your preferences, settings, and parameters.
1010

1111
include::modules/microshift-config-yaml.adoc[leveloffset=+1]
12-
include::modules/microshift-config-auto-apply-manifests.adoc[leveloffset=+1]
13-
include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+1]
12+
include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+1]
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:_content-type: ASSEMBLY
2+
[id="applications-with-microshift"]
3+
= Application deployment with {product-title}
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: applications-microshift
6+
7+
toc::[]
8+
9+
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}.
10+
11+
include::modules/microshift-manifests-overview.adoc[leveloffset=+1]
12+
include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1]
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
:_content-type: ASSEMBLY
22
[id="operators-with-microshift"]
3-
= Using Operators
3+
= How Operators work with {product-title}
44
include::_attributes/attributes-microshift.adoc[]
55
:context: operators-microshift
66

77
toc::[]
88

9-
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).
9+
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.
1010

11-
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.
11+
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.
1212

13-
include::modules/microshift-deploying-operators.adoc[leveloffset=+1]
13+
{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.
14+
15+
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.
16+
17+
include::modules/microshift-manifests-overview.adoc[leveloffset=+1]
18+
include::modules/microshift-applying-manifests-example.adoc[leveloffset=+1]

modules/microshift-config-auto-apply-manifests.adoc renamed to modules/microshift-applying-manifests-example.adoc

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift/using-config-tools.adoc
4-
5-
:_content-type: CONCEPT
6-
[id="microshift-auto-apply-manifests_{context}"]
7-
= Automatically applying manifests with the kustomize tool
8-
9-
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.
10-
11-
[IMPORTANT]
12-
====
13-
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.
14-
====
15-
16-
[cols="2",options="header"]
17-
|===
18-
|Location
19-
|Intent
20-
21-
|`/etc/microshift/manifests`
22-
|Read-write location for configuration management systems or development.
23-
24-
|`/usr/lib/microshift/manifests`
25-
|Read-only location for embedding configuration manifests on OSTree-based systems.
26-
|===
3+
// * microshift/running_applications/microshift-operators.adoc
274

5+
:_content-type: PROCEDURE
286
[id="microshift-manifests-example_{context}"]
29-
== Manifest example
7+
= Using manifests example
308
This example demonstrates automatic deployment of a BusyBox container using `kustomize` manifests in the `/etc/microshift/manifests` directory.
319

3210
.Procedure
@@ -78,8 +56,8 @@ spec:
7856
- "3600"
7957
EOF
8058
----
81-
.Procedure
82-
. Create the `kustomize` manifest files by running the following commands:
59+
60+
. Next, create the `kustomize` manifest files by running the following commands:
8361
+
8462
.. Place the YAML file in the directory:
8563
+
@@ -105,7 +83,7 @@ EOF
10583
$ sudo systemctl restart microshift
10684
----
10785
+
108-
. Apply the manifests and start the BusyBox pod by running the following command:
86+
. Apply the manifests and start the `busybox` pod by running the following command:
10987
+
11088
[source,terminal]
11189
----

modules/microshift-deploying-operators.adoc

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift/using-config-tools.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="microshift-manifests-overview_{context}"]
7+
= How manifests work with kustomize
8+
9+
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.
10+
11+
[IMPORTANT]
12+
====
13+
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.
14+
====
15+
16+
[cols="2",options="header"]
17+
|===
18+
|Location
19+
|Intent
20+
21+
|`/etc/microshift/manifests`
22+
|Read-write location for configuration management systems or development.
23+
24+
|`/usr/lib/microshift/manifests`
25+
|Read-only location for embedding configuration manifests on OSTree-based systems.
26+
|===

0 commit comments

Comments
 (0)