Skip to content

Commit 1212a5d

Browse files
authored
Merge pull request #44392 from bmcelvee/OSDOCS-3500
OSDOCS-3500: ROSA/OSD: Correct docs to say that customer KMS key only encrypts data volume
2 parents e150ee9 + b0684ab commit 1212a5d

5 files changed

+9
-8
lines changed

modules/osd-create-cluster-ccs.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ 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-
The key is used for encryption of persistent volumes in your cluster.
154+
These keys are used for encrypting all control plane, infrastructure, and worker node root volumes.
155+
155156
.. Click *Next*.
156157

157158
. 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.

modules/policy-security-regulation-compliance.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Red Hat defines and follows a data classification standard to determine the sens
1414

1515
[id="data-management_{context}"]
1616
== Data management
17-
{product-title} uses cloud provider services to help securely manage keys for encrypted data (AWS KMS and Google Cloud KMS). These keys are used for control plane data volumes which are encrypted by default. Persistent volumes for customer applications also use these cloud services for key management.
17+
{product-title} uses cloud provider services such as AWS Key Management Service (KMS) and Google Cloud KMS to help securely manage encryption keys for persistent data. These keys are used for encrypting all control plane, infrastructure, and worker node root volumes. Customers can specify their own KMS key for encrypting root volumes at installation time. Persistent volumes (PVs) also use KMS for key management. Customers can specify their own KMS key for encrypting PVs by creating a new `StorageClass` referencing the KMS key Amazon Resource Name (ARN) or ID.
1818

19-
When a customer deletes their {product-title} cluster, all cluster data is permanently deleted, including control plane data volumes, customer application data volumes (PVs), and backup data.
19+
When a customer deletes their {product-title} cluster, all cluster data is permanently deleted, including control plane data volumes and customer application data volumes, such a persistent volumes (PV).
2020

2121
[id="vulnerability-management_{context}"]
2222
== Vulnerability management

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ 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 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.
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.
1919

20-
When a customer deletes their ROSA cluster, all cluster data is permanently deleted, including control plane data volumes, customer application data volumes, such as PVs, and backup data.
20+
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

2222
[id="rosa-policy-vulnerability-management_{context}"]
2323
== Vulnerability management

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ rosa create account-roles --mode manual <1>
4949
+
5050
.. 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.
5151

52-
. (Optional) If you are using your own AWS KMS key to encrypt the control plane data volumes and the persistent volumes (PVs) for your applications, add the ARN for the account-wide installer role to your KMS key policy.
52+
. 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.
5353
.. 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:
5454
+
5555
[source,terminal]
@@ -143,7 +143,7 @@ I: To watch your cluster installation logs, run 'rosa logs install -c <cluster_n
143143
<1> When creating the cluster, the listed `OpenShift version` options include the major, minor, and patch versions, for example `4.8.9`.
144144
<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.
145145
<3> Multiple availability zones are recommended for production workloads. The default is a single availability zone.
146-
<4> Enable this option if you are using your own AWS KMS key to encrypt the control plane data volumes and the PVs for your applications. Specify the ARN for the KMS key that you added the account-wide role ARN to in the preceding step.
146+
<4> 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.
147147
<5> 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.
148148
+
149149
[IMPORTANT]

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 the AWS Key Management Service (KMS) to help securely manage keys for encrypted data. The 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. When enabled, the account KMS key for the region is used by default. 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 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`.
4646

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

0 commit comments

Comments
 (0)