Skip to content

Commit e3237dc

Browse files
committed
OCP docs update 2025/08/04
1 parent a3b014b commit e3237dc

File tree

390 files changed

+6828
-4372
lines changed

Some content is hidden

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

390 files changed

+6828
-4372
lines changed

ocp-product-docs-plaintext/4.15/applications/deployments/managing-deployment-processes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ A DeploymentConfig object can contain triggers, which drive the creation of new
176176
If no triggers are defined on a DeploymentConfig object, a config change trigger is added by default. If triggers are defined as an empty field, deployments must be started manually.
177177
----
178178

179-
## Config change deployment triggers
179+
### Config change deployment triggers
180180

181181
The config change trigger results in a new replication controller whenever configuration changes are detected in the pod template of the DeploymentConfig object.
182182

@@ -200,7 +200,7 @@ spec:
200200
```
201201

202202

203-
## Image change deployment triggers
203+
### Image change deployment triggers
204204

205205
The image change trigger results in a new replication controller whenever the content of an image stream tag changes (when a new version of the image is pushed).
206206

ocp-product-docs-plaintext/4.15/applications/deployments/what-deployments-are.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -247,29 +247,29 @@ However, deployment rollouts are driven from a controller manager. The controlle
247247

248248
## Deployment-specific features
249249

250-
## Rollover
250+
### Rollover
251251

252252
The deployment process for Deployment objects is driven by a controller loop, in contrast to DeploymentConfig objects that use deployer pods for every new rollout. This means that the Deployment object can have as many active replica sets as possible, and eventually the deployment controller will scale down all old replica sets and scale up the newest one.
253253

254254
DeploymentConfig objects can have at most one deployer pod running, otherwise multiple deployers might conflict when trying to scale up what they think should be the newest replication controller. Because of this, only two replication controllers can be active at any point in time. Ultimately, this results in faster rapid rollouts for Deployment objects.
255255

256-
## Proportional scaling
256+
### Proportional scaling
257257

258258
Because the deployment controller is the sole source of truth for the sizes of new and old replica sets owned by a Deployment object, it can scale ongoing rollouts. Additional replicas are distributed proportionally based on the size of each replica set.
259259

260260
DeploymentConfig objects cannot be scaled when a rollout is ongoing because the controller will have issues with the deployer process about the size of the new replication controller.
261261

262-
## Pausing mid-rollout
262+
### Pausing mid-rollout
263263

264264
Deployments can be paused at any point in time, meaning you can also pause ongoing rollouts. However, you currently cannot pause deployer pods; if you try to pause a deployment in the middle of a rollout, the deployer process is not affected and continues until it finishes.
265265

266266
## DeploymentConfig object-specific features
267267

268-
## Automatic rollbacks
268+
### Automatic rollbacks
269269

270270
Currently, deployments do not support automatically rolling back to the last successfully deployed replica set in case of a failure.
271271

272-
## Triggers
272+
### Triggers
273273

274274
Deployments have an implicit config change trigger in that every change in the pod template of a deployment automatically triggers a new rollout.
275275
If you do not want new rollouts on pod template changes, pause the deployment:
@@ -280,10 +280,10 @@ $ oc rollout pause deployments/<name>
280280
```
281281

282282

283-
## Lifecycle hooks
283+
### Lifecycle hooks
284284

285285
Deployments do not yet support any lifecycle hooks.
286286

287-
## Custom strategies
287+
### Custom strategies
288288

289289
Deployments do not support user-specified custom deployment strategies.

ocp-product-docs-plaintext/4.15/applications/pruning-objects.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ If the registry is secured by a certificate authority different from the one use
401401

402402
## Image pruning problems
403403

404-
## Images not being pruned
404+
### Images not being pruned
405405

406406
If your images keep accumulating and the prune command removes just a small
407407
portion of what you expect, ensure that you understand the image prune
@@ -451,7 +451,7 @@ be avoided, unless the image must be preserved for an undefined amount of time.
451451
Such tags tend to have just one image in their history, which prevents
452452
them from ever being pruned.
453453

454-
## Using a secure connection against insecure registry
454+
### Using a secure connection against insecure registry
455455

456456
If you see a message similar to the following in the output of the oc adm prune images
457457
command, then your registry is not secured and the oc adm prune images
@@ -467,7 +467,7 @@ error: error communicating with registry: Get https://172.30.30.30:5000/healthz:
467467
client to use an insecure connection by appending --force-insecure to the
468468
command; however, this is not recommended.
469469

470-
## Using an insecure connection against a secured registry
470+
### Using an insecure connection against a secured registry
471471

472472
If you see one of the following errors in the output of the oc adm prune images
473473
command, it means that your registry is secured using a certificate signed by a
@@ -485,7 +485,7 @@ By default, the certificate authority data stored in the user&#8217;s configurat
485485

486486
Use the --certificate-authority option to provide the right certificate authority for the container image registry server.
487487

488-
## Using the wrong certificate authority
488+
### Using the wrong certificate authority
489489

490490
The following error means that the certificate authority used to sign the certificate of the secured container image registry is different from the authority used by the client:
491491

ocp-product-docs-plaintext/4.15/installing/installing_aws/installing-aws-china.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ However, you must have an active subscription to access this page.
460460
Installing the cluster requires that you manually create the installation configuration file.
461461

462462
* You have uploaded a custom RHCOS AMI.
463-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
463+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
464464
* You have obtained the Red Hat OpenShift Container Platform installation program and the pull secret for your
465465
cluster.
466466

@@ -473,25 +473,19 @@ $ mkdir <installation_directory>
473473

474474
[IMPORTANT]
475475
----
476-
You must create a directory. Some installation assets, like bootstrap X.509
477-
certificates have short expiration intervals, so you must not reuse an
478-
installation directory. If you want to reuse individual files from another
479-
cluster installation, you can copy them into your directory. However, the file
480-
names for the installation assets might change between releases. Use caution
481-
when copying installation files from an earlier Red Hat OpenShift Container Platform version.
476+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier Red Hat OpenShift Container Platform version.
482477
----
483-
2. Customize the sample install-config.yaml file template that is provided and save
484-
it in the <installation_directory>.
478+
2. Customize the provided sample install-config.yaml file template and save the file in the <installation_directory>.
485479

486480
[NOTE]
487481
----
488482
You must name this configuration file install-config.yaml.
489483
----
490-
3. Back up the install-config.yaml file so that you can use it to install multiple clusters.
484+
3. Back up the install-config.yaml file so that you can use it to install many clusters.
491485

492486
[IMPORTANT]
493487
----
494-
The install-config.yaml file is consumed during the next step of the installation process. You must back it up now.
488+
Back up the install-config.yaml file now, because the installation process consumes the file in the next step.
495489
----
496490

497491
* Installation configuration parameters for AWS

ocp-product-docs-plaintext/4.15/installing/installing_aws/installing-aws-government-region.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ However, you must have an active subscription to access this page.
378378

379379
Installing the cluster requires that you manually create the installation configuration file.
380380

381-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
381+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
382382
* You have obtained the Red Hat OpenShift Container Platform installation program and the pull secret for your
383383
cluster.
384384

@@ -391,25 +391,19 @@ $ mkdir <installation_directory>
391391

392392
[IMPORTANT]
393393
----
394-
You must create a directory. Some installation assets, like bootstrap X.509
395-
certificates have short expiration intervals, so you must not reuse an
396-
installation directory. If you want to reuse individual files from another
397-
cluster installation, you can copy them into your directory. However, the file
398-
names for the installation assets might change between releases. Use caution
399-
when copying installation files from an earlier Red Hat OpenShift Container Platform version.
394+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier Red Hat OpenShift Container Platform version.
400395
----
401-
2. Customize the sample install-config.yaml file template that is provided and save
402-
it in the <installation_directory>.
396+
2. Customize the provided sample install-config.yaml file template and save the file in the <installation_directory>.
403397

404398
[NOTE]
405399
----
406400
You must name this configuration file install-config.yaml.
407401
----
408-
3. Back up the install-config.yaml file so that you can use it to install multiple clusters.
402+
3. Back up the install-config.yaml file so that you can use it to install many clusters.
409403

410404
[IMPORTANT]
411405
----
412-
The install-config.yaml file is consumed during the next step of the installation process. You must back it up now.
406+
Back up the install-config.yaml file now, because the installation process consumes the file in the next step.
413407
----
414408

415409
* Installation configuration parameters for AWS

ocp-product-docs-plaintext/4.15/installing/installing_aws/installing-aws-private.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ However, you must have an active subscription to access this page.
312312

313313
Installing the cluster requires that you manually create the installation configuration file.
314314

315-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
315+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
316316
* You have obtained the Red Hat OpenShift Container Platform installation program and the pull secret for your
317317
cluster.
318318

@@ -325,25 +325,19 @@ $ mkdir <installation_directory>
325325

326326
[IMPORTANT]
327327
----
328-
You must create a directory. Some installation assets, like bootstrap X.509
329-
certificates have short expiration intervals, so you must not reuse an
330-
installation directory. If you want to reuse individual files from another
331-
cluster installation, you can copy them into your directory. However, the file
332-
names for the installation assets might change between releases. Use caution
333-
when copying installation files from an earlier Red Hat OpenShift Container Platform version.
328+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier Red Hat OpenShift Container Platform version.
334329
----
335-
2. Customize the sample install-config.yaml file template that is provided and save
336-
it in the <installation_directory>.
330+
2. Customize the provided sample install-config.yaml file template and save the file in the <installation_directory>.
337331

338332
[NOTE]
339333
----
340334
You must name this configuration file install-config.yaml.
341335
----
342-
3. Back up the install-config.yaml file so that you can use it to install multiple clusters.
336+
3. Back up the install-config.yaml file so that you can use it to install many clusters.
343337

344338
[IMPORTANT]
345339
----
346-
The install-config.yaml file is consumed during the next step of the installation process. You must back it up now.
340+
Back up the install-config.yaml file now, because the installation process consumes the file in the next step.
347341
----
348342

349343
* Installation configuration parameters for AWS

ocp-product-docs-plaintext/4.15/installing/installing_aws/installing-aws-secret-region.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ However, you must have an active subscription to access this page.
490490
Installing the cluster requires that you manually create the installation configuration file.
491491

492492
* You have uploaded a custom RHCOS AMI.
493-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
493+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
494494
* You have obtained the Red Hat OpenShift Container Platform installation program and the pull secret for your
495495
cluster.
496496

@@ -503,25 +503,19 @@ $ mkdir <installation_directory>
503503

504504
[IMPORTANT]
505505
----
506-
You must create a directory. Some installation assets, like bootstrap X.509
507-
certificates have short expiration intervals, so you must not reuse an
508-
installation directory. If you want to reuse individual files from another
509-
cluster installation, you can copy them into your directory. However, the file
510-
names for the installation assets might change between releases. Use caution
511-
when copying installation files from an earlier Red Hat OpenShift Container Platform version.
506+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier Red Hat OpenShift Container Platform version.
512507
----
513-
2. Customize the sample install-config.yaml file template that is provided and save
514-
it in the <installation_directory>.
508+
2. Customize the provided sample install-config.yaml file template and save the file in the <installation_directory>.
515509

516510
[NOTE]
517511
----
518512
You must name this configuration file install-config.yaml.
519513
----
520-
3. Back up the install-config.yaml file so that you can use it to install multiple clusters.
514+
3. Back up the install-config.yaml file so that you can use it to install many clusters.
521515

522516
[IMPORTANT]
523517
----
524-
The install-config.yaml file is consumed during the next step of the installation process. You must back it up now.
518+
Back up the install-config.yaml file now, because the installation process consumes the file in the next step.
525519
----
526520

527521
* Installation configuration parameters for AWS

ocp-product-docs-plaintext/4.15/installing/installing_azure/installing-azure-government-region.txt

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ However, you must have an active subscription to access this page.
335335

336336
Installing the cluster requires that you manually create the installation configuration file.
337337

338-
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
338+
* You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
339339
* You have obtained the Red Hat OpenShift Container Platform installation program and the pull secret for your
340340
cluster.
341341

@@ -348,25 +348,19 @@ $ mkdir <installation_directory>
348348

349349
[IMPORTANT]
350350
----
351-
You must create a directory. Some installation assets, like bootstrap X.509
352-
certificates have short expiration intervals, so you must not reuse an
353-
installation directory. If you want to reuse individual files from another
354-
cluster installation, you can copy them into your directory. However, the file
355-
names for the installation assets might change between releases. Use caution
356-
when copying installation files from an earlier Red Hat OpenShift Container Platform version.
351+
You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier Red Hat OpenShift Container Platform version.
357352
----
358-
2. Customize the sample install-config.yaml file template that is provided and save
359-
it in the <installation_directory>.
353+
2. Customize the provided sample install-config.yaml file template and save the file in the <installation_directory>.
360354

361355
[NOTE]
362356
----
363357
You must name this configuration file install-config.yaml.
364358
----
365-
3. Back up the install-config.yaml file so that you can use it to install multiple clusters.
359+
3. Back up the install-config.yaml file so that you can use it to install many clusters.
366360

367361
[IMPORTANT]
368362
----
369-
The install-config.yaml file is consumed during the next step of the installation process. You must back it up now.
363+
Back up the install-config.yaml file now, because the installation process consumes the file in the next step.
370364
----
371365

372366
* Installation configuration parameters for Azure

0 commit comments

Comments
 (0)