Commit Graph

80 Commits

Author SHA1 Message Date
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
2020-09-18 18:17:15 +01:00
mhackett
f4673d2da1 doc: document tuning of radosgw lifecycle
Fixes: https://tracker.ceph.com/issues/47190

Signed-off-by: mhackett <mhackett@redhat.com>
2020-08-31 15:21:26 -04:00
mhackett
2c37b74b3b doc: document tuning of object gateway garbage collection
Fixes: https://tracker.ceph.com/issues/47189

Signed-off-by: mhackett <mhackett@redhat.com>
2020-08-28 10:29:10 -04:00
Ken Dreyer
8ae9318cfe doc/rgw: warn about "trust forwarded https" security
Warn users about the implications of enabling this option when there is
no trusted proxy in front of radosgw.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2020-05-21 17:34:30 -06:00
Casey Bodley
b0563a093a doc/rgw: document 'rgw gc max concurrent io'
Fixes: https://tracker.ceph.com/issues/44958

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2020-05-07 10:41:25 -04:00
Kai Wagner
b484a92356 doc/radosgw/config-ref: added a short paragraph to explain the garbage collection settings
Signed-off-by: Kai Wagner <kwagner@suse.com>
2020-01-07 15:47:26 +01: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
9b425335de rgw: add SSE-KMS with Vault using token auth
Minor fix to config documentation.

Signed-off-by: Andrea Baglioni <andrea.baglioni@workday.com>
Signed-off-by: Sergio de Carvalho <sergio.carvalho@workday.com>
2019-10-02 17:28:06 +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
Matt Benjamin
801d2f0449
Merge pull request #28157 from Kriechi/docs-rgw-ldap
docs: improve rgw ldap auth options
2019-08-11 20:45:29 -04:00
James McClune
2a59842991 doc: fixed broken link in Swift Settings section
Fixes: https://tracker.ceph.com/issues/40575

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2019-06-30 14:34:23 -04:00
Thomas Kriechbaumer
7ab44cb213 docs: improve rgw ldap auth options
Signed-off-by: Thomas Kriechbaumer <thomas@kriechbaumer.name>
2019-05-16 19:33:03 +02:00
Casey Bodley
9e949fcd5c
Merge pull request #27243 from theanalyst/doc-scheduler
config-ref: add a note on current scheduler settings.

Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: J. Eric Ivancich <ivancich@redhat.com>
2019-03-28 14:23:11 -04:00
Abhishek Lekshmanan
909b8ef4bc docs: rgw: add a x-ref to rados dmclock docs
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2019-03-28 17:04:31 +01:00
Abhishek Lekshmanan
542c77f555 config-ref: add a note on current scheduler settings.
Adding a note on configuirables for max concurrent requests and the rest of
experimental options for tuning dmclock scheduler

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2019-03-28 15:09:12 +01:00
Adam C. Emerson
55180511e5 rgw: Remove rgw_num_rados_handles option
This has been deprecated for some time and underlies much of the
complexity of the RADOS service.

Signed-off-by: Adam C. Emerson <aemerson@redhat.com>
2019-03-21 15:13:56 -04:00
Casey Bodley
be29fcb142 rgw: make beast the default for rgw_frontends
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2019-02-22 13:28:19 -05:00
Florian Haas
d730820a48 Improve OpenStack integration and multitenancy docs for radosgw
Add explanatory information on:

* "rgw swift account in url" (including the Swift account in the Swift
  API url and Keystone endpoint)
* "rgw swift versioning enabled" (enabling Swift object versioning)
* "rgw s3 auth use keystone" (enabling S3 authentication against
  Keystone)
* "rgw keystone implicit tenants" (multi-tenancy via Keystone, including
  its implications for the Swift and S3 APIs)

Fixes: http://tracker.ceph.com/issues/36765
Signed-off-by: Florian Haas <florian@citynetwork.eu>
2018-12-19 17:46:56 +01:00
Matt Benjamin
e636a56c50 rgw: move keystone secrets from ceph.conf to files
Permits setting restrictive permissions on these secrets.

Fixes: http://tracker.ceph.com/issues/36621

Signed-off-by: Matt Benjamin <mbenjamin@redhat.com>
2018-11-05 16:49:06 -05:00
Casey Bodley
d3dd5a996d common: add config option rgw_trust_forwarded_https
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2018-10-22 14:56:22 -04:00
李丙洋 10208981
b91d54976f doc: Fix Spelling Error of Radosgw
Signed-off-by: Li Bingyang <li.bingyang1@zte.com.cn>
2018-09-06 08:43:11 +08:00
Casey Bodley
b592ac44cc doc/rgw: add page for http frontend configuration
Fixes: http://tracker.ceph.com/issues/13523

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2018-01-22 14:45:25 -05:00
Casey Bodley
10ab5fcff7 doc/rgw: clean up multisite config options
remove region stuff, radosgw-agent stuff, and zone/pool stuff that is
duplicated in the multisite page

moved sync log config options into multisite section, added description
for rgw_run_sync_thread

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-06-16 13:32:09 -04:00
Matt Benjamin
126cd32593 Merge pull request #13395 from dang/wip-quota-cache-doc
Document RGW quota cache options
2017-06-09 13:56:52 -04:00
Casey Bodley
babd25fa36 Merge pull request #15301 from shashalu/rgw-ssl
rgw: add "rgw_verify_ssl" config

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-06-08 16:01:47 -04:00
Daniel Gryniewicz
4327d1bd2d Document RGW quota cache options
Quota cache options were undocumented.

Fixes: http://tracker.ceph.com/issues/18747
Signed-off-by: Daniel Gryniewicz <dang@redhat.com>
2017-06-07 14:47:04 -04:00
lu.shasha
8b83b83d1a rgw: add "rgw_verify_ssl" config
http_client whether try to verify ssl when sent https request

Signed-off-by: Shasha Lu <lu.shasha@eisoo.com>
2017-05-27 17:39:32 +08:00
Ali Maredia
7ff83a44de doc: mention certain conf vars should be in global
This is to make it apply whenever the radsogw-admin
command is run without specifying the instance name

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2017-05-17 10:56:47 -04:00
Casey Bodley
a1cf8ac4cd doc: rgw server-side encryption and barbican
Signed-off-by: Adam Kupczyk <akupczyk@mirantis.com>
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-04-03 10:50:04 -04:00
Ruben Kerkhof
3a1c7b19df doc: Fix typo and grammar in RGW config reference
Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2017-02-10 15:07:38 +01:00
Sage Weil
991141c34f Merge pull request #12548 from Liuchang0812/add-document-rgw
doc: explain rgw_fcgi_socket_backlog in rgw/config-ref.rst

Reviewed-by: Sage Weil <sage@redhat.com>
2016-12-19 08:44:27 -06:00
liuchang0812
6fc0e59a1c doc: explain rgw_fcgi_socket_backlog in rgw/config-ref.rst
Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2016-12-17 22:49:42 +08:00
Matt Benjamin
04bf0f8ca1 rgw: add 'rgw log http headers' gloss to config-ref.rst
Explain the option for upstream doc.

Signed-off-by: Matt Benjamin <mbenjamin@redhat.com>
2016-12-14 09:59:20 -05:00
Casey Bodley
6869cf1ca4 doc: add docs for rgw compression
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2016-11-30 16:26:36 -05:00
Casey Bodley
42a18edf26 doc/rgw: document rgw_compression_type
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2016-11-02 11:18:19 -04:00
Radoslaw Zarzynski
585026833d Merge pull request #10280 from rzarzynski/wip-rgw-swift-at-root-features
rgw: add suport for Swift-at-root dependent features of Swift API

Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Pritha Srivastava <prsrivas@redhat.com>
Reviewed-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-08-29 15:36:17 +02:00
Radoslaw Zarzynski
9697ca3414 rgw, doc: fix formatting around Keystone-related options.
This patch brings a small fix for broken formatting around
two configurables in doc/radosgw/config-ref.rst. Those are:
  * rgw keystone admin user,
  * rgw keystone admin password.

Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-07-18 15:29:09 +02:00
Radoslaw Zarzynski
dbf5b5b73d rgw: fix the handling of rgw_swift_url_prefix.
This patch fixes to the support for placing the Swift API in the root
of URL hierarchy. Unfortunately, the whole concept exhibits a severe side
effect: inability to deploy RadosGW in multi-site configuration.

The sole reason behind this fix is the fact we claimed in documentation
that the feature is available.

Fixes: http://tracker.ceph.com/issues/16673
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-07-14 15:46:24 +02:00
Daniel Gryniewicz
92ff5ff69f Merge pull request #9261 from prallabh/user_quota
rgw: Let the default quota settings take effect during user creation
2016-06-20 11:49:46 -04:00
root
e3ab347614 rgw: Add documentation for RGW default quota
Signed-off-by: Pavan Rallabhandi <PRallabhandi@walmartlabs.com>
2016-06-20 16:18:00 +05:30
Radoslaw Zarzynski
237ad1210f rgw: improve support for Swift's object versioning.
This patch allows RadosGW to pass the RefStack with an accuracy
to the RFC7230 violation issue which is clearly a Tempest bug.

Fixes: http://tracker.ceph.com/issues/15925
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-06-03 00:52:14 +02:00
Orit Wasserman
8b5bbe9ed4 Merge pull request #8093 from zaitcev/swift-root-prefix
rgw: Allow to serve Swift off the URL root
Reviewed-by: Orit Wasserman <owasserm@redhat.com>
2016-05-24 20:11:57 +02:00
Matt Benjamin
1535cd4096 Merge pull request #8741 from rzarzynski/wip-rgw-keystonev3-doc
rgw, doc: improve documentation of Keystone v3 config options
2016-05-24 07:31:30 -04:00
Kefu Chai
80b6660abd Merge pull request #8962 from beess/doc-fix1
doc: Fixes three hyphen errors and a syntax error.

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-05-06 22:03:11 +08:00
zhuangxc89
c792bceed3 doc: Fixes three hyphen errors and a syntax error.
Signed-off-by: Zhuang Xiaochun <zhuangxc89@163.com>
2016-05-06 17:20:40 +08:00
Abhishek Lekshmanan
cbd610537a doc: update keystone admin options in config-ref
Adding the short descriptions of the keystone admin tenant, user and
password options to the config reference as well. Also adding a note
that this applies to only v2 of Openstack Identity API

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-25 17:53:59 +02:00
Radoslaw Zarzynski
7dbdddee80 rgw, doc: extend the documentation of rgw_keystone_admin_token.
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-04-25 15:30:09 +02:00
Radoslaw Zarzynski
3351a8ce36 rgw, doc: document config options related to Keystone v3.
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-04-25 15:29:32 +02:00
Kris Jurka
0a622e6054 doc: rgw admin uses "region list" not "regions list" 2016-04-08 21:47:28 -07:00