gnelson/ocp-docs-suggestions-1k-pr huggingface dataset:
Original: storage:
- cex:
enabled: true
options: <1>
- --pbkdf
- pbkdf2
ifndef::ibm-z-kvm[]
device: /dev/disk/by-partlabel/root <2>
endif::ibm-z-kvm[]
ifdef::ibm-z-kvm[]
device: /dev/disk/by-partlabel/root
label: luks-root
name: root
wipe_volume: true
ifndef::ibm-z-kvm[]
fips: true <3>
kernel_arguments: <4>
endif::ibm-z-kvm[]
ifdef::ibm-z-kvm[]
fips: true <2>
kernel_arguments: <3>
endif::ibm-z-kvm[]
- rd.luks.key=/etc/luks/cex.key
<1> The `pbkdf` option is only required if FIPS mode is enabled. Omit the entry if FIPS is disabled.
ifndef::ibm-z-kvm[]
<2> For installations on DASD-type disks, replace with `device: /dev/disk/by-label/root`.
<3> Specifies whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
<4> Specifies the location of the pass key that is required to decrypt the device.
endif::ibm-z-kvm[]
ifdef::ibm-z-kvm[]
<2> Specifies whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
<3> Specifies the location of the pass key that is required to decrypt the device.
ifndef::ibm-z-kvm[]
coreos.inst.install_dev=/dev/disk/by-id/scsi-<serial_number> \// <1>
coreos.inst.ignition_url=http://<http_server>/master.ign \// <2>
coreos.live.rootfs_url=http://<http_server>/rhcos-<version>-live-rootfs.<architecture>.img \// <3>
rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000 // <4>
ifdef::ibm-z[]
<1> Specifies a unique fully qualified path depending on disk type. This can be DASD-type or FCP-type disks.
endif::ibm-z[]
ifdef::ibm-z-lpar[]
<1> Specifies a unique fully qualified path depending on disk type. This can be DASD-type, FCP-type, or NVMe-type disks.
endif::ibm-z-lpar[]
<2> Specifies the location of the Ignition config file. Use `master.ign` or `worker.ign`. Only HTTP and HTTPS protocols are supported.
<3> Specifies the location of the `rootfs` artifact for the `kernel` and `initramfs` you are booting. Only HTTP and HTTPS protocols are supported.
<4> Specifies the root device. For installations on DASD-type disks, replace with `rd.dasd=0.0.xxxx` to specify the DASD device.
ifdef::ibm-z-kvm[]
coreos.inst.ignition_url=http://<http_server>/master.ign \// <1>
coreos.live.rootfs_url=http://<http_server>/rhcos-<version>-live-rootfs.<architecture>.img \// <2>
rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000
<1> Specifies the location of the Ignition config file. Use `master.ign` or `worker.ign`. Only HTTP and HTTPS protocols are supported.
<2> Specifies the location of the `rootfs` artifact for the `kernel` and `initramfs` you are booting. Only HTTP and HTTPS protocols are supported.

Revised: <4> Specify the root device. For installations on DASD-type disks, replace with `rd.dasd=0.0.xxxx` to specify the DASD device.
Original: You can migrate virtual machines (VMs) within a single cluster from one storage class to a different storage class. By using the {product-title} web console, you can perform the migration for the VMs in bulk.
Revised: You can migrate virtual machines (VMs) within a single cluster from one storage class to a different storage class in bulk.
You can migrate virtual machines (VMs) within a single cluster from one storage class to a different storage class in bulk by using the {product-title} web console.
Original: Using PostgreSQL persistence you can save data, such as {ols-long} conversation history or quota usage, to a PostgreSQL database so that the data is retained in persistent volume. With PostgreSQL persistence, the data persists if the PostgreSQL pod restarts or is rescheduled in your {ocp-product-title} installation. 
Revised: Using PostgreSQL persistence, you can save data, such as {ols-long} conversation history or quota usage, to a PostgreSQL database so that the data is retained in persistent volume. With PostgreSQL persistence, the data persists if the PostgreSQL pod restarts or is rescheduled in your {ocp-product-title} installation.
Original: <1> The class depends on the existing instances of the storage class in the cluster. If you leave the storage class empty, {ols-short} uses default values. The persistent volume allocated for the PostgreSQL database is 1 GB in size and it uses the storage class of the default cluster. Use the empty braces for the `storage` parameter to use the default values.
Revised: <1> The class depends on the existing instances of the storage class in the cluster. If you leave the storage class empty, {ols-short} uses default values. The persistent volume allocated for the PostgreSQL database is 1 GB in size and uses the storage class of the default cluster. Specify empty braces for the `storage` parameter to use the default values.
Original: <1> Specifies the size of the Requested Volume. If the size is not specified, the default value is 1 GB.
<2> Specifies the Storage Class of the Requested Volume. If no class is specified, the storage class uses the default storage class setting for the cluster.
Revised: <1> Specifies the size of the requested volume. If the size is not specified, the default value is 1 GB.
<2> Specifies the storage class of the requested volume. If no class is specified, the storage class uses the default storage class setting for the cluster.
Original: * xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.html#installing-sr-iov-operator_installing-sriov-operator[Installing the SR-IOV Network Operator]
Revised: * xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Installing the SR-IOV Network Operator]
Original: A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane that are hosted on the hosting cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the `hcp` command-line interface (CLI) to create a hosted cluster.
Revised: A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane hosted on a management cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the `hcp` command-line interface (CLI) to create a hosted cluster.
Original: $ export NODEPOOL_NAME="${CLUSTER_NAME}-az1" \
&& export WORKER_COUNT="2" \
&& export FLAVOR="m1.xlarge" \
&& export AZ="az1"
Revised: $ export NODEPOOL_NAME="${CLUSTER_NAME}-az1" \
&& export WORKER_COUNT="2" \
&& export FLAVOR="m1.xlarge" \
&& export AZ="az1"
Original: [source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather --request-timeout 1m # <1>
----
<1> In this example, the timeout is 1 minute.
Revised: [source,terminal,subs="attributes+"]
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather --request-timeout <timeout> # <1>
<1> Specify a timeout value.
Original: [source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather --request-timeout 15s --skip-tls #<1>
----
<1> In this example, the timeout is 15 seconds. By default, the `--skip-tls` flag value is `false`. Set the value to `true` to allow insecure TLS connections.
Revised: [source,terminal,subs="attributes+"]
$ oc adm must-gather --image={must-gather-v1-3} -- /usr/bin/gather --request-timeout 15s --skip-tls=true #<1>
<1> By default, the `--skip-tls` flag value is `false`. Set the value to `true` to allow insecure TLS connections. Specify a timeout value.
Original: [source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} --skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds>
----
Revised: [source,terminal,subs="attributes+"]
$ oc adm must-gather --image={must-gather-v1-4} --skip_tls=true /usr/bin/gather_with_timeout <timeout_value_in_seconds> #<1>
<1> By default, the `--skip-tls` flag value is `false`. Set the value to `true` to allow insecure TLS connections. Specify a timeout value.
Original: 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.

Default configuration:: This configuration collects pod logs, {oadp-short} and `Velero` custom resource (CR) information for all namespaces where the {oadp-short} Operator is installed.
Timeout:: Data collection can take a long time if there are many failed `Backup` CRs. You can improve performance by setting a timeout value.
Insecure TLS connections:: If a custom CA certificate is used, use the `must-gather` tool with  insecure TLS connections.
Revised: The `must-gather` tool collects pod logs, and {oadp-short} and `Velero` custom resource (CR) information for all namespaces where the {oadp-short} Operator is installed. 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.

Timeout:: Data collection can take a long time if there are many failed `Backup` CRs. You can improve performance by setting a timeout value.
Insecure TLS connections:: If a custom CA certificate is used, use the `must-gather` tool with  insecure TLS connections.
Original: . 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 link:https://access.redhat.com/[Red{nbsp}Hat Customer Portal].

.Example markdown output of must-gather tool
image::oadp-must-gather-markdown-output.png[must-gather markdown output]
Revised: . 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 link:https://access.redhat.com/[Red{nbsp}Hat Customer Portal].

.Example markdown output of must-gather tool
image::oadp-must-gather-markdown-output.png[must-gather markdown output]
Original: * Previously, a sample Operator incorrectly updated its `lastTransitionTime` variable while in a `progressing` condition. This caused the installation program to perceive Operators as unstable, leading to deployment issues. With this release, the Operator checks for a status change before updating the `progressing` condition, improving operator stability, and reducing installation errors. (link:https://issues.redhat.com/browse/OCPBUGS-55800[*OCPBUGS-55800*])
Revised: * Previously, a sample Operator incorrectly updated its `lastTransitionTime` variable while in a `progressing` condition. This caused the installation program to perceive Operators as unstable, leading to deployment issues. With this release, the Operator checks for a status change before updating the `progressing` condition, improving Operator stability, and reducing installation errors. (link:https://issues.redhat.com/browse/OCPBUGS-55800[OCPBUGS-55800])
Original: * Previously, {azure-first} spot virtual machine (VM) de-allocation during provisioning caused the machine controller to go into a loop, leading to Spot VM provisioning failures and unavailable nodes. With this release, the `deallocate eviction` policy is replaced with the `delete eviction policy` in {azure-short} spot VM provisioning. This improves the machine controller resilience and avoids the loop during provisioning. (link:https://issues.redhat.com/browse/OCPBUGS-55729[*OCPBUGS-55729*])
Revised: * Previously, when {azure-first} Spot virtual machine (VM) de-allocation occurred during provisioning, the machine controller entered a loop, leading to Spot VM provisioning failures and unavailable nodes. With this release, the `deallocate eviction` policy is replaced with the `delete eviction` policy in {azure-short} Spot VM provisioning. As a result, the machine controller is more resilient and it no longer enters a loop during provisioning. (link:https://issues.redhat.com/browse/OCPBUGS-55729[OCPBUGS-55729])
Original: * Previously, a bug caused excessive updates to the `progressing` condition because of unsorted failing image imports. This led to unnecessary resource consumption for users. With this release, the excessive updates are fixed in the `samples` Operator by sorting failing image imports. As a result, the Operator performance is improved by reducing unnecessary updates for the image imports. (link:https://issues.redhat.com/browse/OCPBUGS-55894[*OCPBUGS-55894*])
Revised: * Previously, a bug caused excessive updates to the `progressing` condition because of unsorted failing image imports. This led to unnecessary resource consumption for users. With this release, the excessive updates are fixed in the Samples Operator by sorting failing image imports. As a result, the Operator performance is improved by reducing unnecessary updates for the image imports. (link:https://issues.redhat.com/browse/OCPBUGS-55894[OCPBUGS-55894])
Original: * Previously, a sample Operator incorrectly updated its `lastTransitionTime` variable while in a `progressing` condition. This caused the installation program to perceive Operators as unstable, leading to deployment issues. With this release, the Operator checks for a status change before updating the `progressing` condition, improving operator stability, and reducing installation errors. (link:https://issues.redhat.com/browse/OCPBUGS-55800[*OCPBUGS-55800*])
Revised: * Previously, a Samples Operator incorrectly updated its `lastTransitionTime` variable while in a `progressing` condition. This caused the installation program to perceive Operators as unstable, leading to deployment issues. With this release, the Operator checks for a status change before updating the `progressing` condition, improving operator stability, and reducing installation errors. (link:https://issues.redhat.com/browse/OCPBUGS-55800[OCPBUGS-55800])
Original: * Previously, a bug in the clock accuracy update occurred during the grandmaster clock sync state reception from events and led to incorrect clock synchronization for users. With this release, the clock class accuracy in the `event handler` is updated, ensuring compliance with International Telecommunication Union Telecommunication Standardization Sector (ITU-T) recommendations and improving synchronization accuracy. (link:https://issues.redhat.com/browse/OCPBUGS-55740[*OCPBUGS-55740*])
Revised: * Previously, a bug in the clock accuracy update occurred during the grandmaster clock sync state reception from events. As a consequence, clock synchronization was incorrect for users. With this release, the clock class accuracy in the event handler is updated, ensuring compliance with International Telecommunication Union Telecommunication Standardization Sector (ITU-T) recommendations and improving synchronization accuracy. (link:https://issues.redhat.com/browse/OCPBUGS-55740[OCPBUGS-55740])
Original: * Previously, no event was logged when an error occurred from a failed ingress-to-route conversion. With this update, this error appears in the `event` logs. (link:https://issues.redhat.com/browse/OCPBUGS-55943[*OCPBUGS-55943*])
Revised: * Previously, no event was logged when an error occurred from a failed ingress-to-route conversion. With this update, this error appears in the `event` logs. (link:https://issues.redhat.com/browse/OCPBUGS-55943[OCPBUGS-55943])
Original: * Previously, unnecessary resource consumption and potential performance degradation were observed because of a cluster Operator watch that affected all cluster Operators. With this release, the watch includes only `openshift-samples`, improving efficiency by limiting the number of cluster Operators that are watched. (link:https://issues.redhat.com/browse/OCPBUGS-55795[*OCPBUGS-55795*])
Revised: * Previously, unnecessary resource consumption and potential performance degradation were observed because of a cluster Operator watch that affected all cluster Operators. With this release, the watch includes only `openshift-samples`, improving efficiency by limiting the number of cluster Operators that are watched. (link:https://issues.redhat.com/browse/OCPBUGS-55795[OCPBUGS-55795])
Original: When you create a control plane machine set for an existing cluster, the provider specification must match the `providerSpec` configuration in the control plane machine custom resource (CR) that is created by the installation program. You can omit any field that is set in the failure domain section of the CR.
Revised: During installation, the installation program created a `providerSpec` configuration in the control plane machine custom resource (CR). When you create a control plane machine set for an existing cluster, the provider specification must match that `providerSpec` configuration. You can omit any field that is set in the failure domain section of the CR.
Original: diskGiB: 120 <2>
kind: VSphereMachineProviderSpec <3>
memoryMiB: 16384 <4>
network: <5>
numCPUs: 4 <6>
numCoresPerSocket: 4 <7>
template: <vm_template_name> <8>
name: master-user-data <9>
workspace: <10>
datacenter: <vcenter_data_center_name> <11>
datastore: <vcenter_datastore_name> <12>
folder: <path_to_vcenter_vm_folder> <13>
resourcePool: <vsphere_resource_pool> <14>
server: <vcenter_server_ip> <15>
<2> Specifies the VM disk size for the control plane machines.
<3> Specifies the cloud provider platform type. Do not change this value.
<4> Specifies the memory allocated for the control plane machines.
<5> Specifies the network on which the control plane is deployed.
Revised: <2> Specifies one or more data disk definitions.
Original: diskGiB: 120 <2>
kind: VSphereMachineProviderSpec <3>
memoryMiB: 16384 <4>
network: <5>
numCPUs: 4 <6>
numCoresPerSocket: 4 <7>
template: <vm_template_name> <8>
name: master-user-data <9>
workspace: <10>
datacenter: <vcenter_data_center_name> <11>
datastore: <vcenter_datastore_name> <12>
folder: <path_to_vcenter_vm_folder> <13>
resourcePool: <vsphere_resource_pool> <14>
server: <vcenter_server_ip> <15>
<2> Specifies the VM disk size for the control plane machines.
<3> Specifies the cloud provider platform type. Do not change this value.
<4> Specifies the memory allocated for the control plane machines.
<5> Specifies the network on which the control plane is deployed.
<6> Specifies the number of CPUs allocated for the control plane machines.
<7> Specifies the number of cores for each control plane CPU.
<8> Specifies the vSphere VM template to use, such as `user-5ddjd-rhcos`.
<9> Specifies the control plane user data secret. Do not change this value.
<10> Specifies the workspace details for the control plane.
<11> Specifies the vCenter data center for the control plane.
<12> Specifies the vCenter datastore for the control plane.
<13> Specifies the path to the vSphere VM folder in vCenter, such as `/dc1/vm/user-inst-5ddjd`.
<14> Specifies the vSphere resource pool for your VMs.
<15> Specifies the vCenter server IP or fully qualified domain name.
Revised: <12> Specifies the vCenter datacenter for the control plane.
Original: * Previously, the omission of the `OLMManagedLabelKey` label on objects resulted in cluster operation failures. With this release,  an update improves pod stability and ensures that the Operator Lifecycle Manager operates properly. (link:https://issues.redhat.com/browse/OCPBUGS-56098[OCPBUGS-56098])
Revised: * Previously, the omission of the `OLMManagedLabelKey` label on objects resulted in cluster operation failures. With this release, an update improves pod stability and ensures that the Operator Lifecycle Manager operates properly. (link:https://issues.redhat.com/browse/OCPBUGS-56098[*OCPBUGS-56098*])
Original: * Previously, an invalid tar extraction format resulted in an improper file separation in the `ramdisk` logs, and caused file separators to appear randomly. With this release, an updated `ramdisk` log file  processes tar entries individually. This fix improves log readability, making them easier to interpret. (link:https://issues.redhat.com/browse/OCPBUGS-55938[OCPBUGS-55938])
Revised: * Previously, an invalid `.tar` extraction format resulted in an improper file separation in the `ramdisk` logs, and caused file separators to appear randomly. With this release, an updated `ramdisk` log file  processes `.tar` entries individually. This fix improves log readability, making them easier to interpret. (link:https://issues.redhat.com/browse/OCPBUGS-55938[*OCPBUGS-55938*])
Original: * Previously, there was no event logged when an error occurred from failed conversion from ingress to route conversion. With this update, this error appear in the event logs. (link:https://issues.redhat.com/browse/OCPBUGS-55338[*OCPBUGS-55338*])
Revised: * Previously, no event was logged when an error occurred from failed conversion from ingress to route. With this update, this error appear in the event logs. (link:https://issues.redhat.com/browse/OCPBUGS-55338[*OCPBUGS-55338*])
Original: * Previously, a missing `afterburn` package resulted in the failure of the `gcp-hostname.service`, which causied the `scale-up` job to fail, impacting end user deployments. With this release, the `afterburn` package is installed in the RHEL `scale-up` job. This fix enables a successful `scale-up` action, resolving the `gcp-hostname` service failure. (link:https://issues.redhat.com/browse/OCPBUGS-55158[*OCPBUGS-55158*])
Revised: * Previously, a missing `afterburn` package resulted in the failure of the `gcp-hostname.service`, which caused the `scale-up` job to fail, impacting end-user deployments. With this release, the `afterburn` package is installed in the {op-system-base} `scale-up` job. This fix enables a successful `scale-up` action, resolving the `gcp-hostname` service failure. (link:https://issues.redhat.com/browse/OCPBUGS-55158[*OCPBUGS-55158*])
Original: * Previously, there was no communication between a `localnet` pod and a pod in the default network when both pods are on the same node. With this release, an update fixes this problem when the endpoints are on a different node. (link:https://issues.redhat.com/browse/OCPBUGS-55016[*OCPBUGS-55016*])
Revised: * Previously, there was no communication between a `localnet` pod and a pod in the default network when both pods were on the same node. With this release, an update fixes this problem when the endpoints are on a different node. (link:https://issues.redhat.com/browse/OCPBUGS-55016[*OCPBUGS-55016*])
Original: * Previously, cluster nodes repeatedly lost communication due to improper remote port binding by Open Virtual Network (OVN)-Kubernetes. This affected pod communication across nodes. With this release, the remote port binding functionality is updated to be handled by OVN directly, improving the reliability of cluster node communication. (link:https://issues.redhat.com/browse/OCPBUGS-51144[OCPBUGS-51144])
Revised: * Previously, cluster nodes repeatedly lost communication due to improper remote port binding by Open Virtual Network (OVN)-Kubernetes. This affected pod communication across nodes. With this release, the remote port binding functionality is updated to be handled by OVN directly, improving the reliability of cluster node communication. (link:https://issues.redhat.com/browse/OCPBUGS-51144[*OCPBUGS-51144*])
Original: Besides the required customer procedures listed in _Required customer procedure_, there are other specific actions that you must take when creating an {product-title} cluster on {GCP} using Workload Identity Federation as the authentication type.
. Assign the following roles to the link:https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource[service account] of the user implementing the Workload Identity Federation authentication type:
Revised: The following roles are only required when creating, updating, or deleting WIF configurations.