Skip to content

Commit fd764e3

Browse files
authored
Merge pull request #44951 from sftim/20240130_revise_encryption_at_rest
Reword advice about encryption-at-rest opt outs
2 parents 90534c5 + 6d6b17a commit fd764e3

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

content/en/docs/tasks/administer-cluster/encrypt-data.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -168,19 +168,31 @@ encrypt all resources, even custom resources that are added after API server sta
168168
since part of the configuration would be ineffective. The `resources` list's processing order and precedence
169169
are determined by the order it's listed in the configuration. {{< /note >}}
170170

171-
Opting out of encryption for specific resources while wildcard is enabled can be achieved by adding a new
172-
`resources` array item with the resource name, followed by the `providers` array item with the `identity` provider.
173-
For example, if '`*.*`' is enabled and you want to opt-out encryption for the `events` resource, add a new item
174-
to the `resources` array with `events` as the resource name, followed by the providers array item with `identity`.
175-
The new item should look like this:
171+
If you have a wildcard covering resources and want to opt out of at-rest encryption for a particular kind
172+
of resource, you achieve that by adding a separate `resources` array item with the name of the resource that
173+
you want to exempt, followed by a `providers` array item where you specify the `identity` provider. You add
174+
this item to the list so that it appears earlier than the configuration where you do specify encryption
175+
(a provider that is not `identity`).
176+
177+
For example, if '`*.*`' is enabled and you want to opt out of encryption for Events and ConfigMaps, add a
178+
new **earlier** item to the `resources`, followed by the providers array item with `identity` as the
179+
provider. The more specific entry must come before the wildcard entry.
180+
181+
The new item would look similar to:
176182

177183
```yaml
178-
- resources:
179-
- events
180-
providers:
181-
- identity: {}
184+
...
185+
- resources:
186+
- configmaps. # specifically from the core API group,
187+
# because of trailing "."
188+
- events
189+
providers:
190+
- identity: {}
191+
# and then other entries in resources
182192
```
183-
Ensure that the new item is listed before the wildcard '`*.*`' item in the resources array to give it precedence.
193+
194+
Ensure that the exemption is listed _before_ the wildcard '`*.*`' item in the resources array
195+
to give it precedence.
184196

185197
For more detailed information about the `EncryptionConfiguration` struct, please refer to the
186198
[encryption configuration API](/docs/reference/config-api/apiserver-encryption.v1/).

0 commit comments

Comments
 (0)