Skip to content

Commit d83a123

Browse files
committed
OSDOCS-5333: Adding AES-GCM encryption option
1 parent 555b39f commit d83a123

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

modules/about-etcd-encryption.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ When you enable etcd encryption, the following OpenShift API server and Kubernet
1717
* OAuth access tokens
1818
* OAuth authorize tokens
1919
20-
When you enable etcd encryption, encryption keys are created. These keys are rotated on a weekly basis. You must have these keys to restore from an etcd backup.
20+
When you enable etcd encryption, encryption keys are created. You must have these keys to restore from an etcd backup.
2121

2222
[NOTE]
2323
====

modules/enabling-etcd-encryption.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ It is not recommended to take a backup of etcd until the initial encryption proc
2727
$ oc edit apiserver
2828
----
2929

30-
. Set the `encryption` field type to `aescbc`:
30+
. Set the `encryption` field to `aescbc` or `aesgcm`:
3131
+
3232
[source,yaml]
3333
----
3434
spec:
3535
encryption:
3636
type: aescbc <1>
3737
----
38-
<1> The `aescbc` type means that AES-CBC with PKCS#7 padding and a 32 byte key is used to perform the encryption.
38+
<1> Set to `aescbc` for AES-CBC encryption or `aesgcm` for AES-GCM encryption.
3939

4040
. Save the file to apply the changes.
4141
+

modules/etcd-encryption-types.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * security/encrypting-etcd.adoc
4+
// * post_installation_configuration/cluster-tasks.adoc
5+
6+
:_content-type: CONCEPT
7+
[id="etcd-encryption-types_{context}"]
8+
= Supported encryption types
9+
10+
The following encryption types are supported for encrypting etcd data in {product-title}:
11+
12+
AES-CBC:: Uses AES-CBC with PKCS#7 padding and a 32 byte key to perform the encryption. The encryption keys are rotated weekly.
13+
14+
AES-GCM:: Uses AES-GCM with a random nonce and a 32 byte key to perform the encryption. The encryption keys are rotated weekly.

post_installation_configuration/cluster-tasks.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -654,6 +654,7 @@ include::modules/nodes-cluster-enabling-features-cli.adoc[leveloffset=+2]
654654
Back up etcd, enable or disable etcd encryption, or defragment etcd data.
655655

656656
include::modules/about-etcd-encryption.adoc[leveloffset=+2]
657+
include::modules/etcd-encryption-types.adoc[leveloffset=+2]
657658
include::modules/enabling-etcd-encryption.adoc[leveloffset=+2]
658659
include::modules/disabling-etcd-encryption.adoc[leveloffset=+2]
659660
include::modules/backup-etcd.adoc[leveloffset=+2]

security/encrypting-etcd.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ toc::[]
99
// About etcd encryption
1010
include::modules/about-etcd-encryption.adoc[leveloffset=+1]
1111

12+
// Supported encryption types
13+
include::modules/etcd-encryption-types.adoc[leveloffset=+1]
14+
1215
// Enabling etcd encryption
1316
include::modules/enabling-etcd-encryption.adoc[leveloffset=+1]
1417

0 commit comments

Comments
 (0)