Skip to content

Commit eb0a695

Browse files
author
Michael Burke
committed
Nodes docs fixes during ROSA review
1 parent 2c8867b commit eb0a695

13 files changed

+55
-38
lines changed

modules/nodes-pods-configmap-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="nodes-pods-configmap-overview_{context}"]
77
= Understanding config maps
88

9-
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.
9+
Many applications require configuration by 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.
1010

1111
The `ConfigMap` object provides mechanisms to inject containers with configuration data while keeping containers agnostic of {product-title}. A config map can be used to store fine-grained information like individual properties or coarse-grained information like entire configuration files or JSON blobs.
1212

13-
The `ConfigMap` API object holds key-value pairs of configuration data that can be consumed in pods or used to store configuration data for system components such as controllers. For example:
13+
The `ConfigMap` object holds key-value pairs of configuration data that can be consumed in pods or used to store configuration data for system components such as controllers. For example:
1414

1515
.`ConfigMap` Object Definition
1616
[source,yaml]
@@ -20,7 +20,7 @@ apiVersion: v1
2020
metadata:
2121
creationTimestamp: 2016-02-18T19:14:38Z
2222
name: example-config
23-
namespace: default
23+
namespace: my-namespace
2424
data: <1>
2525
example.property.1: hello
2626
example.property.2: world

modules/nodes-pods-configmaps-use-case-consuming-in-env-vars.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="nodes-pods-configmaps-use-case-consuming-in-env-vars_{context}"]
77
= Populating environment variables in containers by using config maps
88

9-
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.
9+
You can use config maps to populate individual environment variables in containers or to populate environment variables in containers from all keys that form valid environment variable names.
1010

1111
As an example, consider the following config map:
1212

modules/nodes-pods-configmaps-use-case-consuming-in-volumes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ spec:
3737
containers:
3838
- name: test-container
3939
image: gcr.io/google_containers/busybox
40-
command: [ "/bin/sh", "cat", "/etc/config/special.how" ]
40+
command: [ "/bin/sh", "-c", "cat", "/etc/config/special.how" ]
4141
volumeMounts:
4242
- name: config-volume
4343
mountPath: /etc/config
@@ -67,7 +67,7 @@ spec:
6767
containers:
6868
- name: test-container
6969
image: gcr.io/google_containers/busybox
70-
command: [ "/bin/sh", "cat", "/etc/config/path/to/special-key" ]
70+
command: [ "/bin/sh", "-c", "cat", "/etc/config/path/to/special-key" ]
7171
volumeMounts:
7272
- name: config-volume
7373
mountPath: /etc/config

modules/nodes-pods-configmaps-use-case-setting-command-line-arguments.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
[id="nodes-pods-configmaps-use-case-setting-command-line-arguments_{context}"]
88
= Setting command-line arguments for container commands with config maps
99

10-
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:
10+
You can use a config map to set the value of the commands or arguments in a container by using the Kubernetes substitution syntax `$(VAR_NAME)`.
11+
12+
As an example, consider the following config map:
1113

1214
[source,yaml]
1315
----
@@ -23,9 +25,9 @@ data:
2325

2426
.Procedure
2527

26-
* To inject values into a command in a container, you must consume the keys you want to use as environment variables, as in the consuming ConfigMaps in environment variables use case. Then you can refer to them in a container's command using the `$(VAR_NAME)` syntax.
28+
* To inject values into a command in a container, you must consume the keys you want to use as environment variables. Then you can refer to them in a container's command using the `$(VAR_NAME)` syntax.
2729
+
28-
.Sample `Pod` specification configured to inject specific environment variables
30+
.Sample pod specification configured to inject specific environment variables
2931
[source,yaml]
3032
----
3133
apiVersion: v1

modules/nodes-pods-configuring-pod-critical.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ To make a pod critical:
2020
+
2121
[source,yaml]
2222
----
23+
apiVersion: v1
24+
kind: Pod
25+
metadata:
26+
name: my-pdb
2327
spec:
2428
template:
2529
metadata:

modules/nodes-pods-pod-disruption-about.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,15 @@ $ oc get poddisruptionbudget --all-namespaces
4747
.Example output
4848
[source,terminal]
4949
----
50-
NAMESPACE NAME MIN-AVAILABLE SELECTOR
51-
another-project another-pdb 4 bar=foo
52-
test-project my-pdb 2 foo=bar
50+
NAMESPACE NAME MIN AVAILABLE MAX UNAVAILABLE ALLOWED DISRUPTIONS AGE
51+
openshift-apiserver openshift-apiserver-pdb N/A 1 1 121m
52+
openshift-cloud-controller-manager aws-cloud-controller-manager 1 N/A 1 125m
53+
openshift-cloud-credential-operator pod-identity-webhook 1 N/A 1 117m
54+
openshift-cluster-csi-drivers aws-ebs-csi-driver-controller-pdb N/A 1 1 121m
55+
openshift-cluster-storage-operator csi-snapshot-controller-pdb N/A 1 1 122m
56+
openshift-cluster-storage-operator csi-snapshot-webhook-pdb N/A 1 1 122m
57+
openshift-console console N/A 1 1 116m
58+
#...
5359
----
5460

5561
The `PodDisruptionBudget` is considered healthy when there are at least

modules/nodes-pods-pod-disruption-configuring.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ spec:
2727
minAvailable: 2 <2>
2828
selector: <3>
2929
matchLabels:
30-
foo: bar
30+
name: my-pod
3131
----
3232
<1> `PodDisruptionBudget` is part of the `policy/v1` API group.
3333
<2> The minimum number of pods that must be available simultaneously. This can
@@ -47,7 +47,7 @@ spec:
4747
maxUnavailable: 25% <2>
4848
selector: <3>
4949
matchLabels:
50-
foo: bar
50+
name: my-pod
5151
----
5252
<1> `PodDisruptionBudget` is part of the `policy/v1` API group.
5353
<2> The maximum number of pods that can be unavailable simultaneously. This can

modules/nodes-pods-secrets-certificates-creating.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ spec:
100100
- name: mypod
101101
image: redis
102102
volumeMounts:
103-
- name: foo
104-
mountPath: "/etc/foo"
103+
- name: my-container
104+
mountPath: "/etc/my-path"
105105
volumes:
106-
- name: foo
106+
- name: my-volume
107107
secret:
108108
secretName: my-cert
109109
items:

modules/nodes-pods-secrets-creating.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ spec:
120120
secretKeyRef: <1>
121121
name: test-secret
122122
key: username
123+
from:
124+
kind: ImageStreamTag
125+
namespace: openshift
126+
name: 'cli:latest'
123127
----
124128
<1> Specifies the environment variable that consumes the secret key.
125129

modules/nodes-pods-viewing-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For example:
3030
+
3131
[source,terminal]
3232
----
33-
$ oc get pods -n openshift-console
33+
$ oc get pods
3434
----
3535
+
3636
.Example output

0 commit comments

Comments
 (0)