Skip to content

Commit 2877594

Browse files
authored
Merge pull request #68003 from mletalie/OSDOCS-8739
[OSDOCS- 8739]/[OSDOCS-7754] Updating "Creating a cluster on GCP with CCS" and "Creating a cluster on GCP with Google Cloud Marketplace" Docs
2 parents 7c9bb17 + 871a488 commit 2877594

File tree

3 files changed

+117
-16
lines changed

3 files changed

+117
-16
lines changed

modules/deleting-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ You can delete your {product-title} cluster in {cluster-manager-first}.
2222
+
2323
[NOTE]
2424
====
25-
If you delete a cluster that was installed into a GCP Shared VPC, inform the Shared VPC Admin of the host project to remove the IAM policy roles granted to the service account that was referenced during cluster creation.
25+
If you delete a cluster that was installed into a GCP Shared VPC, inform the VPC owner of the host project to remove the IAM policy roles granted to the service account that was referenced during cluster creation.
2626
====

modules/osd-create-cluster-ccs.adoc

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -135,19 +135,40 @@ endif::osd-on-gcp[]
135135
.. Select a cloud provider region from the *Region* drop-down menu.
136136
.. Select a *Single zone* or *Multi-zone* configuration.
137137
.. Leave *Enable user workload monitoring* selected to monitor your own projects in isolation from Red Hat Site Reliability Engineer (SRE) platform metrics. This option is enabled by default.
138+
ifdef::osd-on-gcp[]
139+
. Optional: Expand *Advanced Encryption* to make changes to encryption settings.
140+
141+
.. Select *Use Custom KMS keys* to use custom KMS keys. If you prefer not to use custom KMS keys, leave the default setting *Use default KMS Keys*.
142+
+
143+
[IMPORTANT]
144+
====
145+
To use custom KMS keys, the IAM service account `osd-ccs-admin` must be granted the *Cloud KMS CryptoKey Encrypter/Decrypter* role. For more information about granting roles on a resource, see link:https://cloud.google.com/kms/docs/iam#granting_roles_on_a_resource[Granting roles on a resource].
146+
====
147+
+
148+
With *Use Custom KMS keys* selected:
149+
150+
... Select a key ring location from the *Key ring location* drop-down menu.
151+
... Select a key ring from the *Key ring* drop-down menu.
152+
... Select a key name from the *Key name* drop-down menu.
153+
... Provide the *KMS Service Account*.
154+
+
155+
endif::osd-on-gcp[]
138156
.. Optional: Select *Enable additional etcd encryption* if you require etcd key value encryption. With this option, the etcd key values are encrypted, but not the keys. This option is in addition to the control plane storage encryption that encrypts the etcd volumes in {product-title} clusters by default.
139157
+
140158
[NOTE]
141159
====
142160
By enabling etcd encryption for the key values in etcd, you will incur a performance overhead of approximately 20%. The overhead is a result of introducing this second layer of encryption, in addition to the default control plane storage encryption that encrypts the etcd volumes. Consider enabling etcd encryption only if you specifically require it for your use case.
143161
====
144-
.. Optional: Select *Encrypt persistent volumes with customer keys* if you want to provide your own
145-
ifdef::osd-on-aws[]
146-
AWS Key Management Service (KMS) key Amazon Resource Name (ARN).
147-
endif::osd-on-aws[]
162+
+
148163
ifdef::osd-on-gcp[]
149-
encryption keys through the Google Cloud Key Management Service.
164+
.. Optional: Select *Enable FIPS cryptography* if you require your cluster to be FIPS validated.
150165
endif::osd-on-gcp[]
166+
ifdef::osd-on-aws[]
167+
.. Optional: Select *Encrypt persistent volumes with customer keys* if you want to provide your own
168+
AWS Key Management Service (KMS) key Amazon Resource Name (ARN).
169+
// ifdef::osd-on-gcp[]
170+
// encryption keys through the Google Cloud Key Management Service.
171+
// endif::osd-on-gcp[]
151172
The key is used for encrypting all control plane, infrastructure, worker node root volumes, and persistent volumes in your cluster.
152173
+
153174
[IMPORTANT]
@@ -156,7 +177,7 @@ Only persistent volumes (PVs) created from the default storage class are encrypt
156177

157178
PVs created by using any other storage class are still encrypted, but the PVs are not encrypted with this key unless the storage class is specifically configured to use this key.
158179
====
159-
180+
endif::osd-on-aws[]
160181
.. Click *Next*.
161182

162183
. 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.
@@ -221,16 +242,16 @@ ifdef::osd-on-gcp[]
221242
[IMPORTANT]
222243
====
223244

224-
To install a cluster into a Shared VPC, you must use {product-title} version 4.13.15 or above. Additionally, the Shared VPC Admin must enable a project as a host project in their Google Cloud console. For more information, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#set-up-shared-vpc[Enable a host project].
245+
To install a cluster into a Shared VPC, you must use {product-title} version 4.13.15 or above. Additionally, the VPC owner of the host project must enable a project as a host project in their Google Cloud console. For more information, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#set-up-shared-vpc[Enable a host project].
225246
====
226247

227248
.. Select *Install into GCP Shared VPC*.
228249
.. Specify the *Host project ID*. If the specified host project ID is incorrect, cluster creation fails.
229250
+
230251
[IMPORTANT]
231252
====
232-
Once you complete the steps within the cluster configuration wizard and click *Create Cluster*, the cluster will go into the "Installation Waiting" state. At this point, you must contact the Shared VPC Admin of the host project, who must assign the dynamically-generated service account the following roles: *Computer Network Administrator*, *Compute Security Administrator*, and *DNS Administrator*.
233-
The Shared VPC Admin of the host project has 30 days to grant the listed permissions before the cluster creation fails.
253+
Once you complete the steps within the cluster configuration wizard and click *Create Cluster*, the cluster will go into the "Installation Waiting" state. At this point, you must contact the VPC owner of the host project, who must assign the dynamically-generated service account the following roles: *Computer Network Administrator*, *Compute Security Administrator*, and *DNS Administrator*.
254+
The VPC owner of the host project has 30 days to grant the listed permissions before the cluster creation fails.
234255
For information about Shared VPC permissions, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#migs-service-accounts[Provision Shared VPC].
235256
====
236257
endif::osd-on-gcp[]
@@ -318,7 +339,7 @@ In the event of critical security concerns that significantly impact the securit
318339
ifdef::osd-on-gcp[]
319340
[NOTE]
320341
====
321-
If you delete a cluster that was installed into a GCP Shared VPC, inform the Shared VPC Admin of the host project to remove the IAM policy roles granted to the service account that was referenced during cluster creation.
342+
If you delete a cluster that was installed into a GCP Shared VPC, inform the VPC owner of the host project to remove the IAM policy roles granted to the service account that was referenced during cluster creation.
322343
====
323344
endif::osd-on-gcp[]
324345

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

Lines changed: 85 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,36 @@ For more information about service account keys, click the information icon loca
3434
.. Select a cluster version from the *Version* drop-down menu.
3535
.. Select a cloud provider region from the *Region* drop-down menu.
3636
.. Select a *Single zone* or *Multi-zone* configuration.
37-
.. Select a *Persistent storage* capacity for the cluster. For more information, see the _Storage_ section in the {product-title} service definition.
38-
.. Specify the number of *Load balancers* that you require for your cluster. For more information, see the _Load balancers_ section in the {product-title} service definition.
3937
.. Leave *Enable user workload monitoring* selected to monitor your own projects in isolation from Red Hat Site Reliability Engineer (SRE) platform metrics. This option is enabled by default.
40-
.. Optional: Select *Enable additional etcd encryption* if you require etcd key value encryption. With this option, the etcd key values are encrypted, but not the keys. This option is in addition to the control plane storage encryption that encrypts the etcd volumes in {product-title} clusters by default.
38+
39+
. Optional: Expand *Advanced Encryption* to make changes to encryption settings.
40+
41+
.. Select *Use Custom KMS keys* to use custom KMS keys. If you prefer not to use custom KMS keys, leave the default setting *Use default KMS Keys*.
42+
+
43+
[IMPORTANT]
44+
====
45+
To use custom KMS keys, the IAM service account `osd-ccs-admin` must be granted the *Cloud KMS CryptoKey Encrypter/Decrypter* role. For more information about granting roles on a resource, see link:https://cloud.google.com/kms/docs/iam#granting_roles_on_a_resource[Granting roles on a resource].
46+
====
47+
+
48+
With *Use Custom KMS keys* selected:
49+
50+
... Select a key ring location from the *Key ring location* drop-down menu.
51+
... Select a key ring from the *Key ring* drop-down menu.
52+
... Select a key name from the *Key name* drop-down menu.
53+
... Provide the *KMS Service Account*.
54+
55+
+
56+
.. Optional: Select *Enable additional etcd encryption* if you require etcd key value encryption.
57+
With this option, the etcd key values are encrypted, but not the keys. This option is in addition to the control plane storage encryption that encrypts the etcd volumes in {product-title} clusters by default.
4158
+
4259
[NOTE]
4360
====
4461
By enabling etcd encryption for the key values in etcd, you incur a performance overhead of approximately 20%. The overhead is a result of introducing this second layer of encryption, in addition to the default control plane storage encryption that encrypts the etcd volumes. Consider enabling etcd encryption only if you specifically require it for your use case.
4562
====
46-
.. Click *Next*.
63+
+
64+
.. Optional: Select *Enable FIPS cryptography* if you require your cluster to be FIPS validated.
65+
+
66+
. Click *Next*.
4767

4868
. 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.
4969
+
@@ -52,12 +72,72 @@ By enabling etcd encryption for the key values in etcd, you incur a performance
5272
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.
5373
====
5474

55-
. Optional: Expand *Edit node labels* to add labels to your nodes. Click *Add label* to add more node labels and select *Next*.
75+
. Optional: Expand *Add node labels* to add labels to your nodes. Click *Add additional label* to add more node labels.
76+
77+
. Click *Next*.
5678

5779
. In the *Cluster privacy* dialog, select *Public* or *Private* to use either public or private API endpoints and application routes for your cluster.
80+
+
81+
. Optional: To install the cluster in an existing GCP Virtual Private Cloud (VPC):
82+
.. Select *Install into an existing VPC*.
83+
.. If you are installing into an existing VPC and you want to enable an HTTP or HTTPS proxy for your cluster, select *Configure a cluster-wide proxy*.
84+
85+
+
86+
. Click *Next*.
87+
+
88+
89+
. Optional: To install the cluster into a GCP Shared VPC:
90+
+
91+
[IMPORTANT]
92+
====
5893

94+
To install a cluster into a Shared VPC, you must use {product-title} version 4.13.15 or above. Additionally, the VPC owner of the host project must enable a project as a host project in their Google Cloud console. For more information, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#set-up-shared-vpc[Enable a host project].
95+
====
96+
97+
.. Select *Install into GCP Shared VPC*.
98+
.. Specify the *Host project ID*. If the specified host project ID is incorrect, cluster creation fails.
99+
+
100+
[IMPORTANT]
101+
====
102+
Once you complete the steps within the cluster configuration wizard and click *Create Cluster*, the cluster will go into the "Installation Waiting" state. At this point, you must contact the VPC owner of the host project, who must assign the dynamically-generated service account the following roles: *Computer Network Administrator*, *Compute Security Administrator*, and *DNS Administrator*.
103+
The VPC owner of the host project has 30 days to grant the listed permissions before the cluster creation fails.
104+
For information about Shared VPC permissions, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#migs-service-accounts[Provision Shared VPC].
105+
====
106+
+
107+
. If you opted to install the cluster in an existing GCP VPC, provide your *Virtual Private Cloud (VPC) subnet settings* and select *Next*.
108+
You must have created the Cloud network address translation (NAT) and a Cloud router. See the additional resources for information about Cloud NATs and Google VPCs.
109+
+
110+
[NOTE]
111+
====
112+
You must ensure that your VPC is configured with a public and a private subnet for each availability zone that you want the cluster installed into. If you opted to use PrivateLink, only private subnets are required.
113+
====
114+
+
115+
[NOTE]
116+
====
117+
If you are installing a cluster into a Shared VPC, the VPC name and subnets are shared from the host project.
118+
====
119+
+
59120
. Click *Next*.
121+
. If you opted to configure a cluster-wide proxy, provide your proxy configuration details on the *Cluster-wide proxy* page:
122+
+
123+
--
124+
.. Enter a value in at least one of the following fields:
125+
** Specify a valid *HTTP proxy URL*.
126+
** Specify a valid *HTTPS proxy URL*.
127+
** In the *Additional trust bundle* field, provide a PEM encoded X.509 certificate bundle. The bundle is added to the trusted certificate store for the cluster nodes. An additional trust bundle file is required unless the identity certificate for the proxy is signed by an authority from the {op-system-first} trust bundle.
128+
+
129+
If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional certificate authorities (CAs), you must provide the MITM CA certificate.
130+
+
131+
[NOTE]
132+
====
133+
If you upload an additional trust bundle file without specifying an HTTP or HTTPS proxy URL, the bundle is set on the cluster but is not configured to be used with the proxy.
134+
====
135+
.. Click *Next*.
136+
--
137+
+
138+
For more information about configuring a proxy with {product-title}, see _Configuring a cluster-wide proxy_.
60139

140+
+
61141
. In the *CIDR ranges* dialog, configure custom classless inter-domain routing (CIDR) ranges or use the defaults that are provided.
62142
+
63143
[IMPORTANT]

0 commit comments

Comments
 (0)