Skip to content

Commit e2dda92

Browse files
authored
Merge pull request #55014 from lpettyjo/OSDOCS-3780_3781_3782
OSDOCS-3780&3781&3782:BYOK encryption
2 parents 6d34f08 + 36b3755 commit e2dda92

File tree

4 files changed

+49
-2
lines changed

4 files changed

+49
-2
lines changed

modules/persistent-storage-byok.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// storage/container_storage_interface/persistent-storage-csi-azure.adoc
4+
// storage/container_storage_interface/persistent-storage-csi-ebs.adoc
5+
// storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc
6+
7+
:_content-type: CONCEPT
8+
[id="byok_{context}"]
9+
= User-managed encryption
10+
11+
The user-managed encryption feature allows you to provide keys during installation that encrypt {product-title} node root volumes, and enables all managed storage classes to use these keys to encrypt provisioned storage volumes. You must specify the custom key in the `platform.<cloud_type>.defaultMachinePlatform` field in the install-config YAML file.
12+
13+
This features supports the following storage types:
14+
15+
* Amazon Web Services (AWS) Elastic Block storage (EBS)
16+
17+
* Microsoft Azure Disk storage
18+
19+
* Google Cloud Platform (GCP) persistent disk (PD) storage

storage/container_storage_interface/persistent-storage-csi-azure.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ After full migration, in-tree plugins will eventually be removed in later versio
3131

3232
include::modules/persistent-storage-csi-azure-disk-sc-zrs.adoc[leveloffset=+1]
3333

34+
ifndef::openshift-rosa,openshift-dedicated[]
35+
include::modules/persistent-storage-byok.adoc[leveloffset=+1]
36+
37+
[NOTE]
38+
====
39+
If the OS (root) disk is encrypted, and there is no encrypted key defined in the storage class, Azure Disk CSI driver uses the OS disk encryption key by default to encrypt provisioned storage volumes.
40+
====
41+
42+
For information about installing with user-managed encryption for Azure, see xref:../../installing/installing_azure/enabling-user-managed-encryption-azure.adoc[Enabling user-managed encryption for Azure].
43+
endif::openshift-rosa,openshift-dedicated[]
44+
3445
//Machine sets that deploy machines on ultra disks using PVCs
3546
include::modules/machineset-azure-ultra-disk.adoc[leveloffset=+1]
3647

storage/container_storage_interface/persistent-storage-csi-ebs.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,18 @@ After full migration, in-tree plugins will eventually be removed in future versi
4141

4242
For information about dynamically provisioning AWS EBS persistent volumes in {product-title}, see xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store].
4343

44+
ifndef::openshift-rosa,openshift-dedicated[]
45+
include::modules/persistent-storage-byok.adoc[leveloffset=+1]
46+
47+
[NOTE]
48+
====
49+
If there is no encrypted key defined in the storage class, only set `encrypted: "true"` in the storage class. The AWS EBS CSI driver uses the AWS managed alias/aws/ebs, which is created by Amazon EBS automatically in each region by default to encrypt provisioned storage volumes. In addition, the managed storage classes all have the `encrypted: "true"` setting.
50+
====
51+
52+
For information about installing with user-managed encryption for AWS EBS, see xref:../../installing/installing_aws/installing-aws-customizations.adoc#installation-configuration-parameters_installing-aws-customizations[Installation configuration parameters].
53+
endif::openshift-rosa,openshift-dedicated[]
54+
4455
[role="_additional-resources"]
45-
.Additional resources
56+
== Additional resources
4657
* xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent storage using AWS Elastic Block Store]
4758
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]

storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ include::modules/persistent-storage-csi-gcp-pd-storage-class-ref.adoc[leveloffse
3838

3939
include::modules/persistent-storage-csi-gcp-pd-encrypted-pv.adoc[leveloffset=+1]
4040

41+
ifndef::openshift-rosa,openshift-dedicated[]
42+
include::modules/persistent-storage-byok.adoc[leveloffset=+1]
43+
44+
For information about installing with user-managed encryption for GCP PD, see xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-configuration-parameters_installing-gcp-customizations[Installation configuration parameters].
45+
endif::openshift-rosa,openshift-dedicated[]
46+
4147
[role="_additional-resources"]
42-
.Additional resources
48+
== Additional resources
4349
* xref:../../storage/persistent_storage/persistent-storage-gce.adoc#persistent-storage-using-gce[Persistent storage using GCE Persistent Disk]
4450
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]

0 commit comments

Comments
 (0)