From e5844fb3cb81d5489f15e102a8e8c8e54fb2c6d5 Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Fri, 9 May 2025 17:15:02 +0700 Subject: [PATCH] doc/radosgw: Cosmetic and formatting improvements in vault.rst Use generated "contents" instead of repeating section titles in an ordered list. Use Title Case for section titles. Capitalize consistently "Ceph" and "Object Gateway", "Vault". Use consistently all caps for acronyms. Change one entry of "kms" to "SSE-KMS", seems obvious from the context. Use "certificates" instead of "certs". Use double backticks for file paths, commands, config options etc. Improve language in one sentence, several words missing. Call it consistently "the Object Gateway" and not sometimes "the Gateway". Add pre-formatted block for CLI command examples where missing (should be promptified in the future). Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> (cherry picked from commit aa2e91ff70ea37a56f4013e6087f7e790f527329) --- doc/radosgw/vault.rst | 115 ++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 59 deletions(-) diff --git a/doc/radosgw/vault.rst b/doc/radosgw/vault.rst index da34a3919daea..26c88c13a7f72 100644 --- a/doc/radosgw/vault.rst +++ b/doc/radosgw/vault.rst @@ -33,12 +33,7 @@ HashiCorp `Vault`_ can be used as a secure key management service for | | object | | | |------------------------------>| -#. `Vault secrets engines`_ -#. `Vault authentication`_ -#. `Vault namespaces`_ -#. `Create a key in Vault`_ -#. `Configure the Ceph Object Gateway`_ -#. `Upload object`_ +.. contents:: :depth: 2 Some examples below use the Vault command line utility to interact with Vault. You may need to set the following environment variable with the correct @@ -46,7 +41,7 @@ address of your Vault server to use this utility:: export VAULT_ADDR='https://vault-server-fqdn:8200' -Vault secrets engines +Vault Secrets Engines ===================== Vault provides several secrets engines, which can store, generate, and encrypt @@ -55,7 +50,7 @@ data. Currently, the Object Gateway supports: - `KV secrets engine`_ version 2 - `Transit engine`_ -KV secrets engine +KV Secrets Engine ----------------- The KV secrets engine is used to store arbitrary key/value secrets in Vault. To @@ -68,7 +63,7 @@ following setting:: rgw crypt vault secret engine = kv -Transit secrets engine +Transit Secrets Engine ---------------------- The transit engine handles cryptographic functions on data in-transit. To enable @@ -81,7 +76,7 @@ following setting:: rgw crypt vault secret engine = transit -Vault authentication +Vault Authentication ==================== Vault supports several authentication mechanisms. Currently, the Object @@ -93,7 +88,7 @@ sort of Vault token that does not have a lifetime are root tokens. For all other tokens, it is necessary to periodically refresh them, either by performing initial authentication, or by renewing the token. Ceph does not have any logic to perform either operation. -The simplest best way to use Vault tokens with ceph is to +The simplest best way to use Vault tokens with Ceph is to also run the Vault agent and have it refresh the token file. When the Vault agent is used in this mode, file system permissions can be used to restrict who has the use of tokens. @@ -103,10 +98,10 @@ to act as a proxy server. In this mode, Vault will add a token when necessary and add it to requests passed to it before forwarding them on to the real server. Vault agent will still handle token renewal just as it would when storing a token in the filesystem. In this mode, it -is necessary to properly secure the network path rgw uses to reach the +is necessary to properly secure the network path RGW uses to reach the Vault agent, such as having the Vault agent listen only to localhost. -Token policies for the object gateway +Token Policies for the Object Gateway ------------------------------------- All Vault tokens have powers as specified by the polices attached @@ -114,7 +109,7 @@ to that token. Multiple policies may be associated with one token. You should only use the policies necessary for your configuration. -When using the kv secret engine with the object gateway:: +When using the KV secret engine with the Object Gateway:: vault policy write rgw-kv-policy -<``. -Using the Transit engine +Using the Transit Engine ------------------------ -Keys created for use with the Transit engine should no longer be marked +Keys created for use with the transit engine should no longer be marked exportable. They can be created with:: vault write -f transit/keys/mybucketkey @@ -347,8 +344,8 @@ Optionally, set the Vault namespace where encryption keys will be fetched from:: rgw crypt vault namespace = tenant1 -Finally, the URLs where the Gateway will retrieve encryption keys from Vault can -be restricted by setting a path prefix. For instance, the Gateway can be +Finally, the URLs where the Object Gateway will retrieve encryption keys from Vault can +be restricted by setting a path prefix. For instance, the Object Gateway can be restricted to fetch KV keys as follows:: rgw crypt vault prefix = /v1/secret/data @@ -357,10 +354,10 @@ Or, when using the transit secret engine:: rgw crypt vault prefix = /v1/transit -In the example above, the Gateway would only fetch transit encryption keys under +In the example above, the Object Gateway would only fetch transit encryption keys under ``https://vault-server:8200/v1/transit``. -You can use custom ssl certs to authenticate with vault with help of +You can use custom SSL certificates to authenticate with Vault with help of following options:: rgw crypt vault verify ssl = true @@ -368,17 +365,17 @@ following options:: rgw crypt vault ssl clientcert = /etc/ceph/vault.crt rgw crypt vault ssl clientkey = /etc/ceph/vault.key -where vault.ca is CA certificate and vault.key/vault.crt are private key and ssl -certificate generated for RGW to access the vault server. It highly recommended to -set this option true, setting false is very dangerous and need to avoid since this +where ``vault.ca`` is CA certificate and ``vault.key``/``vault.crt`` are private key and SSL +certificate generated for RGW to access the Vault server. It is highly recommended to +set this option to the value ``true``, setting ``false`` is very dangerous and needs to be avoided since this runs in very secured environments. -Transit engine compatibility support +Transit Engine Compatibility Support ------------------------------------ The transit engine has compatibility support for previous -versions of ceph, which used the transit engine as a simple key store. +versions of Ceph, which used the transit engine as a simple key store. -There is a "compat" option which can be given to the transit +There is a ``compat`` option which can be given to the transit engine to configure the compatibility support, To entirely disable backwards support, use:: @@ -394,22 +391,22 @@ This is the normal default with the current version:: This enables the new engine for newly created objects, but still allows the old engine to be used for old objects. -In order to access old and new objects, the vault token given -to ceph must have both the old and new transit policies. +In order to access old and new objects, the Vault token given +to Ceph must have both the old and new transit policies. To force use of only the old engine, use:: rgw crypt vault secret engine = transit compat=2 -This mode is automatically selected if the vault prefix -ends in export/encryption-key, which was the previously +This mode is automatically selected if the Vault prefix +ends in ``export/encryption-key``, which was the previously documented setting. -Upload object +Upload Object ============= -When uploading an object to the Gateway, provide the SSE key ID in the request. -As an example, for the kv engine, using the AWS command-line client:: +When uploading an object to the Object Gateway, provide the SSE key ID in the request. +As an example, for the KV engine, using the AWS command-line client:: aws --endpoint=http://radosgw:8000 s3 cp plaintext.txt s3://mybucket/encrypted.txt --sse=aws:kms --sse-kms-key-id myproject/mybucketkey @@ -418,18 +415,18 @@ As an example, for the transit engine (new flavor), using the AWS command-line c aws --endpoint=http://radosgw:8000 s3 cp plaintext.txt s3://mybucket/encrypted.txt --sse=aws:kms --sse-kms-key-id mybucketkey The Object Gateway will fetch the key from Vault, encrypt the object and store -it in the bucket. Any request to download the object will make the Gateway +it in the bucket. Any request to download the object will make the Object Gateway automatically retrieve the correspondent key from Vault and decrypt the object. Note that the secret will be fetched from Vault using a URL constructed by concatenating the base address (``rgw crypt vault addr``), the (optional) URL prefix (``rgw crypt vault prefix``), and finally the key ID. -In the kv engine example above, the Gateway would fetch the secret from:: +In the KV engine example above, the Object Gateway would fetch the secret from:: http://vaultserver:8200/v1/secret/data/myproject/mybucketkey -In the transit engine example above, the Gateway would encrypt the secret using this key:: +In the transit engine example above, the Object Gateway would encrypt the secret using this key:: http://vaultserver:8200/v1/transit/mybucketkey -- 2.39.5