Skip to content

Commit 9c84e46

Browse files
authored
Merge pull request #94525 from lahinson/osdocs-14912-etcd-encrypt
[OSDOCS-14912]: Adding etcd encryption content to the new etcd book
2 parents 5a62227 + 4e3d756 commit 9c84e46

File tree

10 files changed

+25
-34
lines changed

10 files changed

+25
-34
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1240,9 +1240,6 @@ Topics:
12401240
- Name: Allowing JavaScript-based access to the API server from additional hosts
12411241
File: allowing-javascript-access-api-server
12421242
Distros: openshift-enterprise,openshift-origin
1243-
- Name: Encrypting etcd data
1244-
File: encrypting-etcd
1245-
Distros: openshift-enterprise,openshift-origin
12461243
- Name: Scanning pods for vulnerabilities
12471244
File: pod-vulnerability-scan
12481245
Distros: openshift-enterprise,openshift-origin
@@ -2450,7 +2447,7 @@ Topics:
24502447
File: replace-unhealthy-etcd-member
24512448
- Name: Disaster recovery
24522449
File: etcd-disaster-recovery
2453-
- Name: Encrypting etcd data
2450+
- Name: Enabling etcd encryption
24542451
File: etcd-encrypt
24552452
# - Name: Setting up fault-tolerant control planes that span data centers
24562453
# File: etcd-fault-tolerant

etcd/etcd-encrypt.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="etcd-encrypt"]
33
include::_attributes/common-attributes.adoc[]
4-
= Encrypting etcd data
4+
= Enabling etcd encryption
55
:context: etcd-encrypt
66

7-
// This assembly will contain modules to provide information about encrypting etcd.
7+
toc::[]
8+
9+
// About etcd encryption
10+
include::modules/about-etcd-encryption.adoc[leveloffset=+1]
11+
12+
// Supported encryption types
13+
include::modules/etcd-encryption-types.adoc[leveloffset=+1]
14+
15+
// Enabling etcd encryption
16+
include::modules/enabling-etcd-encryption.adoc[leveloffset=+1]
17+
18+
// Disabling etcd encryption
19+
include::modules/disabling-etcd-encryption.adoc[leveloffset=+1]
20+

hosted_control_planes/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::modules/hcp-ocp-differences.adoc[leveloffset=+1]
1313

1414
[role="_additional-resources"]
1515
.Additional resources
16-
* xref:../security/encrypting-etcd.adoc#encrypting-etcd[Enabling etcd encryption]
16+
* xref:../etcd/etcd-encrypt.adoc#etcd-encrypt[Enabling etcd encryption]
1717
1818
include::modules/hcp-mce-acm-relationship-intro.adoc[leveloffset=+1]
1919
include::modules/hcp-acm-discover.adoc[leveloffset=+2]

installing/overview/installing-fips.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Although the {product-title} cluster itself uses FIPS validated or Modules In Pr
6969
[id="installation-about-fips-components-etcd_{context}"]
7070
=== etcd
7171

72-
To ensure that the secrets that are stored in etcd use FIPS validated or Modules In Process encryption, boot the node in FIPS mode. After you install the cluster in FIPS mode, you can xref:../../security/encrypting-etcd.adoc#encrypting-etcd[encrypt the etcd data] by using the FIPS-approved `aes cbc` cryptographic algorithm.
72+
To ensure that the secrets that are stored in etcd use FIPS validated or Modules In Process encryption, boot the node in FIPS mode. After you install the cluster in FIPS mode, you can xref:../../etcd/etcd-encrypt.adoc#etcd-encrypt[encrypt the etcd data] by using the FIPS-approved `aes cbc` cryptographic algorithm.
7373

7474
[id="installation-about-fips-components-storage_{context}"]
7575
=== Storage
@@ -110,4 +110,4 @@ To enable FIPS mode for your cluster, you must run the installation program from
110110
If you are using Azure File storage, you cannot enable FIPS mode.
111111
====
112112

113-
To apply `AES CBC` encryption to your etcd data store, follow the xref:../../security/encrypting-etcd.adoc#encrypting-etcd[Encrypting etcd data] process after you install your cluster.
113+
To apply `AES CBC` encryption to your etcd data store, follow the xref:../../etcd/etcd-encrypt.adoc#etcd-encrypt[Encrypting etcd data] process after you install your cluster.

modules/about-etcd-encryption.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/encrypting-etcd.adoc
43
// * post_installation_configuration/cluster-tasks.adoc
4+
// * etcd/etcd-encrypt.adoc
55

66
:_mod-docs-content-type: CONCEPT
77
[id="about-etcd_{context}"]
@@ -24,4 +24,4 @@ When you enable etcd encryption, encryption keys are created. You must have thes
2424
Etcd encryption only encrypts values, not keys. Resource types, namespaces, and object names are unencrypted.
2525
2626
If etcd encryption is enabled during a backup, the `__static_kuberesources_<datetimestamp>.tar.gz__` file contains the encryption keys for the etcd snapshot. For security reasons, store this file separately from the etcd snapshot. However, this file is required to restore a previous state of etcd from the respective etcd snapshot.
27-
====
27+
====

modules/disabling-etcd-encryption.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/encrypting-etcd.adoc
43
// * post_installation_configuration/cluster-tasks.adoc
4+
// * etcd/etcd-encrypt.adoc
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="disabling-etcd-encryption_{context}"]

modules/enabling-etcd-encryption.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/encrypting-etcd.adoc
43
// * post_installation_configuration/cluster-tasks.adoc
4+
// * etcd/etcd-encrypt.adoc
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="enabling-etcd-encryption_{context}"]

modules/etcd-encryption-types.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
3-
// * security/encrypting-etcd.adoc
43
// * post_installation_configuration/cluster-tasks.adoc
4+
// * etcd/etcd-encrypt.adoc
55

66
:_mod-docs-content-type: CONCEPT
77
[id="etcd-encryption-types_{context}"]

security/encrypting-etcd.adoc

Lines changed: 0 additions & 19 deletions
This file was deleted.

security/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ You can also review more details about the types of certificates used by the clu
6161
[id="encrypting-data"]
6262
=== Encrypting data
6363

64-
You can xref:../security/encrypting-etcd.adoc#encrypting-etcd[enable etcd encryption] for your cluster to provide an additional layer of data security. For example, it can help protect the loss of sensitive data if an etcd backup is exposed to the incorrect parties.
64+
You can xref:../etcd/etcd-encrypt.adoc#etcd-encrypt[enable etcd encryption] for your cluster to provide an additional layer of data security. For example, it can help protect the loss of sensitive data if an etcd backup is exposed to the incorrect parties.
6565

6666
[discrete]
6767
[id="vulnerability-scanning"]

0 commit comments

Comments
 (0)