Skip to content

Commit 5941432

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #53809 from jeana-redhat/OCPBUGS-3153-4.12-optional-crs
[OCPBUGS-3153]: Update ccoctl docs for optional components
2 parents 53572f8 + 2f78b84 commit 5941432

5 files changed

+123
-1
lines changed

‎modules/cco-ccoctl-creating-at-once.adoc

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,71 @@ endif::alibabacloud-default,alibabacloud-customizations[]
9696
This command can take a few moments to run.
9797
====
9898

99+
ifdef::aws-sts[]
100+
. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
101+
+
102+
.Example `credrequests` directory contents for {product-title} 4.12 on AWS
103+
+
104+
[source,terminal]
105+
----
106+
0000_30_machine-api-operator_00_credentials-request.yaml <1>
107+
0000_50_cloud-credential-operator_05-iam-ro-credentialsrequest.yaml <2>
108+
0000_50_cluster-image-registry-operator_01-registry-credentials-request.yaml <3>
109+
0000_50_cluster-ingress-operator_00-ingress-credentials-request.yaml <4>
110+
0000_50_cluster-network-operator_02-cncc-credentials.yaml <5>
111+
0000_50_cluster-storage-operator_03_credentials_request_aws.yaml <6>
112+
----
113+
+
114+
<1> The Machine API Operator CR is required.
115+
<2> The Cloud Credential Operator CR is required.
116+
<3> The Image Registry Operator CR is required.
117+
<4> The Ingress Operator CR is required.
118+
<5> The Network Operator CR is required.
119+
<6> The Storage Operator CR is an optional component and might be disabled in your cluster.
120+
endif::aws-sts[]
121+
ifdef::google-cloud-platform[]
122+
. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
123+
+
124+
.Example `credrequests` directory contents for {product-title} 4.12 on GCP
125+
+
126+
[source,terminal]
127+
----
128+
0000_26_cloud-controller-manager-operator_16_credentialsrequest-gcp.yaml <1>
129+
0000_30_machine-api-operator_00_credentials-request.yaml <2>
130+
0000_50_cloud-credential-operator_05-gcp-ro-credentialsrequest.yaml <3>
131+
0000_50_cluster-image-registry-operator_01-registry-credentials-request-gcs.yaml <4>
132+
0000_50_cluster-ingress-operator_00-ingress-credentials-request.yaml <5>
133+
0000_50_cluster-network-operator_02-cncc-credentials.yaml <6>
134+
0000_50_cluster-storage-operator_03_credentials_request_gcp.yaml <7>
135+
----
136+
+
137+
<1> The Cloud Controller Manager Operator CR is required.
138+
<2> The Machine API Operator CR is required.
139+
<3> The Cloud Credential Operator CR is required.
140+
<4> The Image Registry Operator CR is required.
141+
<5> The Ingress Operator CR is required.
142+
<6> The Network Operator CR is required.
143+
<7> The Storage Operator CR is an optional component and might be disabled in your cluster.
144+
endif::google-cloud-platform[]
145+
ifdef::alibabacloud-default,alibabacloud-customizations[]
146+
. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
147+
+
148+
.Example `credrequests` directory contents for {product-title} 4.12 on Alibaba Cloud
149+
+
150+
[source,terminal]
151+
----
152+
0000_30_machine-api-operator_00_credentials-request.yaml <1>
153+
0000_50_cluster-image-registry-operator_01-registry-credentials-request-alibaba.yaml <2>
154+
0000_50_cluster-ingress-operator_00-ingress-credentials-request.yaml <3>
155+
0000_50_cluster-storage-operator_03_credentials_request_alibaba.yaml <4>
156+
----
157+
+
158+
<1> The Machine API Operator CR is required.
159+
<2> The Image Registry Operator CR is required.
160+
<3> The Ingress Operator CR is required.
161+
<4> The Storage Operator CR is an optional component and might be disabled in your cluster.
162+
endif::alibabacloud-default,alibabacloud-customizations[]
163+
99164
ifdef::aws-sts,google-cloud-platform[]
100165
. Use the `ccoctl` tool to process all `CredentialsRequest` objects in the `credrequests` directory:
101166
+

‎modules/cco-ccoctl-creating-individually.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,27 @@ $ oc adm release extract --credentials-requests \
9393
+
9494
<1> `credrequests` is the directory where the list of `CredentialsRequest` objects is stored. This command creates the directory if it does not exist.
9595

96+
.. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
97+
+
98+
.Example `credrequests` directory contents for {product-title} 4.12 on AWS
99+
+
100+
[source,terminal]
101+
----
102+
0000_30_machine-api-operator_00_credentials-request.yaml <1>
103+
0000_50_cloud-credential-operator_05-iam-ro-credentialsrequest.yaml <2>
104+
0000_50_cluster-image-registry-operator_01-registry-credentials-request.yaml <3>
105+
0000_50_cluster-ingress-operator_00-ingress-credentials-request.yaml <4>
106+
0000_50_cluster-network-operator_02-cncc-credentials.yaml <5>
107+
0000_50_cluster-storage-operator_03_credentials_request_aws.yaml <6>
108+
----
109+
+
110+
<1> The Machine API Operator CR is required.
111+
<2> The Cloud Credential Operator CR is required.
112+
<3> The Image Registry Operator CR is required.
113+
<4> The Ingress Operator CR is required.
114+
<5> The Network Operator CR is required.
115+
<6> The Storage Operator CR is an optional component and might be disabled in your cluster.
116+
96117
.. Use the `ccoctl` tool to process all `CredentialsRequest` objects in the `credrequests` directory:
97118
+
98119
[source,terminal]

‎modules/manually-configure-iam-nutanix.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,17 @@ quay.io/<path_to>/ocp-release:<version>
6868
namespace: openshift-machine-api
6969
----
7070
71+
. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
72+
+
73+
.Example `credrequests` directory contents for {product-title} 4.12 on Nutanix
74+
+
75+
[source,terminal]
76+
----
77+
0000_30_machine-api-operator_00_credentials-request.yaml <1>
78+
----
79+
+
80+
<1> The Machine API Operator CR is required.
81+
7182
. Use the `ccoctl` tool to process all of the `CredentialsRequest` objects in the `credrequests` directory by running the following command:
7283
+
7384
[source,terminal]

‎modules/manually-create-iam-ibm-cloud.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,24 @@ This command creates a YAML file for each `CredentialsRequest` object.
109109
- crn:v1:bluemix:public:iam::::role:Viewer
110110
----
111111
112+
. If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
113+
+
114+
.Example `credrequests` directory contents for {product-title} 4.12 on IBM Cloud VPC
115+
+
116+
[source,terminal]
117+
----
118+
0000_26_cloud-controller-manager-operator_15_credentialsrequest-ibm.yaml <1>
119+
0000_30_machine-api-operator_00_credentials-request.yaml <2>
120+
0000_50_cluster-image-registry-operator_01-registry-credentials-request-ibmcos.yaml <3>
121+
0000_50_cluster-ingress-operator_00-ingress-credentials-request.yaml <4>
122+
0000_50_cluster-storage-operator_03_credentials_request_ibm.yaml <5>
123+
----
124+
<1> The Cloud Controller Manager Operator CR is required.
125+
<2> The Machine API Operator CR is required.
126+
<3> The Image Registry Operator CR is required.
127+
<4> The Ingress Operator CR is required.
128+
<5> The Storage Operator CR is an optional component and might be disabled in your cluster.
129+
112130
. Create the service ID for each credential request, assign the policies defined, create an API key in IBM Cloud VPC, and generate the secret:
113131
+
114132
[source,terminal]

‎modules/manually-maintained-credentials-upgrade.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ The "Manually creating IAM" section of the installation content for your cloud p
3737

3838

3939
. Update the manually maintained credentials on your cluster:
40-
40+
+
41+
--
4142
** Create new secrets for any `CredentialsRequest` custom resources that are added by the new release image.
4243
ifndef::ibm-cloud[]
4344
** If the `CredentialsRequest` custom resources for any existing credentials that are stored in secrets have changed their permissions requirements, update the permissions as required.
@@ -47,6 +48,12 @@ ifdef::ibm-cloud[]
4748
+
4849
The "Manually creating IAM for IBM Cloud" section of the installation content for IBM Cloud explains how to use the `ccoctl` utility to create new service IDs.
4950
endif::ibm-cloud[]
51+
--
52+
+
53+
[NOTE]
54+
====
55+
If your cluster uses cluster capabilities to disable one or more optional components, delete the `CredentialsRequest` custom resources for any disabled components.
56+
====
5057

5158
. When all of the secrets are correct for the new release, indicate that the cluster is ready to upgrade:
5259

0 commit comments

Comments
 (0)