Uh oh!
There was an error while loading. Please reload this page.
Feature: Key Management Service (KMS) - #634
Conversation
There was a problem hiding this comment.
Pull request overview
Adds administrator documentation for the new Key Management Service (KMS) feature and wires it into the Admin Guide, including updated volume creation docs and supporting UI/architecture screenshots.
Changes:
- Add a new Admin Guide page documenting KMS concepts (KEK/DEK), HSM profiles, key lifecycle (create/rotate), migration, and configuration settings.
- Update storage docs to describe KVM volume encryption and expose the new “KMS Key” option when creating volumes.
- Add new images and include the new KMS page in the Admin Guide index toctree.
Reviewed changes
Copilot reviewed 3 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| source/adminguide/storage.rst | Adds a “Volume Encryption” section and documents the optional “KMS Key” field during volume creation. |
| source/adminguide/kms.rst | New KMS documentation page (architecture, providers, HSM profiles, key creation/rotation, migration, settings). |
| source/adminguide/index.rst | Adds kms to the Admin Guide toctree so the new page is published. |
| source/_static/images/kms-rotate-key.png | New screenshot referenced by KMS key rotation docs. |
| source/_static/images/kms-create-key.png | New screenshot referenced by KMS key creation docs. |
| source/_static/images/kms-architecture.png | New architecture diagram referenced by the KMS overview. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| .. warning:: | ||
| Deleting the KMS key used to encrypt a volume will render that volume permanently | ||
| unrecoverable. |
There was a problem hiding this comment.
@vishesh92 can we block the delete operation when a KMS key in use, instead of unrecoverable volume?
kiranchavala
commented
May 19, 2026
@blueorangutan docbuild |
blueorangutan
commented
May 19, 2026
@kiranchavala a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
kiranchavala
commented
May 20, 2026
@blueorangutan docbuild |
blueorangutan
commented
May 20, 2026
@kiranchavala a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
blueorangutan
commented
May 20, 2026
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/634. (QA-JID 537) |
Uh oh!
There was an error while loading. Please reload this page.
To be merged after: apache/cloudstack#12711
📚 Documentation preview 📚: https://cloudstack-documentation--634.org.readthedocs.build/en/634/