Commit Graph

15 Commits

Author SHA1 Message Date
Mary Frances
72922c5ad2 doc: Fixes spelling errors in vault.rst
Signed-off-by: Mary Frances underacloud.tech@gmail.com
2022-10-07 19:06:55 -07:00
Anthony D'Atri
f6af9a616b
Merge pull request #42095 from thotz/rgwvaultdocupdate
doc/radosgw/vault: update the vault documentation
2022-07-02 20:04:12 -07:00
Marcus Watts
c6aae196df rgw/crypt - document that sse-s3 exists.
encryption.rst documents which encryption features are available.
I've added a section on sse-s3, and clarified some other details.

Signed-off-by: Marcus Watts <mwatts@redhat.com>
2022-04-19 17:35:40 -04:00
wangyunqing
25d3303698 doc/rbd/vault.rst: fix typos
Signed-off-by: wangyunqing <wangyunqing@inspur.com>
2021-09-22 14:47:43 +08:00
Jiffin Tony Thottan
d00c7211ec doc/radosgw/vault: update the vault documentation
The details about vault agent specified twice the doc, removing the
additional reference from `vault token` section.

Signed-off-by: Jiffin Tony Thottan <jthottan@redhat.com>
2021-06-29 18:11:37 +05:30
Jiffin Tony Thottan
c2af1cdc13 doc/radosgw/vault: add documentation for ssl authentication
Now RGW server can use custom ssl certs to authenticate with vault
server, adding steps for the same

Signed-off-by: Jiffin Tony Thottan <jthottan@redhat.com>
2021-04-16 23:07:59 +05:30
Marcus Watts
a9edb632a5 rgw/kms/vault - document configuration for new transit logic
Using the new transit logic requires slightly different configuration.
additionally there is some backwards compatibility support, which
also needed documentation.

The existing description of how to configure hashicorp vault
to work with ceph was also incomplete.  I've fleshed that out a bit,
including considerably more information on how to use configure
and use the vault secret agent with ceph.

Fixes: http://tracker.ceph.com/issues/48746
Signed-off-by: Marcus Watts <mwatts@redhat.com>
2021-03-05 23:05:13 -05:00
ianwatsonrh
713077c23c Docs: vault kv and transit engine updates
Providing some clearer documentation on the steps needed when using either the kv or transit engine

Signed-off-by: ianwatsonrh <ianwatson@redhat.com>
2020-04-27 10:50:04 +01:00
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Sergio de Carvalho
f9d7b685c1 rgw: improvements to SSE-KMS with Vault
* Minor improvements to Vault documentation
* Add teuthology tests for Transit secrets engine
* Add unit tests for KV secrets engine, minor improvements to Transit
  secrets engine
* use string_view::npos instead of string::npos

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-11-28 09:19:39 +00:00
Andrea Baglioni
cebb48bffe rgw: Vault's Transit Secrets updates and docs
* Drop polymorfism for KMS class
  * Fix issue in kms-key selection
  * Update documentation for Vault section

 Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
 Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-11-28 09:19:39 +00:00
Andrea Baglioni
a41832eb42 rgw: Add support to Vault's Transit Secrets Engine in SSE-KMS
* refactor rgw_kms.cc to support extension to multiple secret engines.
* introduced support to Vault Namesapces
* added support for Vault Agent

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-11-28 09:19:39 +00:00
Sergio de Carvalho
2650ebe8af rgw: improvements to SSE-KMS with Vault
* add 'rgw crypt vault prefix' config setting to allow restricting
  secret space in Vault where RGW can retrieve keys from
* refuse Vault token file if permissions are too open
* improve concatenation of URL paths to avoid constructing an invalid
  URL (missing or double '/')
* doc: clarify SSE-KMS keys must be 256-bit long and base64 encoded,
  document Vault policies and tokens, plus other minor doc improvements
* qa: check SHA256 signature of Vault zip download
* qa: fix teuthology tests broken by previous PR which made SSE-KMS
  backend default to Barbican

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-11-12 13:51:25 +00:00
Sergio de Carvalho
7b216bab3d rgw: add SSE-KMS with Vault using token auth
Clarify supported secret engine in the Vault documentation.

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-10-04 15:55:51 +01:00
Sergio de Carvalho
1e5b58ad50 rgw: add SSE-KMS with Vault using token auth
Extend server-side encryption functionality in Rados Gateway to support
HashiCorp Vault as a Key Management System in addition to existing
support for OpenStack Barbican.

This is the first part of this change, supporting Vault's token-based
authentication only. Agent-based authentication as well as other
features such as Vault namespaces will be added in subsequent commits.

Note that Barbican remains the default backend for SSE-KMS
(rgw crypt s3 kms backend) to avoid breaking existing deployments.

Feature: https://tracker.ceph.com/issues/41062
Notes: https://pad.ceph.com/p/rgw_sse-kms

Implemented so far:
* Move existing SSE-KMS functions from rgw_crypt.cc to rgw_kms.cc
* Vault authentication with a token read from file
* Add new ceph.conf settings for Vault
* Document new ceph.conf settings
* Update main encryption documentation page
* Add documentation page for SSE-KMS using Vault

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-10-01 19:55:23 +01:00