Repository navigation
docs: add OpenBao external KMS integration guide - #196
Merged
Merged
Conversation
Verified end-to-end against RustFS 1.0.5 and OpenBao 2.7.2 (config-only integration through the existing vault-transit backend, no code changes): - OpenBao deployment with TLS and integrated raft storage, init/unseal - rustfs-transit (Transit) and rustfs-meta (KV v2) mounts with a least-privilege policy and an orphan token for RustFS - RustFS configuration via RUSTFS_KMS_* variables, default SSE key - SSE-KMS verification with documented aws s3api commands - Validation table from live testing: round-trip, restart recovery, sealed behavior without plaintext fallback, key rotation, tamper rejection (reads and deletes), and encryption-context binding - Troubleshooting for every pitfall hit during verification: HTTPS requirement, token file 0600 permissions, context vs associated_data semantics for non-derived keys, and probe-interval recovery Includes RustFS console screenshots of the SSE Settings KMS section (English for en/de/fr/ja, Chinese UI for zh). Cross-links added from the SSE-KMS backend overview page in all locales.
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.
Summary
New page
security-compliance/encryption/openbao.mdin all five locales (en/zh/de/fr/ja): deploy OpenBao as an external KMS for RustFS SSE-KMS through the existingvault-transitbackend — configuration only, no RustFS code changes required (verified end-to-end against RustFS 1.0.5 and OpenBao 2.7.2).Contents:
rustfs-transit(Transit) andrustfs-meta(KV v2) mounts, a least-privilege ACL policy covering key CRUD + LIST + crypto operations and the KV data/metadata paths, and an orphan token for RustFSRUSTFS_KMS_*configuration, default SSE key selectionaws s3apicommands (verified verbatim)0600permission validation,contextvsassociated_datasemantics for non-derived keys (transit ignorescontext— the binding is onassociated_data), and inlinexl.metastorage layout notesConsole screenshots of the SSE Settings KMS section included — English UI for en/de/fr/ja, Chinese UI for zh (
rustfs-kms-console.png, both under 300 KB).Cross-links to the new page added from the SSE-KMS backend overview (
kms.md) in all five locales.Validation
npm run docs:check: PASS (locale tree parity, code-block parity across locales, banned strings, image sizes)npm run build: succeeds (4085 static files generated)