Skip to content

Commit e27b2ba

Browse files
committed
Updating terminology for nodes
1 parent fb1fb96 commit e27b2ba

File tree

122 files changed

+522
-526
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+522
-526
lines changed

_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,9 +1257,9 @@ Topics:
12571257
- Name: Configuring a cluster for Pods
12581258
File: nodes-pods-configuring
12591259
Distros: openshift-enterprise,openshift-webscale,openshift-origin
1260-
- Name: Automatically scaling pods with the Horizontal Pod Autoscaler
1260+
- Name: Automatically scaling pods with the horizontal pod autoscaler
12611261
File: nodes-pods-autoscaling
1262-
- Name: Automatically adjust pod resource levels with the Vertical Pod Autoscaler
1262+
- Name: Automatically adjust pod resource levels with the vertical pod autoscaler
12631263
File: nodes-pods-vertical-autoscaler
12641264
- Name: Providing sensitive data to Pods
12651265
File: nodes-pods-secrets

modules/cluster-autoscaler-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ maximum node pools that you configure.
5656
your cloud provider.
5757

5858

59-
The Horizontal Pod Autoscaler (HPA) and the ClusterAutoscaler modify cluster
59+
The horizontal pod autoscaler (HPA) and the ClusterAutoscaler modify cluster
6060
resources in different ways. The HPA changes the deployment's or ReplicaSet's
6161
number of replicas based on the current CPU load.
6262
If the load increases, the HPA creates new replicas, regardless of the amount

modules/jaeger-config-collector.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Autoscaling is only supported for Jaeger 1.20 or later.
6868

6969
You can configure the Collector to autoscale; the Collector will scale up or down based on the CPU and/or memory consumption. Configuring the Collector to autoscale can help you ensure your Jaeger environment scales up during times of increased load, and scales down when less resources are needed, saving on costs. You configure autoscaling by setting the `autoscale` parameter to `true` and specifying a value for `.spec.collector.maxReplicas` along with a reasonable value for the resources that you expect the Collector’s pod to consume. If you do not set a value for `.spec.collector.maxReplicas` the Operator will set it to `100`.
7070

71-
By default, when there is no value provided for `.spec.collector.replicas`, the Jaeger Operator creates a Horizontal Pod Autoscaler (HPA) configuration for the Collector. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
71+
By default, when there is no value provided for `.spec.collector.replicas`, the Jaeger Operator creates a horizontal pod autoscaler (HPA) configuration for the Collector. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
7272

7373
The following is an example autoscaling configuration, setting the Collector’s limits as well as the maximum number of replicas:
7474

modules/jaeger-config-ingester.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Autoscaling is only supported for Jaeger 1.20 or later.
9090

9191
You can configure the Ingester to autoscale; the Ingester will scale up or down based on the CPU and/or memory consumption. Configuring the Ingester to autoscale can help you ensure your Jaeger environment scales up during times of increased load, and scales down when less resources are needed, saving on costs. You configure autoscaling by setting the `autoscale` parameter to `true` and specifying a value for `.spec.ingester.maxReplicas` along with a reasonable value for the resources that you expect the Ingester's pod to consume. If you do not set a value for `.spec.ingester.maxReplicas` the Operator will set it to `100`.
9292

93-
By default, when there is no value provided for `.spec.ingester.replicas`, the Jaeger Operator creates a Horizontal Pod Autoscaler (HPA) configuration for the Ingester. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
93+
By default, when there is no value provided for `.spec.ingester.replicas`, the Jaeger Operator creates a horizontal pod autoscaler (HPA) configuration for the Ingester. For more information about HPA, refer to the link:https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/[Kubernetes documentation].
9494

9595
The following is an example autoscaling configuration, setting the Ingester’s limits as well as the maximum number of replicas:
9696

modules/nodes-cluster-enabling-features-cluster.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Enabling Technology Preview features using feature gates
88

99
You can turn on Technology Preview features on for all nodes in the cluster by
10-
editing the Feature Gate Custom Resource, named `cluster`, in the `openshift-config` project.
10+
editing the `FeatureGate` custom resource, named `cluster`, in the `openshift-config` project.
1111

1212
The following Technology Preview features are enabled by feature gates:
1313

@@ -17,7 +17,7 @@ The following Technology Preview features are enabled by feature gates:
1717

1818
[IMPORTANT]
1919
====
20-
Turning on Technology Preview features using the Feature Gate Custom Resource cannot be undone and prevents upgrades.
20+
Turning on Technology Preview features using the `FeatureGate` custom resource cannot be undone and prevents upgrades.
2121
====
2222

2323
.Procedure

modules/nodes-cluster-features-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="nodes-cluster-features-about_{context}"]
66
= Understanding feature gates and Technology Preview features
77

8-
You can use the Feature Gate Custom Resource to enable Technology Preview
8+
You can use the `FeatureGate` custom resource to enable Technology Preview
99
features throughout your cluster. This allows you, for example, to enable
1010
Technology Preview features on test clusters where you can fully test them while
1111
ensuring they are disabled on production clusters.

modules/nodes-cluster-limit-ranges-about.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
[id="nodes-cluster-limit-ranges-about_{context}"]
66
= About limit ranges
77

8-
A limit range, defined by a LimitRange object, restricts resource
8+
A limit range, defined by a `LimitRange` object, restricts resource
99
consumption in a project. In the project you can set specific resource
1010
limits for a pod, container, image, image stream, or
1111
persistent volume claim (PVC).
1212

1313
All requests to create and modify resources are evaluated against each
14-
LimitRange object in the project. If the resource violates any of the
14+
`LimitRange` object in the project. If the resource violates any of the
1515
enumerated constraints, the resource is rejected.
1616

1717
ifdef::openshift-online[]

modules/nodes-cluster-limit-ranges-creating.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
To apply a limit range to a project:
99

10-
. Create a limit range object with your required specifications:
10+
. Create a `LimitRange` object with your required specifications:
1111
+
1212
[source,yaml]
1313
----
@@ -52,7 +52,7 @@ spec:
5252
max:
5353
storage: "50Gi"
5454
----
55-
<1> Specify a name for the LimitRange object.
55+
<1> Specify a name for the `LimitRange` object.
5656
<2> To set limits for a pod, specify the minimum and maximum CPU and memory requests as needed.
5757
<3> To set limits for a container, specify the minimum and maximum CPU and memory requests as needed.
5858
<4> Optional. For a container, specify the default amount of CPU or memory that a container can use, if not specified in the `Pod` spec.

modules/nodes-cluster-limit-ranges-deleting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= Deleting a Limit Range
77

88

9-
To remove any active limit range to no longer enforce the limits in a project:
9+
To remove any active `LimitRange` object to no longer enforce the limits in a project:
1010

1111
. Run the following command:
1212
+

modules/nodes-cluster-limit-ranges-limits.adoc

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= About component limits
77

88
The following examples show limit range parameters for each component. The
9-
examples are broken out for clarity. You can create a single limit range object
9+
examples are broken out for clarity. You can create a single `LimitRange` object
1010
for any or all components as necessary.
1111

1212
[id="nodes-cluster-limit-container-limits"]
@@ -15,23 +15,23 @@ for any or all components as necessary.
1515
A limit range allows you to specify the minimum and maximum CPU and memory that each container
1616
in a pod can request for a specific project. If a container is created in the project,
1717
the container CPU and memory requests in the `Pod` spec must comply with the values set in the
18-
limit range object. If not, the pod does not get created.
18+
`LimitRange` object. If not, the pod does not get created.
1919

2020
* The container CPU or memory request and limit must be greater than or equal to the
21-
`min` resource constraint for containers that are specified in the limit range object.
21+
`min` resource constraint for containers that are specified in the `LimitRange` object.
2222

2323
* The container CPU or memory request must be less than or equal to the
24-
`max` resource constraint for containers that are specified in the limit range object.
24+
`max` resource constraint for containers that are specified in the `LimitRange` object.
2525
+
26-
If the limit range defines a `max` CPU, you do not need to define a CPU
26+
If the `LimitRange` object defines a `max` CPU, you do not need to define a CPU
2727
`request` value in the `Pod` spec. But you must specify a CPU `limit` value that
2828
satisfies the maximum CPU constraint specified in the limit range.
2929

3030
* The ratio of the container limits to requests must be
3131
less than or equal to the `maxLimitRequestRatio` value for containers that
32-
is specified in the limit range object.
32+
is specified in the `LimitRange` object.
3333
+
34-
If the limit range defines a `maxLimitRequestRatio` constraint, any new
34+
If the `LimitRange` object defines a `maxLimitRequestRatio` constraint, any new
3535
containers must have both a `request` and a `limit` value. {product-title}
3636
calculates the limit-to-request ratio by dividing the `limit` by the
3737
`request`. This value should be a non-negative integer greater than 1.
@@ -44,7 +44,7 @@ If the `Pod` spec does not specify a container resource memory or limit,
4444
the `default` or `defaultRequest` CPU and memory values for containers
4545
specified in the limit range object are assigned to the container.
4646

47-
.Container LimitRange object definition
47+
.Container `LimitRange` object definition
4848

4949
[source,yaml]
5050
----
@@ -71,12 +71,12 @@ spec:
7171
cpu: "10" <10>
7272
----
7373
<1> The name of the LimitRange object.
74-
<2> The maximum amount of CPU that a single container in a Pod can request.
75-
<3> The maximum amount of memory that a single container in a Pod can request.
76-
<4> The minimum amount of CPU that a single container in a Pod can request.
74+
<2> The maximum amount of CPU that a single container in a pod can request.
75+
<3> The maximum amount of memory that a single container in a pod can request.
76+
<4> The minimum amount of CPU that a single container in a pod can request.
7777
Not setting a `min` value or setting `0` is unlimited, allowing the
7878
Pod to consume more than the `max` CPU value.
79-
<5> The minimum amount of memory that a single container in a Pod can request.
79+
<5> The minimum amount of memory that a single container in a pod can request.
8080
Not setting a `min` value or setting `0` is unlimited, allowing the
8181
Pod to consume more than the `max` memory value.
8282
<6> The default amount of CPU that a container can use if not specified in the `Pod` spec.
@@ -91,21 +91,21 @@ Pod to consume more than the `max` memory value.
9191

9292
A limit range allows you to specify the minimum and maximum CPU and memory limits for all containers
9393
across a pod in a given project. To create a container in the project, the container CPU and memory
94-
requests in the `Pod` spec must comply with the values set in the limit range object. If not,
94+
requests in the `Pod` spec must comply with the values set in the `LimitRange` object. If not,
9595
the pod does not get created.
9696

9797
Across all containers in a pod, the following must hold true:
9898

9999
* The container CPU or memory request and limit must be greater than or equal to the
100-
`min` resource constraints for pods that are specified in the limit range object.
100+
`min` resource constraints for pods that are specified in the `LimitRange` object.
101101

102102
* The container CPU or memory request and limit must be less than or equal to the
103-
`max` resource constraints for pods that are specified in the limit range object.
103+
`max` resource constraints for pods that are specified in the `LimitRange` object.
104104

105105
* The ratio of the container limits to requests must be less than or equal to
106-
the `maxLimitRequestRatio` constraint specified in the limit range object.
106+
the `maxLimitRequestRatio` constraint specified in the `LimitRange` object.
107107

108-
.Pod LimitRange object definition
108+
.Pod `LimitRange` object definition
109109

110110
[source,yaml]
111111
----
@@ -126,28 +126,28 @@ spec:
126126
cpu: "10" <6>
127127
----
128128
<1> The name of the limit range object.
129-
<2> The maximum amount of CPU that a Pod can request across all containers.
130-
<3> The maximum amount of memory that a Pod can request across all containers.
131-
<4> The minimum amount of CPU that a Pod can request across all containers.
132-
Not setting a `min` value or setting `0` is unlimited, allowing the Pod to
129+
<2> The maximum amount of CPU that a pod can request across all containers.
130+
<3> The maximum amount of memory that a pod can request across all containers.
131+
<4> The minimum amount of CPU that a pod can request across all containers.
132+
Not setting a `min` value or setting `0` is unlimited, allowing the pod to
133133
consume more than the `max` CPU value.
134-
<5> The minimum amount of memory that a Pod can request across all containers.
135-
Not setting a `min` value or setting `0` is unlimited, allowing the Pod to
134+
<5> The minimum amount of memory that a pod can request across all containers.
135+
Not setting a `min` value or setting `0` is unlimited, allowing the pod to
136136
consume more than the `max` memory value.
137137
<6> The maximum limit-to-request ratio for a container.
138138

139139
[id="nodes-cluster-limit-image-limits"]
140140
== Image limits
141141

142-
A limit range allows you to specify the maximum size of an image
142+
A `LimitRange` object allows you to specify the maximum size of an image
143143
that can be pushed to an internal registry.
144144

145145
When pushing images to an internal registry, the following must hold true:
146146

147147
* The size of the image must be less than or equal to the `max` size for
148-
images that is specified in the limit range object.
148+
images that is specified in the `LimitRange` object.
149149

150-
.Image LimitRange object definition
150+
.Image `LimitRange` object definition
151151

152152
[source,yaml]
153153
----
@@ -161,7 +161,7 @@ spec:
161161
max:
162162
storage: 1Gi <2>
163163
----
164-
<1> The name of the limit range object.
164+
<1> The name of the `LimitRange` object.
165165
<2> The maximum size of an image that can be pushed to an internal registry.
166166

167167
ifdef::openshift-enterprise,openshift-origin[]
@@ -188,19 +188,18 @@ addressed.
188188
[id="nodes-cluster-limit-stream-limits"]
189189
== Image stream limits
190190

191-
A limit range allows you to specify limits for image streams.
191+
A `LimitRange` object allows you to specify limits for image streams.
192192

193193
For each image stream, the following must hold true:
194194

195195
* The number of image tags in an `ImageStream` specification must be less
196-
than or equal to the `openshift.io/image-tags` constraint in the limit range
197-
object.
196+
than or equal to the `openshift.io/image-tags` constraint in the `LimitRange` object.
198197

199198
* The number of unique references to images in an `ImageStream` specification
200199
must be less than or equal to the `openshift.io/images` constraint in the limit
201200
range object.
202201

203-
.Imagestream LimitRange object definition
202+
.Imagestream `LimitRange` object definition
204203

205204
[source,yaml]
206205
----
@@ -215,11 +214,11 @@ spec:
215214
openshift.io/image-tags: 20 <2>
216215
openshift.io/images: 30 <3>
217216
----
218-
<1> The name of the limit range object.
217+
<1> The name of the `LimitRange` object.
219218
<2> The maximum number of unique image tags in the `imagestream.spec.tags`
220219
parameter in imagestream spec.
221220
<3> The maximum number of unique image references in the `imagestream.status.tags`
222-
parameter in the imagestream spec.
221+
parameter in the `imagestream` spec.
223222

224223
The `openshift.io/image-tags` resource represents unique image
225224
references. Possible references are an `*ImageStreamTag*`, an
@@ -231,24 +230,24 @@ restrict pushes to an internal container image registry in any way, but is usefu
231230
restriction.
232231

233232
The `openshift.io/images` resource represents unique image names recorded in
234-
imagestream status. It allows for restriction of a number of images that can be
233+
image stream status. It allows for restriction of a number of images that can be
235234
pushed to the internal registry. Internal and external references are not
236235
distinguished.
237236

238237
[id="nodes-cluster-limit-pvc-limits"]
239238
== Persistent volume claim limits
240239

241-
A limit range allows you to restrict the storage requested in a persistent volume claim (PVC).
240+
A `LimitRange` object allows you to restrict the storage requested in a persistent volume claim (PVC).
242241

243242
Across all persistent volume claims in a project, the following must hold true:
244243

245244
* The resource request in a persistent volume claim (PVC) must be greater than or equal
246-
the `min` constraint for PVCs that is specified in the limit range object.
245+
the `min` constraint for PVCs that is specified in the `LimitRange` object.
247246

248247
* The resource request in a persistent volume claim (PVC) must be less than or equal
249-
the `max` constraint for PVCs that is specified in the limit range object.
248+
the `max` constraint for PVCs that is specified in the `LimitRange` object.
250249

251-
.PVC LimitRange object definition
250+
.PVC `LimitRange` object definition
252251

253252
[source,yaml]
254253
----
@@ -264,7 +263,7 @@ spec:
264263
max:
265264
storage: "50Gi" <3>
266265
----
267-
<1> The name of the limit range object.
266+
<1> The name of the `LimitRange` object.
268267
<2> The minimum amount of storage that can be requested in a persistent volume claim.
269268
<3> The maximum amount of storage that can be requested in a persistent volume claim.
270269

0 commit comments

Comments
 (0)