doc: add encrypted-volumes.md feature document - #6506
Open
nixpanic wants to merge 3 commits into
Open
Conversation
Move the encryption sections (life-cycle, LUKS configuration, metadata KMS, Vault, Amazon KMS/STS, Azure Key Vault, KMIP) out of docs/rbd/deploy.md into a new top-level feature document docs/encrypted-volumes.md so it can be referenced independently of the RBD deployment guide. Replace the removed sections in docs/rbd/deploy.md with a short summary and a link to the new document. Register the new page in mkdocs.yml under Features and add a Design proposals section at the bottom of the new document that links to all relevant design proposal files: encrypted-pvc.md, encryption-with-vault-tokens.md, encryption-with-vault-sa.md, encryption-with-azure-keyvault.md, encryption-with-keyprotect.md and encryption-with-gklm.md. Assisted-by: AskBob <askbob@ibm.com> Signed-off-by: Niels de Vos <ndevos@ibm.com>
Add a dedicated 'CephFS volume encryption' section to docs/encrypted-volumes.md covering: * how to enable fscrypt encryption via the StorageClass * which KMS backends are compatible (raw-passphrase only) * the volume layout (/.fscrypt and /ceph-csi-encrypted) * kernel and Ceph client prerequisites Replace the sparse 'CephFS Volume Encryption' section in docs/cephfs/deploy.md with a short summary and a link to the new section, consistent with the existing RBD pattern. Add cephfs-fscrypt.md and rbd-pv-key-rotation.md to the Design proposals table in docs/encrypted-volumes.md. Assisted-by: AskBob <askbob@ibm.com> Signed-off-by: Niels de Vos <ndevos@ibm.com>
Use docs/assets/favicon.ico as the site favicon so it is displayed in browser tabs when viewing the MkDocs site. Assisted-by: AskBob <askbob@ibm.com> Signed-off-by: Niels de Vos <ndevos@ibm.com>
mergify
Bot
added
ci/skip/e2e
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move the encryption sections (life-cycle, LUKS configuration,
metadata KMS, Vault, Amazon KMS/STS, Azure Key Vault, KMIP) out
of docs/rbd/deploy.md into a new top-level feature document
docs/encrypted-volumes.md so it can be referenced independently
of the RBD deployment guide.
Add a dedicated 'CephFS volume encryption' section to
docs/encrypted-volumes.md covering:
Replace the sparse 'CephFS Volume Encryption' section in
docs/cephfs/deploy.md with a short summary and a link to the
new section, consistent with the existing RBD pattern.