Skip to content

Commit 286454d

Browse files
committed
OSDOCS-3815: Updated text to cover PVs
1 parent 2edb33e commit 286454d

5 files changed

+36
-5
lines changed

modules/osd-create-cluster-ccs.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,14 @@ endif::osd-on-aws[]
151151
ifdef::osd-on-gcp[]
152152
encryption keys through the Google Cloud Key Management Service.
153153
endif::osd-on-gcp[]
154-
These keys are used for encrypting all control plane, infrastructure, and worker node root volumes.
154+
The key is used for encrypting all control plane, infrastructure, worker node root volumes, and persistent volumes in your cluster.
155+
+
156+
[IMPORTANT]
157+
====
158+
Only persistent volumes (PVs) created from the default storage class are encrypted with this specific key.
159+
160+
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.
161+
====
155162

156163
.. Click *Next*.
157164

modules/rosa-policy-security-regulation-compliance.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Red Hat defines and follows a data classification standard to determine the sens
1515

1616
[id="rosa-policy-data-management_{context}"]
1717
== Data management
18-
{product-title} (ROSA) uses AWS Key Management Service (KMS) to help securely manage keys for encrypted data. These keys are used for control plane data volumes that are encrypted by default.
18+
{product-title} (ROSA) uses AWS Key Management Service (KMS) to help securely manage keys for encrypted data. These keys are used for control plane data volumes that are encrypted by default. Persistent volumes (PVs) for customer applications also use AWS KMS for key management.
1919

2020
When a customer deletes their ROSA cluster, all cluster data is permanently deleted, including control plane data volumes and customer application data volumes, such as persistent volumes (PV).
2121

modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,15 @@ $ rosa create account-roles --mode manual <1>
4848
+
4949
.. After review, run the `aws` commands manually to create the roles and policies. Alternatively, you can run the preceding command using `--mode auto` to run the `aws` commands immediately.
5050

51-
. Optional: If you are using your own AWS KMS key to encrypt the control plane, infrastructure, and worker node root volumes, add the ARN for the account-wide installer role to your KMS key policy.
51+
. Optional: If you are using your own AWS KMS key to encrypt the control plane, infrastructure, worker node root volumes, and persistent volumes (PVs), add the ARN for the account-wide installer role to your KMS key policy.
52+
+
53+
[IMPORTANT]
54+
====
55+
Only persistent volumes (PVs) created from the default storage class are encrypted with this specific key.
56+
57+
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.
58+
====
59+
5260
.. Save the key policy for your KMS key to a file on your local machine. The following example saves the output to `kms-key-policy.json` in the current working directory:
5361
+
5462
[source,terminal]
@@ -183,7 +191,15 @@ I: To watch your cluster installation logs, run 'rosa logs install -c <cluster_n
183191
<2> If more than one matching set of account-wide roles are available in your account for a cluster version, an interactive list of options is provided.
184192
<3> Optional: By default, the cluster-specific Operator role names are prefixed with the cluster name and random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _Defining an Operator IAM role prefix_.
185193
<4> Multiple availability zones are recommended for production workloads. The default is a single availability zone.
186-
<5> Enable this option if you are using your own AWS KMS key to encrypt the control plane, infrastructure, and worker node root volumes. Specify the ARN for the KMS key that you added to the account-wide role ARN to in the preceding step.
194+
<5> Enable this option if you are using your own AWS KMS key to encrypt the control plane, infrastructure, worker node root volumes, and PVs. Specify the ARN for the KMS key that you added to the account-wide role ARN to in the preceding step.
195+
+
196+
[IMPORTANT]
197+
====
198+
Only persistent volumes (PVs) created from the default storage class are encrypted with this specific key.
199+
200+
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.
201+
====
202+
187203
<6> Enable this option only if your use case requires etcd key value encryption in addition to the control plane storage encryption that encrypts the etcd volumes by default. With this option, the etcd key values are encrypted, but not the keys.
188204
+
189205
[IMPORTANT]

modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,14 @@ rosa create cluster --sts
200200
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.
201201
====
202202
.. Optional: Select *Encrypt persistent volumes with customer keys* if you want to provide your own AWS Key Management Service (KMS) key Amazon Resource Name (ARN). The key is used for encryption of persistent volumes in your cluster.
203+
+
204+
[IMPORTANT]
205+
====
206+
Only persistent volumes (PVs) created from the default storage class are encrypted by default.
207+
208+
PVs created by using any other storage class are only encrypted if the the storage class is configured to be encrypted.
209+
====
210+
203211
.. Click *Next*.
204212

205213
. On the *Default machine pool* page, select a *Compute node instance type*.

modules/rosa-sts-interactive-mode-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You can create a {product-title} cluster with the AWS Security Token Service (ST
4242
|Install a cluster into an existing AWS VPC. To use this option, your VPC must have 2 subnets for each availability zone that you are installing the cluster into. The default is `No`.
4343

4444
|`Enable customer managed key`
45-
|Enable this option to use a specific AWS Key Management Service (KMS) key as the encryption key for persistent data. This key is used as the encryption key for control plane, infrastructure, and worker node root volumes. When disabled, the account KMS key for the specified region is used by default to ensure persistent data is always encrypted. The default is `No`.
45+
|Enable this option to use a specific AWS Key Management Service (KMS) key as the encryption key for persistent data. This key functions as the encryption key for control plane, infrastructure, and worker node root volumes. The key is also configured on the default storage class to ensure that persistent volumes created with the default storage class will be encrypted with the specific KMS key. When disabled, the account KMS key for the specified region is used by default to ensure persistent data is always encrypted. The default is `No`.
4646

4747
|`Compute nodes instance type`
4848
|Select a compute node instance type. The default is `m5.xlarge`.

0 commit comments

Comments
 (0)