Skip to content

Commit a74293b

Browse files
committed
OLS-1874: OCP docs update, week of 2025/06/30
1 parent 63bee00 commit a74293b

File tree

164 files changed

+9596
-6376
lines changed

Some content is hidden

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

164 files changed

+9596
-6376
lines changed

ocp-product-docs-plaintext/4.15/backup_and_restore/application_backup_and_restore/oadp-features-plugins.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,21 +137,21 @@ OpenShift API for Data Protection (OADP) is platform neutral. The information th
137137

138138
* OADP 1.1.7 was tested successfully against Red Hat OpenShift Container Platform 4.11 for both IBM Power(R) and IBM Z(R). The sections that follow give testing and support information for OADP 1.1.7 in terms of backup locations for these systems.
139139
* OADP 1.2.3 was tested successfully against Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15 for both IBM Power(R) and IBM Z(R). The sections that follow give testing and support information for OADP 1.2.3 in terms of backup locations for these systems.
140-
* OADP 1.3.6 was tested successfully against Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15 for both IBM Power(R) and IBM Z(R). The sections that follow give testing and support information for OADP 1.3.6 in terms of backup locations for these systems.
140+
* OADP 1.3.7 was tested successfully against Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15 for both IBM Power(R) and IBM Z(R). The sections that follow give testing and support information for OADP 1.3.7 in terms of backup locations for these systems.
141141
* OADP 1.4.4 was tested successfully against Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17 for both IBM Power(R) and IBM Z(R). The sections that follow give testing and support information for OADP 1.4.4 in terms of backup locations for these systems.
142142

143143
## OADP support for target backup locations using IBM Power
144144

145145
* IBM Power(R) running with Red Hat OpenShift Container Platform 4.11 and 4.12, and OpenShift API for Data Protection (OADP) 1.1.7 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power(R) with Red Hat OpenShift Container Platform 4.11 and 4.12, and OADP 1.1.7 against all S3 backup location targets, which are not AWS, as well.
146146
* IBM Power(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and OADP 1.2.3 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power(R) with Red Hat OpenShift Container Platform 4.12, 4.13. 4.14, and 4.15, and OADP 1.2.3 against all S3 backup location targets, which are not AWS, as well.
147-
* IBM Power(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and OADP 1.3.6 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power(R) with Red Hat OpenShift Container Platform 4.13, 4.14, and 4.15, and OADP 1.3.6 against all S3 backup location targets, which are not AWS, as well.
147+
* IBM Power(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and OADP 1.3.7 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power(R) with Red Hat OpenShift Container Platform 4.13, 4.14, and 4.15, and OADP 1.3.7 against all S3 backup location targets, which are not AWS, as well.
148148
* IBM Power(R) running with Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17, and OADP 1.4.4 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power(R) with Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17, and OADP 1.4.4 against all S3 backup location targets, which are not AWS, as well.
149149

150150
## OADP testing and support for target backup locations using IBM Z
151151

152152
* IBM Z(R) running with Red Hat OpenShift Container Platform 4.11 and 4.12, and OpenShift API for Data Protection (OADP) 1.1.7 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Z(R) with Red Hat OpenShift Container Platform 4.11 and 4.12, and OADP 1.1.7 against all S3 backup location targets, which are not AWS, as well.
153153
* IBM Z(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and OADP 1.2.3 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Z(R) with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14 and 4.15, and OADP 1.2.3 against all S3 backup location targets, which are not AWS, as well.
154-
* IBM Z(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and 1.3.6 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Z(R) with Red Hat OpenShift Container Platform 4.13 4.14, and 4.15, and 1.3.6 against all S3 backup location targets, which are not AWS, as well.
154+
* IBM Z(R) running with Red Hat OpenShift Container Platform 4.12, 4.13, 4.14, and 4.15, and 1.3.7 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Z(R) with Red Hat OpenShift Container Platform 4.13 4.14, and 4.15, and 1.3.7 against all S3 backup location targets, which are not AWS, as well.
155155
* IBM Z(R) running with Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17, and 1.4.4 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Z(R) with Red Hat OpenShift Container Platform 4.14, 4.15, 4.16, and 4.17, and 1.4.4 against all S3 backup location targets, which are not AWS, as well.
156156

157157
### Known issue of OADP using IBM Power(R) and IBM Z(R) platforms

ocp-product-docs-plaintext/4.15/backup_and_restore/application_backup_and_restore/release-notes/oadp-release-notes-1-3.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33

44
The release notes for OpenShift API for Data Protection (OADP) 1.3 describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues.
55

6+
# OADP 1.3.7 release notes
7+
8+
OpenShift API for Data Protection (OADP) 1.3.7 is a Container Grade Only (CGO) release, which is released to refresh the health grades of the containers. No code was changed in the product itself compared to that of OADP 1.3.6.
9+
10+
The following Common Vulnerabilities and Exposures (CVEs) have been fixed in OADP 1.3.7
11+
12+
* CVE-2024-45338
13+
* CVE-2025-22868
14+
* CVE-2025-30204
15+
16+
## New features
17+
18+
You can collect logs and information about OADP custom resources by using the must-gather tool. The must-gather data must be attached to all customer cases. This tool generates a Markdown output file with the collected information, which is located in the must-gather logs clusters directory. OADP-5384
19+
620
# OADP 1.3.6 release notes
721

822
OpenShift API for Data Protection (OADP) 1.3.6 is a Container Grade Only (CGO) release, which is released to refresh the health grades of the containers. No code was changed in the product itself compared to that of OADP 1.3.5.
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,86 @@
11
# Using the must-gather tool
22

33

4-
You can collect logs, metrics, and information about OADP custom resources by using the must-gather tool. The must-gather data must be attached to all customer cases.
5-
You can run the must-gather tool with the following data collection options:
6-
* Full must-gather data collection collects Prometheus metrics, pod logs, and Velero CR information for all namespaces where the OADP Operator is installed.
7-
* Essential must-gather data collection collects pod logs and Velero CR information for a specific duration of time, for example, one hour or 24 hours. Prometheus metrics and duplicate logs are not included.
8-
* must-gather data collection with timeout. Data collection can take a long time if there are many failed Backup CRs. You can improve performance by setting a timeout value.
9-
* Prometheus metrics data dump downloads an archive file containing the metrics data collected by Prometheus.
4+
You can collect logs and information about OADP custom resources by using the must-gather tool. The must-gather data must be attached to all customer cases.
5+
The must-gather tool is a container and does not run all the time. The tool runs for a few minutes only after you invoke the tool by running the must-gather command.
6+
7+
# Using the must-gather tool
8+
9+
You can run the must-gather tool with the following options. To use an option, you can add a flag corresponding to that option in the must-gather command.
10+
11+
Default configuration:: This configuration collects pod logs, OADP and Velero custom resource (CR) information for all namespaces where the OADP Operator is installed.
12+
Timeout:: Data collection can take a long time if there are many failed Backup CRs. You can improve performance by setting a timeout value.
13+
Insecure TLS connections:: If a custom CA certificate is used, use the must-gather tool with insecure TLS connections.
14+
15+
The must-gather tool generates a Markdown output file with the collected information. The Markdown file is located in a cluster directory.
16+
1017
* You have logged in to the Red Hat OpenShift Container Platform cluster as a user with the cluster-admin role.
1118
* You have installed the OpenShift CLI (oc).
12-
* You must use Red Hat Enterprise Linux (RHEL) 9 with OADP 1.4.
19+
* You are using OADP 1.3 or 1.4.
20+
1321
1. Navigate to the directory where you want to store the must-gather data.
1422
2. Run the oc adm must-gather command for one of the following data collection options:
15-
* For full must-gather data collection, including Prometheus metrics, run the following command:
23+
* To use the default configuration of the must-gather tool, run one of the following commands:
24+
* For OADP 1.3, run the following command:
1625

1726
```terminal
18-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4
27+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3
1928
```
2029

21-
22-
The data is saved as must-gather/must-gather.tar.gz. You can upload this file to a support case on the Red Hat Customer Portal.
23-
24-
For essential must-gather data collection, without Prometheus metrics, for a specific time duration, run the following command:
30+
* For OADP 1.4, run the following command:
2531

2632
```terminal
27-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 \
28-
-- /usr/bin/gather_<time>_essential 1
33+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4
2934
```
3035

31-
Specify the time in hours. Allowed values are 1h, 6h, 24h, 72h, or all, for example, gather_1h_essential or gather_all_essential.
32-
* For must-gather data collection with timeout, run the following command:
36+
* To use the timeout flag with the must-gather tool, run one of the following commands:
37+
* For OADP 1.3, run the following command:
3338

3439
```terminal
35-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 \
36-
-- /usr/bin/gather_with_timeout <timeout> 1
40+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- /usr/bin/gather --request-timeout <timeout> 1
3741
```
3842

39-
Specify a timeout value in seconds.
40-
* For a Prometheus metrics data dump, run the following command:
43+
Specify a timeout value.
44+
* For OADP 1.4, run the following command:
4145

4246
```terminal
43-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- /usr/bin/gather_metrics_dump
47+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- /usr/bin/gather_with_timeout <timeout> 1
4448
```
4549

46-
47-
This operation can take a long time. The data is saved as must-gather/metrics/prom_data.tar.gz.
48-
* Gathering cluster data
49-
50-
# Using must-gather with insecure TLS connections
51-
52-
If a custom CA certificate is used, the must-gather pod fails to grab the output for velero logs/describe. To use the must-gather tool with insecure TLS connections, you can pass the gather_without_tls flag to the must-gather command.
53-
54-
* Pass the gather_without_tls flag, with value set to true, to the must-gather tool by using the following command:
55-
1. For OADP 1.3, run the following command:
50+
Specify a timeout value in seconds.
51+
* To use the insecure TLS connection flag with the must-gather tool, run one of the following commands:
52+
* For OADP 1.3, run the following command:
5653

5754
```terminal
58-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- /usr/bin/gather_without_tls <true/false>
55+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- /usr/bin/gather --skip-tls
5956
```
6057

61-
2. For OADP 1.4, run the following command:
58+
* For OADP 1.4, run the following command:
6259

6360
```terminal
64-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- /usr/bin/gather_without_tls <true/false>
61+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- /usr/bin/gather_without_tls <value> 1
6562
```
6663

67-
68-
By default, the flag value is set to false. Set the value to true to allow insecure TLS connections.
69-
70-
# Combining options when using the must-gather tool
71-
72-
Currently, it is not possible to combine must-gather scripts, for example specifying a timeout threshold while permitting insecure TLS connections. In some situations, you can get around this limitation by setting up internal variables on the must-gather command line, such as the following examples:
73-
74-
* For OADP 1.3:
64+
By default, the value is false. Set to true to allow insecure TLS connections.
65+
* To use a combination of the insecure TLS connection, and the timeout flags with the must-gather tool, run one of the following commands:
66+
* For OADP 1.3, run the following command:
7567

7668
```terminal
77-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds>
69+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- /usr/bin/gather --request-timeout 15s --skip-tls=true 1
7870
```
7971

80-
* For OADP 1.4:
72+
By default, the --skip-tls flag value is false. Set the value to true to allow insecure TLS connections. Specify a timeout value.
73+
* For OADP 1.4, run the following command:
8174

8275
```terminal
83-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds>
76+
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 --skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds> 1
8477
```
8578

79+
By default, the --skip-tls flag value is false. Set the value to true to allow insecure TLS connections. Specify a timeout value.
8680

87-
In these examples, set the skip_tls variable before running the gather_with_timeout script. The result is a combination of gather_with_timeout and gather_without_tls.
88-
89-
The only other variables that you can specify this way are the following:
90-
91-
* logs_since, with a default value of 72h
92-
* request_timeout, with a default value of 0s
93-
94-
If DataProtectionApplication custom resource (CR) is configured with s3Url and insecureSkipTLS: true, the CR does not collect the necessary logs because of a missing CA certificate. To collect those logs, run the must-gather command with the following option:
81+
1. Verify that the Markdown output file is generated at the following location: must-gather.local.89&#8230;&#8203;054550/registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.5-sha256-0&#8230;&#8203;84/clusters/a4&#8230;&#8203;86/oadp-must-gather-summary.md
82+
2. Review the must-gather data in the Markdown file by opening the file in a Markdown previewer. For an example output, refer to the following image. You can upload this output file to a support case on the Red Hat Customer Portal.
83+
Example markdown output of must-gather tool
84+
![must-gather markdown output]
9585

96-
* For OADP 1.3:
97-
98-
```terminal
99-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3 -- /usr/bin/gather_without_tls true
100-
```
101-
102-
* For OADP 1.4:
103-
104-
```terminal
105-
$ oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4 -- /usr/bin/gather_without_tls true
106-
```
86+
* Gathering cluster data

ocp-product-docs-plaintext/4.15/installing/installing_bare_metal/installing-bare-metal-network-customizations.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1162,6 +1162,11 @@ You can configure RHCOS during ISO and PXE installations by using the following
11621162
* Ignition configs: Red Hat OpenShift Container Platform Ignition config files (*.ign) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the RHCOS installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the coreos-installer to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
11631163
* coreos-installer: You can boot the live ISO installer to a shell prompt, which allows you to prepare the permanent system in a variety of ways before first boot. In particular, you can run the coreos-installer command to identify various artifacts to include, work with disk partitions, and set up networking. In some cases, you can configure features on the live system and copy them to the installed system.
11641164

1165+
[NOTE]
1166+
----
1167+
As of version 0.17.0-3, coreos-installer requires RHEL 9 or later to run the program. You can still use older versions of coreos-installer to customize RHCOS artifacts of newer Red Hat OpenShift Container Platform releases and install metal images to disk. You can download older versions of the coreos-installer binary from the coreos-installer image mirror page.
1168+
----
1169+
11651170
Whether to use an ISO or PXE install depends on your situation. A PXE install requires an available DHCP service and more preparation, but can make the installation process more automated. An ISO install is a more manual process and can be inconvenient if you are setting up more than a few machines.
11661171

11671172
## Installing RHCOS by using an ISO image

ocp-product-docs-plaintext/4.15/installing/installing_bare_metal/installing-bare-metal.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,6 +1151,11 @@ You can configure RHCOS during ISO and PXE installations by using the following
11511151
* Ignition configs: Red Hat OpenShift Container Platform Ignition config files (*.ign) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the RHCOS installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the coreos-installer to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
11521152
* coreos-installer: You can boot the live ISO installer to a shell prompt, which allows you to prepare the permanent system in a variety of ways before first boot. In particular, you can run the coreos-installer command to identify various artifacts to include, work with disk partitions, and set up networking. In some cases, you can configure features on the live system and copy them to the installed system.
11531153

1154+
[NOTE]
1155+
----
1156+
As of version 0.17.0-3, coreos-installer requires RHEL 9 or later to run the program. You can still use older versions of coreos-installer to customize RHCOS artifacts of newer Red Hat OpenShift Container Platform releases and install metal images to disk. You can download older versions of the coreos-installer binary from the coreos-installer image mirror page.
1157+
----
1158+
11541159
Whether to use an ISO or PXE install depends on your situation. A PXE install requires an available DHCP service and more preparation, but can make the installation process more automated. An ISO install is a more manual process and can be inconvenient if you are setting up more than a few machines.
11551160

11561161
## Installing RHCOS by using an ISO image

0 commit comments

Comments
 (0)