Skip to content

Commit 0ed76ca

Browse files
AedinCAedinC
committed
OSDOCS-12297:Added WIF as auth type in create cluster on GCP workflow.
1 parent 7a66c09 commit 0ed76ca

File tree

3 files changed

+103
-19
lines changed

3 files changed

+103
-19
lines changed

‎modules/osd-create-cluster-ccs.adoc

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,17 @@ ifdef::osd-on-aws[]
101101
endif::osd-on-aws[]
102102
ifdef::osd-on-gcp[]
103103
. Select *Run on Google Cloud Platform*.
104+
. Select either *Service account* or *Workload Identity Federation* as the Authentication type.
105+
+
106+
[NOTE]
107+
====
108+
For more information about authentication types, click the question icon located next to *Authentication type*.
109+
====
110+
+
104111
endif::osd-on-gcp[]
105112

106-
. After selecting your cloud provider, review and complete the listed *Prerequisites*. Select the checkbox to acknowledge that you have read and completed all of the prerequisites.
107-
113+
. Review and complete the listed *Prerequisites*.
114+
. Select the checkbox to acknowledge that you have read and completed all of the prerequisites.
108115
ifdef::osd-on-aws[]
109116
. Provide your AWS account details:
110117
.. Enter your *AWS account ID*.
@@ -122,7 +129,19 @@ Some AWS SCPs can cause the installation to fail, even if you have the required
122129
====
123130
endif::osd-on-aws[]
124131
ifdef::osd-on-gcp[]
125-
. Provide your GCP service account private key in JSON format. You can either click *Browse* to locate and attach a JSON file or add the details in the *Service account JSON* field.
132+
. If you selected *Service account* as the Authentication type, provide your GCP service account private key in JSON format. You can either click *Browse* to locate and attach a JSON file or add the details in the *Service account JSON* field.
133+
. If you selected *Workload Identity Federation* as the Authentication type, you will first need to create a new WIF configuration.
134+
Open a terminal window and run the following `ocm` CLI command.
135+
+
136+
[source,terminal]
137+
----
138+
$ ocm gcp create wif-config --name <wif_name> \ <1>
139+
--project <gcp_project_id> <2>
140+
----
141+
<1> Replace `<wif_name>` with the name of your WIF configuration.
142+
<2> Replace `<gcp_project_id>` with the ID of the {GCP} project where the WIF configuration will be implemented.
143+
144+
. Select a configured WIF configuration from the *WIF configuration* drop-down list. If you want to select the WIF configuration you created in the last step, click *Refresh* first.
126145
endif::osd-on-gcp[]
127146

128147
. Click *Next* to validate your cloud provider account and go to the *Cluster details* page.
@@ -133,6 +152,14 @@ endif::osd-on-gcp[]
133152
+
134153
To customize the subdomain, select the *Create customize domain prefix* checkbox, and enter your domain prefix name in the *Domain prefix* field. The domain prefix cannot be longer than 15 characters, must be unique within your organization, and cannot be changed after cluster creation.
135154
.. Select a cluster version from the *Version* drop-down menu.
155+
ifdef::osd-on-gcp[]
156+
+
157+
[NOTE]
158+
====
159+
Workload Identity Federation (WIF) is only supported on {product-title} version 4.17 and later.
160+
====
161+
+
162+
endif::osd-on-gcp[]
136163
.. Select a cloud provider region from the *Region* drop-down menu.
137164
.. Select a *Single zone* or *Multi-zone* configuration.
138165
+
@@ -218,7 +245,14 @@ For more information regarding IMDS, see link:https://docs.aws.amazon.com/AWSEC2
218245
endif::osd-on-aws[]
219246

220247
. Optional: Expand *Edit node labels* to add labels to your nodes. Click *Add label* to add more node labels and select *Next*.
221-
248+
ifdef::osd-on-gcp[]
249+
+
250+
[IMPORTANT]
251+
====
252+
This step refers to labels within Kubernetes, not Google Cloud. For more information regarding Kubernetes labels, see link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors].
253+
====
254+
+
255+
endif::osd-on-gcp[]
222256
. On the *Network configuration* page, select *Public* or *Private* to use either public or private API endpoints and application routes for your cluster.
223257
+
224258
[IMPORTANT]

‎modules/osd-create-cluster-gcp-account.adoc

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,42 @@ When creating an {product-title} (OSD) cluster on Google Cloud through the OpenS
1919
.. From the drop-down menu, select *Google Cloud Marketplace*.
2020
.. Select the *Customer Cloud Subscription* infrastructure type.
2121
.. Click *Next*.
22-
. On the *Cloud provider* page, read the provided prerequisites and the Google terms and conditions. Add your service account key.
23-
.. Click the *Review Google Terms and Agreements* link.
24-
.. To continue creating the cluster, click the checkbox indicating that you agree to the Google terms and agreements.
25-
.. Add your service account key.
22+
. On the *Cloud provider* page, select *Run on Google Cloud Platform*.
23+
. Select either *Service account* or *Workload Identity Federation* as the Authentication type.
2624
+
2725
[NOTE]
2826
====
29-
For more information about service account keys, click the information icon located next to *Service account key*.
27+
For more information about authentication types, click the question icon located next to *Authentication type*.
3028
====
31-
.. Click *Next* to validate your cloud provider account and go to the *Cluster details* page.
29+
+
30+
. Review and complete the listed *Prerequisites*.
31+
. Select the checkbox to acknowledge that you have read and completed all of the prerequisites.
32+
. If you selected *Service account* as the Authentication type, provide your GCP service account private key in JSON format. You can either click *Browse* to locate and attach a JSON file or add the details in the *Service account JSON* field.
33+
. If you selected *Workload Identity Federation* as the Authentication type, you will first need to create a new WIF configuration.
34+
Open a terminal window and run the following `ocm` CLI command.
35+
+
36+
[source,terminal]
37+
----
38+
$ ocm gcp create wif-config --name <wif_name> \ <1>
39+
--project <gcp_project_id> <2>
40+
----
41+
<1> Replace `<wif_name>` with the name of your WIF configuration.
42+
<2> Replace `<gcp_project_id>` with the ID of the {GCP} project where the WIF configuration will be implemented.
43+
+
44+
. Select a configured WIF configuration from the *WIF configuration* drop-down list. If you want to select the WIF configuration you created in the last step, click *Refresh* first.
45+
. Click *Next* to validate your cloud provider account and go to the *Cluster details* page.
3246
. On the *Cluster details* page, provide a name for your cluster and specify the cluster details:
3347
.. Add a *Cluster name*.
3448
.. Optional: Cluster creation generates a domain prefix as a subdomain for your provisioned cluster on `openshiftapps.com`. If the cluster name is less than or equal to 15 characters, that name is used for the domain prefix. If the cluster name is longer than 15 characters, the domain prefix is randomly generated as a 15-character string.
3549
+
3650
To customize the subdomain, select the *Create custom domain prefix* checkbox, and enter your domain prefix name in the *Domain prefix* field. The domain prefix cannot be longer than 15 characters, must be unique within your organization, and cannot be changed after cluster creation.
3751
.. Select a cluster version from the *Version* drop-down menu.
52+
+
53+
[NOTE]
54+
====
55+
Workload Identity Federation (WIF) is only supported on {product-title} version 4.17 and later.
56+
====
57+
+
3858
.. Select a cloud provider region from the *Region* drop-down menu.
3959
.. Select a *Single zone* or *Multi-zone* configuration.
4060
+
@@ -79,15 +99,20 @@ By enabling etcd encryption for the key values in etcd, you incur a performance
7999
+
80100
. Click *Next*.
81101

82-
. On the *Machine pool* page, select a *Compute node instance type* and a *Compute node count*. The number and types of nodes that are available depend on your {product-title} subscription. If you are using multiple availability zones, the compute node count is per zone.
102+
. On the *Dafault machine pool* page, select a *Compute node instance type* and a *Compute node count*. The number and types of nodes that are available depend on your {product-title} subscription. If you are using multiple availability zones, the compute node count is per zone.
83103
+
84104
[NOTE]
85105
====
86106
After your cluster is created, you can change the number of compute nodes, but you cannot change the compute node instance type in a created machine pool. You can add machine pools after installation that use a customized instance type. The number and types of nodes available to you depend on your {product-title} subscription.
87107
====
88108

89109
. Optional: Expand *Add node labels* to add labels to your nodes. Click *Add additional label* to add more node labels.
90-
110+
+
111+
[IMPORTANT]
112+
====
113+
This step refers to labels within Kubernetes, not Google Cloud. For more information regarding Kubernetes labels, see link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors].
114+
====
115+
+
91116
. Click *Next*.
92117

93118
. In the *Cluster privacy* dialog, select *Public* or *Private* to use either public or private API endpoints and application routes for your cluster.

‎modules/osd-create-cluster-rhm-gcp-account.adoc

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,42 @@ OSD pricing is consumption-based and customers are billed directly through their
1919
.. Select the *On-Demand* subscription type.
2020
.. From the drop-down menu, select *Red Hat Marketplace*.
2121
.. Click *Next*.
22-
. On the *Cloud provider* page:
23-
.. Select *Google Cloud* as your cloud provider.
24-
.. Click the checkbox indicating that you have read and completed all the prerequisites necessary to continue creating your cluster.
25-
.. Add your service account key.
22+
. On the *Cloud provider* page, select *Run on Google Cloud Platform*.
23+
. Select either *Service account* or *Workload Identity Federation* as the Authentication type.
2624
+
2725
[NOTE]
2826
====
29-
For more information about service account keys, click the information icon located next to *Service account key*.
27+
For more information about authentication types, click the question icon located next to *Authentication type*.
3028
====
29+
+
30+
. Review and complete the listed *Prerequisites*.
31+
. Select the checkbox to acknowledge that you have read and completed all of the prerequisites.
32+
. If you selected *Service account* as the Authentication type, provide your GCP service account private key in JSON format. You can either click *Browse* to locate and attach a JSON file or add the details in the *Service account JSON* field.
33+
. If you selected *Workload Identity Federation* as the Authentication type, you will first need to create a new WIF configuration.
34+
Open a terminal window and run the following `ocm` CLI command.
35+
+
36+
[source,terminal]
37+
----
38+
$ ocm gcp create wif-config --name <wif_name> \ <1>
39+
--project <gcp_project_id> <2>
40+
----
41+
<1> Replace `<wif_name>` with the name of your WIF configuration.
42+
<2> Replace `<gcp_project_id>` with the ID of the {GCP} project where the WIF configuration will be implemented.
43+
+
44+
. Select a configured WIF configuration from the *WIF configuration* drop-down list. If you want to select the WIF configuration you created in the last step, click *Refresh* first.
3145
.. Click *Next* to validate your cloud provider account and go to the *Cluster details* page.
3246
. On the *Cluster details* page, provide a name for your cluster and specify the cluster details:
3347
.. Add a *Cluster name*.
3448
.. Optional: Cluster creation generates a domain prefix as a subdomain for your provisioned cluster on `openshiftapps.com`. If the cluster name is less than or equal to 15 characters, that name is used for the domain prefix. If the cluster name is longer than 15 characters, the domain prefix is randomly generated as a 15-character string.
3549
+
3650
To customize the subdomain, select the *Create custom domain prefix* checkbox, and enter your domain prefix name in the *Domain prefix* field. The domain prefix cannot be longer than 15 characters, must be unique within your organization, and cannot be changed after cluster creation.
3751
.. Select a cluster version from the *Version* drop-down menu.
52+
+
53+
[NOTE]
54+
====
55+
Workload Identity Federation (WIF) is only supported on {product-title} version 4.17 and later.
56+
====
57+
+
3858
.. Select a cloud provider region from the *Region* drop-down menu.
3959
.. Select a *Single zone* or *Multi-zone* configuration.
4060
+
@@ -79,15 +99,20 @@ By enabling etcd encryption for the key values in etcd, you incur a performance
7999
+
80100
. Click *Next*.
81101

82-
. On the *Machine pool* page, select a *Compute node instance type* and a *Compute node count*. The number and types of nodes that are available depend on your {product-title} subscription. If you are using multiple availability zones, the compute node count is per zone.
102+
. On the *Default machine pool* page, select a *Compute node instance type* and a *Compute node count*. The number and types of nodes that are available depend on your {product-title} subscription. If you are using multiple availability zones, the compute node count is per zone.
83103
+
84104
[NOTE]
85105
====
86106
After your cluster is created, you can change the number of compute nodes, but you cannot change the compute node instance type in a created machine pool. You can add machine pools after installation that use a customized instance type. The number and types of nodes available to you depend on your {product-title} subscription.
87107
====
88108

89109
. Optional: Expand *Add node labels* to add labels to your nodes. Click *Add additional label* to add more node labels.
90-
110+
+
111+
[IMPORTANT]
112+
====
113+
This step refers to labels within Kubernetes, not Google Cloud. For more information regarding Kubernetes labels, see link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors].
114+
====
115+
+
91116
. Click *Next*.
92117

93118
. In the *Cluster privacy* dialog, select *Public* or *Private* to use either public or private API endpoints and application routes for your cluster.

0 commit comments

Comments
 (0)