Merge pull request #37799 from mburke5678/issue-34037

mburke5678 · web-flow · commit 8ca3df295093 · 2021-10-26T14:10:00.000-04:00
GH34037: Move configmap topic to nodes
diff --git a/_topic_map.yml b/_topic_map.yml
@@ -907,9 +907,6 @@ Topics:
 - Name: Syncing LDAP groups
   File: ldap-syncing
   Distros: openshift-enterprise,openshift-origin,openshift-dedicated
-- Name: Creating and using config maps
-  File: configmaps
-  Distros: openshift-enterprise,openshift-origin,openshift-dedicated
 - Name: Managing cloud provider credentials
   Dir: managing_cloud_provider_credentials
   Topics:
@@ -1667,6 +1664,8 @@ Topics:
   - Name: Resource quotas across multiple projects
     File: quotas-setting-across-multiple-projects
     Distros: openshift-enterprise,openshift-origin
+- Name: Using config maps with applications
+  File: config-maps
 - Name: Monitoring project and application metrics using the Developer perspective
   File: odc-monitoring-project-and-application-metrics-using-developer-perspective
 - Name: Monitoring application health
@@ -1764,6 +1763,8 @@ Topics:
     File: nodes-pods-vertical-autoscaler
   - Name: Providing sensitive data to Pods
     File: nodes-pods-secrets
+  - Name: Creating and using config maps
+    File: nodes-pods-configmaps
   - Name: Using Device Manager to make devices available to nodes
     File: nodes-pods-plugins
     Distros: openshift-enterprise,openshift-origin
diff --git a/applications/config-maps.adoc b/applications/config-maps.adoc
@@ -0,0 +1,26 @@
+[id="config-maps"]
+= Using config maps with applications
+include::modules/common-attributes.adoc[]
+:context: config-maps
+
+toc::[]
+
+Config maps allow you to decouple configuration artifacts from image content to keep containerized applications portable.
+
+The following sections define config maps and how to create and use them.
+
+For information on creating config maps, see xref:../nodes/pods/nodes-pods-configmaps.adoc[Creating and using config maps].
+
+include::modules/nodes-pods-configmap-overview.adoc[leveloffset=+1]
+
+[id="nodes-pods-config-maps-consuming-configmap-in-pods"]
+== Use cases: Consuming config maps in pods
+
+The following sections describe some uses cases when consuming `ConfigMap`
+objects in pods.
+
+include::modules/nodes-pods-configmaps-use-case-consuming-in-env-vars.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmaps-use-case-setting-command-line-arguments.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmaps-use-case-consuming-in-volumes.adoc[leveloffset=+2]
diff --git a/authentication/configmaps.adoc b/authentication/configmaps.adoc
diff --git a/modules/nodes-pods-configmap-create-from-console.adoc b/modules/nodes-pods-configmap-create-from-console.adoc
@@ -2,7 +2,7 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmap-create-from-console_{context}"]
+[id="nodes-pods-configmap-create-from-console_{context}"]
 = Creating a config map in the {product-title} web console
 
 You can create a config map in the {product-title} web console.
diff --git a/modules/nodes-pods-configmap-create.adoc b/modules/nodes-pods-configmap-create.adoc
@@ -2,8 +2,8 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmap-create_{context}"]
-= Creating a config map
+[id="nodes-pods-configmap-create_{context}"]
+= Creating a config map by using the CLI
 
 You can use the following command to create a config map from directories, specific files, or literal values.
 
diff --git a/modules/nodes-pods-configmap-creating-from-directories.adoc b/modules/nodes-pods-configmap-creating-from-directories.adoc
@@ -2,7 +2,7 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmap-creating-from-directories_{context}"]
+[id="nodes-pods-configmap-creating-from-directories_{context}"]
 = Creating a config map from a directory
 
 You can create a config map from a directory. This method allows you to use multiple files within a directory to create a config map.
@@ -56,17 +56,17 @@ allow.textmode=true
 how.nice.to.look=fairlyNice
 ----
 
-. Create a `ConfigMap` holding the content of each file in this directory by entering the following command:
+. Create a config map holding the content of each file in this directory by entering the following command:
 +
 [source,terminal]
 ----
 $ oc create configmap game-config \
     --from-file=example-files/
 ----
 +
-When the `--from-file` option points to a directory, each file directly in that directory is used to populate a key in the `ConfigMap`, where the name of the key is the file name, and the value of the key is the content of the file.
+When the `--from-file` option points to a directory, each file directly in that directory is used to populate a key in the config map, where the name of the key is the file name, and the value of the key is the content of the file.
 +
-For example, the previous command creates the following `ConfigMap`:
+For example, the previous command creates the following config map:
 +
 [source,terminal]
 ----
diff --git a/modules/nodes-pods-configmap-creating-from-files.adoc b/modules/nodes-pods-configmap-creating-from-files.adoc
@@ -2,8 +2,8 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmap-creating-from-files_{context}"]
-= Creating a ConfigMap from a file
+[id="nodes-pods-configmap-creating-from-files_{context}"]
+= Creating a config map from a file
 
 You can create a config map from a file.
 
@@ -18,7 +18,7 @@ If you create a config map from a file, you can include files containing non-UTF
 
 You can pass the `--from-file` option multiple times to the CLI. The following example yields equivalent results to the creating from directories example.
 
-. Create a `ConfigMap` specifying a specific file:
+. Create a config map by specifying a specific file:
 +
 [source,terminal]
 ----
@@ -62,9 +62,9 @@ metadata:
   uid: b4952dc3-d670-11e5-8cd0-68f728db1985
 ----
 
-You can specify the key to set in a `ConfigMap` for content imported from a file. This can be set by passing a `key=value` expression to the `--from-file` option. For example:
+You can specify the key to set in a config map for content imported from a file. This can be set by passing a `key=value` expression to the `--from-file` option. For example:
 
-. Create a `ConfigMap` specifying a key-value pair:
+. Create a config map by specifying a key-value pair:
 +
 [source,terminal]
 ----
diff --git a/modules/nodes-pods-configmap-creating-from-literal-values.adoc b/modules/nodes-pods-configmap-creating-from-literal-values.adoc
@@ -2,7 +2,7 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmap-creating-from-literal-values_{context}"]
+[id="nodes-pods-configmap-creating-from-literal-values_{context}"]
 = Creating a config map from literal values
 
 You can supply literal values for a config map.
@@ -11,7 +11,7 @@ You can supply literal values for a config map.
 
 The `--from-literal` option takes a `key=value` syntax that allows literal values to be supplied directly on the command line.
 
-. Create a `ConfigMap` specifying a literal value:
+. Create a config map by specifying a literal value:
 +
 [source,terminal]
 ----
diff --git a/modules/nodes-pods-configmap-overview.adoc b/modules/nodes-pods-configmap-overview.adoc
@@ -2,8 +2,8 @@
 //
 // * authentication/configmaps.adoc
 
-[id="authentication-configmap-overview_{context}"]
-= Understanding ConfigMaps
+[id="nodes-pods-configmap-overview_{context}"]
+= Understanding config maps
 
 Many applications require configuration using some combination of configuration files, command line arguments, and environment variables. In {product-title}, these configuration artifacts are decoupled from image content to keep containerized applications portable.
 
diff --git a/modules/nodes-pods-configmaps-use-case-consuming-in-env-vars.adoc b/modules/nodes-pods-configmaps-use-case-consuming-in-env-vars.adoc
@@ -2,7 +2,7 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmaps-use-case-consuming-in-env-vars_{context}"]
+[id="nodes-pods-configmaps-use-case-consuming-in-env-vars_{context}"]
 = Populating environment variables in containers by using config maps
 
 Config maps can be used to populate individual environment variables in containers or to populate environment variables in containers from all keys that form valid environment variable names.
@@ -21,8 +21,8 @@ data:
   special.how: very <3>
   special.type: charm <3>
 ----
-<1> Name of the `ConfigMap`.
-<2> The project in which the `ConfigMap` resides. Config maps can only be referenced by pods in the same project.
+<1> Name of the config map.
+<2> The project in which the config map resides. Config maps can only be referenced by pods in the same project.
 <3> Environment variables to inject.
 
 .`ConfigMap` with one environment variable
@@ -36,7 +36,7 @@ metadata:
 data:
   log_level: INFO <2>
 ----
-<1> Name of the `ConfigMap`.
+<1> Name of the config map.
 <2> Environment variable to inject.
 
 .Procedure
diff --git a/modules/nodes-pods-configmaps-use-case-consuming-in-volumes.adoc b/modules/nodes-pods-configmaps-use-case-consuming-in-volumes.adoc
@@ -2,12 +2,12 @@
 //
 //* authentication/configmaps.adoc
 
-[id="authentication-configmaps-use-case-consuming-in-volumes_{context}"]
+[id="nodes-pods-configmaps-use-case-consuming-in-volumes_{context}"]
 = Injecting content into a volume by using config maps
 
 You can inject content into a volume by using config maps.
 
-.Example `ConfigMap`
+.Example `ConfigMap` custom resource (CR)
 [source,yaml]
 ----
 apiVersion: v1
@@ -54,7 +54,7 @@ When this pod is run, the output of the cat command will be:
 very
 ----
 
-* You can also control the paths within the volume where `ConfigMap` keys are projected:
+* You can also control the paths within the volume where config map keys are projected:
 +
 [source,yaml]
 ----
@@ -79,7 +79,7 @@ spec:
           path: path/to/special-key <1>
   restartPolicy: Never
 ----
-<1> Path to `ConfigMap` key. 
+<1> Path to config map key. 
 +
 When this pod is run, the output of the cat command will be:
 +
diff --git a/modules/nodes-pods-configmaps-use-case-setting-command-line-arguments.adoc b/modules/nodes-pods-configmaps-use-case-setting-command-line-arguments.adoc
@@ -1,11 +1,12 @@
 // Module included in the following assemblies:
 //
-//* builds/builds-configmaps.adoc
+//* nodes/pods/configmaps.adoc
+//* applications/config-maps.adoc
 
-[id="builds-configmaps-use-case-setting-command-line-arguments_{context}"]
-= Setting command-line arguments for container commands with ConfigMaps
+[id="nodes-pods-configmaps-use-case-setting-command-line-arguments_{context}"]
+= Setting command-line arguments for container commands with config maps
 
-A ConfigMap can also be used to set the value of the commands or arguments in a container. This is accomplished by using the Kubernetes substitution syntax `$(VAR_NAME)`. Consider the following ConfigMaps:
+A config map can also be used to set the value of the commands or arguments in a container. This is accomplished by using the Kubernetes substitution syntax `$(VAR_NAME)`. Consider the following config map:
 
 [source,yaml]
 ----
diff --git a/nodes/pods/nodes-pods-configmaps.adoc b/nodes/pods/nodes-pods-configmaps.adoc
@@ -0,0 +1,32 @@
+[id="configmaps"]
+= Creating and using config maps
+include::modules/common-attributes.adoc[]
+:context: configmaps
+
+toc::[]
+
+The following sections define config maps and how to create and use them.
+
+include::modules/nodes-pods-configmap-overview.adoc[leveloffset=+1]
+
+include::modules/nodes-pods-configmap-create-from-console.adoc[leveloffset=+1]
+
+include::modules/nodes-pods-configmap-create.adoc[leveloffset=+1]
+
+include::modules/nodes-pods-configmap-creating-from-directories.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmap-creating-from-files.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmap-creating-from-literal-values.adoc[leveloffset=+2]
+
+[id="nodes-pods-configmaps-consuming-configmap-in-pods"]
+== Use cases: Consuming config maps in pods
+
+The following sections describe some uses cases when consuming `ConfigMap`
+objects in pods.
+
+include::modules/nodes-pods-configmaps-use-case-consuming-in-env-vars.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmaps-use-case-setting-command-line-arguments.adoc[leveloffset=+2]
+
+include::modules/nodes-pods-configmaps-use-case-consuming-in-volumes.adoc[leveloffset=+2]
diff --git a/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc b/virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc
@@ -27,4 +27,4 @@ include::modules/virt-removing-secret-configmap-service-account-vm.adoc[leveloff
 
 * xref:../../authentication/understanding-and-creating-service-accounts.adoc#service-accounts-overview[Understanding and creating service accounts]
 
-* xref:../../authentication/configmaps.adoc#authentication-configmap-overview_builds-configmaps[Understanding config maps]
+* xref:../../nodes/pods/nodes-pods-configmaps.adoc#nodes-pods-configmap-overview_builds-configmaps[Understanding config maps]
