Skip to content

Commit fb58a76

Browse files
committed
OLS-1796: OCP docs update, week of 2025/05/26
1 parent 523d9dc commit fb58a76

File tree

234 files changed

+5782
-3169
lines changed

Some content is hidden

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

234 files changed

+5782
-3169
lines changed

ocp-product-docs-plaintext/4.15/installing/installing_bare_metal_ipi/ipi-install-installation-workflow.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1386,6 +1386,12 @@ The most common use case for this functionality is to specify a static IP addres
13861386
* Configure a PTR DNS record with a valid hostname for each node with a static IP address.
13871387
* Install the NMState CLI (nmstate).
13881388

1389+
1390+
[IMPORTANT]
1391+
----
1392+
If you use a provisioning network, configure it by using the dnsmasq tool in Ironic. To do a fully static deployment, you must use virtual media.
1393+
----
1394+
13891395
1. Optional: Consider testing the NMState syntax with nmstatectl gc before including the syntax in the install-config.yaml file, because the installation program does not check the NMState YAML syntax.
13901396

13911397
[NOTE]

ocp-product-docs-plaintext/4.15/machine_management/cluster_api_machine_management/cluster-api-troubleshooting.txt

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,16 @@ For clusters that use the Cluster API, OpenShift CLI (`oc`) commands prioritize
1818
This behavior impacts any oc command that acts upon any object that is represented in both the Cluster API and the Machine API.
1919
This explanation uses the oc delete machine command, which deletes a machine, as an example.
2020

21-
## Cause
22-
23-
When you run an oc command, oc communicates with the Kube API server to determine which objects to act upon.
21+
Cause:: When you run an oc command, oc communicates with the Kube API server to determine which objects to act upon.
2422
The Kube API server uses the first installed custom resource definition (CRD) it encounters alphabetically when an oc command is run.
2523

2624
CRDs for Cluster API objects are in the cluster.x-k8s.io group, while CRDs for Machine API objects are in the machine.openshift.io group.
2725
Because the letter c precedes the letter m alphabetically, the Kube API server matches on the Cluster API object CRD.
2826
As a result, the oc command acts upon Cluster API objects.
29-
30-
## Consequences
31-
32-
Due to this behavior, the following unintended outcomes can occur on a cluster that uses the Cluster API:
33-
27+
Consequence:: Due to this behavior, the following unintended outcomes can occur on a cluster that uses the Cluster API:
3428
* For namespaces that contain both types of objects, commands such as oc get machine return only Cluster API objects.
3529
* For namespaces that contain only Machine API objects, commands such as oc get machine return no results.
36-
37-
## Workaround
38-
39-
You can ensure that oc commands act on the type of objects you intend by using the corresponding fully qualified name.
30+
Workaround:: You can ensure that oc commands act on the type of objects you intend by using the corresponding fully qualified name.
4031

4132
* You have access to the cluster using an account with cluster-admin permissions.
4233
* You have installed the OpenShift CLI (`oc`).

ocp-product-docs-plaintext/4.15/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-aws.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example YAML snippets show provider specification and failure doma
1010

1111
## Sample AWS provider specification
1212

13-
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.
13+
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 the installation program creates. You can omit any field that is set in the failure domain section of the CR.
1414

1515
In the following example, <cluster_id> is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
1616

ocp-product-docs-plaintext/4.15/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-gcp.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example YAML snippets show provider specification and failure doma
1010

1111
## Sample GCP provider specification
1212

13-
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.
13+
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 the installation program creates. You can omit any field that is set in the failure domain section of the CR.
1414

1515
## Values obtained by using the OpenShift CLI
1616

ocp-product-docs-plaintext/4.15/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example YAML snippet shows a provider specification configuration
1010

1111
## Sample Nutanix provider specification
1212

13-
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.
13+
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 the installation program creates.
1414

1515
## Values obtained by using the OpenShift CLI
1616

ocp-product-docs-plaintext/4.15/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-openstack.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example YAML snippets show provider specification and failure doma
1010

1111
## Sample RHOSP provider specification
1212

13-
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.
13+
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 the installation program creates.
1414

1515

1616
```yaml

ocp-product-docs-plaintext/4.15/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example YAML snippets show provider specification and failure doma
1010

1111
## Sample VMware vSphere provider specification
1212

13-
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.
13+
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 the installation program creates.
1414

1515

1616
```yaml

ocp-product-docs-plaintext/4.15/machine_management/creating-infrastructure-machinesets.txt

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,7 +1021,7 @@ This sample YAML defines a compute machine set that runs on VMware vSphere and c
10211021
node-role.kubernetes.io/infra: "".
10221022

10231023
In this sample, <infrastructure_id> is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
1024-
<infra>
1024+
infra
10251025
is the node label to add.
10261026

10271027

@@ -1038,24 +1038,21 @@ spec:
10381038
replicas: 1
10391039
selector:
10401040
matchLabels:
1041-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> 1
1042-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra 2
1041+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
1042+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra
10431043
template:
10441044
metadata:
10451045
creationTimestamp: null
10461046
labels:
1047-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> 1
1048-
machine.openshift.io/cluster-api-machine-role: <infra> 3
1049-
machine.openshift.io/cluster-api-machine-type: <infra> 3
1050-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra 2
1047+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
1048+
machine.openshift.io/cluster-api-machine-role: infra 3
1049+
machine.openshift.io/cluster-api-machine-type: infra
1050+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra
10511051
spec:
10521052
metadata:
10531053
creationTimestamp: null
10541054
labels:
1055-
node-role.kubernetes.io/infra: "" 3
1056-
taints: 4
1057-
- key: node-role.kubernetes.io/infra
1058-
effect: NoSchedule
1055+
node-role.kubernetes.io/infra: ""
10591056
providerSpec:
10601057
value:
10611058
apiVersion: vsphereprovider.openshift.io/v1beta1
@@ -1068,19 +1065,22 @@ spec:
10681065
creationTimestamp: null
10691066
network:
10701067
devices:
1071-
- networkName: "<vm_network_name>" 5
1068+
- networkName: "<vm_network_name>" 4
10721069
numCPUs: 4
10731070
numCoresPerSocket: 1
10741071
snapshot: ""
1075-
template: <vm_template_name> 6
1072+
template: <vm_template_name> 5
10761073
userDataSecret:
10771074
name: worker-user-data
10781075
workspace:
1079-
datacenter: <vcenter_datacenter_name> 7
1080-
datastore: <vcenter_datastore_name> 8
1081-
folder: <vcenter_vm_folder_path> 9
1082-
resourcepool: <vsphere_resource_pool> 10
1083-
server: <vcenter_server_ip> 11
1076+
datacenter: <vcenter_datacenter_name> 6
1077+
datastore: <vcenter_datastore_name> 7
1078+
folder: <vcenter_vm_folder_path> 8
1079+
resourcepool: <vsphere_resource_pool> 9
1080+
server: <vcenter_server_ip> 10
1081+
taints: 11
1082+
- key: node-role.kubernetes.io/infra
1083+
effect: NoSchedule
10841084
```
10851085

10861086

@@ -1090,21 +1090,21 @@ Specify the infrastructure ID that is based on the cluster ID that you set when
10901090
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
10911091
```
10921092

1093-
Specify the infrastructure ID and <infra> node label.
1094-
Specify the <infra> node label.
1095-
Specify a taint to prevent user workloads from being scheduled on infra nodes.
1096-
1097-
[NOTE]
1098-
----
1099-
After adding the NoSchedule taint on the infrastructure node, existing DNS pods running on that node are marked as misscheduled. You must either delete or add toleration on misscheduled DNS pods.
1100-
----
1093+
Specify the infrastructure ID and infra node label.
1094+
Specify the infra node label.
11011095
Specify the vSphere VM network to deploy the compute machine set to. This VM network must be where other compute machines reside in the cluster.
11021096
Specify the vSphere VM template to use, such as user-5ddjd-rhcos.
11031097
Specify the vCenter Datacenter to deploy the compute machine set on.
11041098
Specify the vCenter Datastore to deploy the compute machine set on.
11051099
Specify the path to the vSphere VM folder in vCenter, such as /dc1/vm/user-inst-5ddjd.
11061100
Specify the vSphere resource pool for your VMs.
11071101
Specify the vCenter server IP or fully qualified domain name.
1102+
Specify a taint to prevent user workloads from being scheduled on infra nodes.
1103+
1104+
[NOTE]
1105+
----
1106+
After adding the NoSchedule taint on the infrastructure node, existing DNS pods running on that node are marked as misscheduled. You must either delete or add toleration on misscheduled DNS pods.
1107+
----
11081108

11091109
## Creating a compute machine set
11101110

ocp-product-docs-plaintext/4.15/machine_management/creating_machinesets/creating-machineset-vsphere.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@ spec:
3838
replicas: 1
3939
selector:
4040
matchLabels:
41-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> 1
42-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role> 2
41+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
42+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
4343
template:
4444
metadata:
4545
creationTimestamp: null
4646
labels:
47-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> 1
47+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
4848
machine.openshift.io/cluster-api-machine-role: <role> 3
49-
machine.openshift.io/cluster-api-machine-type: <role> 3
50-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role> 2
49+
machine.openshift.io/cluster-api-machine-type: <role>
50+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
5151
spec:
5252
metadata:
5353
creationTimestamp: null
5454
labels:
55-
node-role.kubernetes.io/<role>: "" 3
55+
node-role.kubernetes.io/<role>: ""
5656
providerSpec:
5757
value:
5858
apiVersion: vsphereprovider.openshift.io/v1beta1

ocp-product-docs-plaintext/4.15/networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn.txt

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -551,19 +551,13 @@ Metrics are available to monitor the progress of the limited live migration. Met
551551
1. Enter the following command to generate a token for the prometheus-k8s service account in the openshift-monitoring namespace:
552552

553553
```terminal
554-
$ oc create token prometheus-k8s -n openshift-monitoring
555-
```
556-
557-
Example output
558-
559-
```terminal
560-
eyJhbGciOiJSUzI1NiIsImtpZCI6IlZiSUtwclcwbEJ2VW9We...
554+
$ token=`oc create token prometheus-k8s -n openshift-monitoring`
561555
```
562556

563557
2. Enter the following command to request information about the openshift_network_operator_live_migration_condition metric:
564558

565559
```terminal
566-
$ oc -n openshift-monitoring exec -c prometheus prometheus-k8s-0 -- curl -k -H "Authorization: <eyJhbGciOiJSUzI1NiIsImtpZCI6IlZiSUtwclcwbEJ2VW9We...>" "https://<openshift_API_endpoint>" --data-urlencode "query=openshift_network_operator_live_migration_condition" | jq
560+
$ oc -n openshift-monitoring exec -c prometheus prometheus-k8s-0 -- curl -k -H "Authorization: Bearer $token" 'https://thanos-querier.openshift-monitoring.svc:9091/api/v1/query?' --data-urlencode 'query=openshift_network_operator_live_migration_condition' | jq
567561
```
568562

569563
Example output

0 commit comments

Comments
 (0)