Commit Graph

60 Commits

Author SHA1 Message Date
Pritha Srivastava
d228d613b0 rgw: modifying documentation to include explanation of
open id connect provider related REST APIs and removing
references to token introspection for validating incoming
web token.

Signed-off-by: Pritha Srivastava <prsrivas@redhat.com>
2020-06-05 21:31:58 +05:30
Or Friedmann
1bcd212fd2 rgw: Adding data cache and CDN capabilities
This feature is meant to add data cache feature to the RGW.
It is using Nginx as a cache server.
This feature adds 2 new apis, Auth api and Cache api.

Some Performance tests using hsbench:
16K objs:

RGW direct access:
Mode: GET, Ops: 3001, MB/s: 46.89, Lat(ms): [ min: 30.4, avg: 33.2, 99%: 34.7, max: 35.2 ]
Nginx access (objs have not been cached)
Mode: GET, Ops: 1363, MB/s: 21.30, Lat(ms): [ min: 63.8, avg: 73.8, 99%: 78.1, max: 86.6 ]
Nginx access (objs have been cached)
Mode: GET, Ops: 2446, MB/s: 38.22, Lat(ms): [ min: 36.9, avg: 41.0, 99%: 43.9, max: 45.9 ]

512K objs:
RGW direct access:
Mode: GET, Ops: 1492, MB/s: 746.00 Lat(ms): [ min: 60.4, avg: 66.7, 99%: 73.5, max: 75.9 ]

Nginx access (objs have not been cached)
Mode: GET, Ops: 1382, MB/s: 691.00, Lat(ms): [ min: 64.5, avg: 72.1, 99%: 77.9, max: 82.8 ]

Nginx access (objs have been cached)
Mode: GET, Ops: 2947, MB/s: 1473.50, Lat(ms): [ min: 3.3, avg: 32.7, 99%: 62.2, max: 72.1 ]

2M objs:
RGW direct access:
Mode: GET, Ops: 613, MB/s: 1226.00, Lat(ms): [ min: 143.6, avg: 162.0, 99%: 180.2, max: 190.1 ]

Nginx access (objs have not been cached)
Mode: GET, Ops: 462, MB/s: 924.00, Lat(ms): [ min: 180.2, avg: 215.0, 99%: 243.2, max: 248.3 ]

Nginx access (objs have been cached)
Mode: GET, Ops: 1392, MB/s: 2784.00, Lat(ms): [ min: 3.0, avg: 5.3, 99%: 18.8, max: 30.2 ]

10M objs:
RGW direct access:
Mode: GET, Ops: 135, MB/s: 1350.00, Lat(ms): [ min: 191.1, avg: 265.8, 99%: 373.1, max: 382.8 ]

Nginx access (objs have not been cached)
Mode: GET, Ops: 120, MB/s: 1200.00, Lat(ms): [ min: 302.1, avg: 428.8, 99%: 561.2, max: 583.7 ]

Nginx access (objs have been cached)
Mode: GET, Ops: 281, MB/s: 2810.00, Lat(ms): [ min: 3.2, avg: 8.3, 99%: 16.9, max: 25.6 ]

gdal_translate 4GiB image gdal_translate -co NUM_THREADS=ALL_CPUS /vsis3/hello/sat.tif

Nginx (have not cached):
real 0m24.714s
user 0m8.692s
sys 0m10.360s

Nginx (have been cached):
real 0m21.070s
user 0m9.140s
sys 0m10.316s

RGW:
real 0m21.859s
user 0m8.850s
sys 0m10.386s

The results are showing that for objects larger than 512K the cache will increase the performance by twice or more.

For small objs, the overhead of sending the auth request will make the cache less efficient

The result for cached objects in the 10MB test can be explained by net limit of 25 Gb/s(it could reach more)

In Gdal (image decoder/encoder over s3 using range requests) the results were not that different because of Gdal single cpu encoding/decoding.
Gdal have been chosen because of the ability to check the smart cache of the nginx.
https://www.nginx.com/blog/smart-efficient-byte-range-caching-nginx/

Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2020-05-19 10:41:28 +03:00
J. Eric Ivancich
9d5e9c3031 doc/rgw: add docs for rgw-orphan-list and ceph-diff-sorted
Add man pages and documentation for both tools.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2020-05-04 13:33:56 -04: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
Sebastian Wagner
d231eb90ce doc: Move ceph-deploy docs to doc/install/ceph-deploy
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-03-13 15:52:41 +01:00
Matt Benjamin
69d2aa1960
Merge pull request #31994 from pritha-srivastava/wip-rgw-assume-role-web-id-doc
rgw: adding documentation for AssumeRoleWithWebIdentity.
2020-02-20 10:58:07 -05:00
Yehuda Sadeh
caac422445 rgw: sync policy doc
Signed-off-by: Yehuda Sadeh <yehuda@redhat.com>
2020-01-28 10:20:40 -08:00
Pritha Srivastava
83cb3a9646 rgw: adding documentation for AssumeRoleWithWebIdentity.
Signed-off-by: Pritha Srivastava <prsrivas@redhat.com>
2019-12-13 10:44:04 +05:30
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
Yuval Lifshitz
751c4514e0
Merge pull request #28971 from yuvalif/wip-yuval-pubsub-api2
rgw/pubsub: add S3 compliant API to master zone
2019-09-20 01:35:02 +03:00
Yuval Lifshitz
c345566831 rgw/pubsub: push notifications documentation
Signed-off-by: Yuval Lifshitz <yuvalif@yahoo.com>
2019-09-10 18:54:05 +03:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Casey Bodley
ddb45d332a
Merge pull request #26967 from qwren/qat-accel-doc
doc: QAT Acceleration for Encryption and Compression

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2019-05-28 13:08:32 -04:00
Qiaowei Ren
b866fb488f doc: QAT Acceleration for Encryption and Compression
This patch add the documentation about QAT acceleration for encryption
and compression and how to configure.

Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
2019-03-18 19:22:34 +08:00
Casey Bodley
8079db6a6d doc/rgw: document storage class configuration
Fixes: http://tracker.ceph.com/issues/38008

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2019-03-15 15:50:32 -04:00
Casey Bodley
c95585b198 doc/rgw: document placement target configuration
Fixes: http://tracker.ceph.com/issues/24508

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2019-03-15 15:50:32 -04:00
Pritha Srivastava
377b82ec44 rgw: Adding documentation for Roles.
Signed-off-by: Pritha Srivastava <prsrivas@redhat.com>
2018-10-24 13:04:51 +05:30
Pritha Srivastava
15efabc78d rgw: Adding documentation for STS Lite.
Signed-off-by: Pritha Srivastava <prsrivas@redhat.com>
2018-09-21 11:09:33 +05:30
Jos Collin
b19e239923
doc: add radosgw reference label
Added radosgw doc reference label

Fixes: http://tracker.ceph.com/issues/25185
Signed-off-by: Jos Collin <jcollin@redhat.com>
2018-07-31 09:06:21 +05:30
Ashutosh Narkar
631a036a6b Initial work for OPA-Ceph integration
Signed-off-by: Ashutosh Narkar <anarkar4387@gmail.com>
2018-07-25 01:20:34 -07:00
Yehuda Sadeh
0cf3e55c3c rgw: mfa documentation
Signed-off-by: Yehuda Sadeh <yehuda@redhat.com>
2018-04-09 07:02:17 -07:00
Abhishek Lekshmanan
640b2ae2ba doc: add sync modules to toc
Adding a seperate toc under sync modules for elastic, also renamed sync-plugins
to sync-modules

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2018-02-05 18:38:25 +01: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
Abhishek L
2a9cbc353f Merge pull request #15941 from oritwas/wip-rgw-dynamic-resharding-doc
rgw: Add dynamic resharding documentation

Reviewed-By: Abhishek Lekshmanan <abhishek@suse.com>
Reviewed-By: Alfredo Deza <adeza@redhat.com>
2017-10-16 15:58:58 +02:00
Orit Wasserman
4f3ab7cda0 rgw: Add dynamic resharding documentation
Fixes: http://tracker.ceph.com/issues/21553
Signed-off-by: Orit Wasserman <owasserm@redhat.com>
2017-10-15 15:02:46 +03:00
Kefu Chai
254e07441c doc: kill sphinx warnings
* doc/release-notes.rst: escape asterisks not used for inline emphasis
    fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
    not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Casey Bodley
3a6471a6e6 doc/rgw: update pool names, document namespaces
Fixes: http://tracker.ceph.com/issues/19504

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-06-16 13:32:11 -04:00
Casey Bodley
9cc834e1a0 doc/rgw: remove Upgrade to Older Versions of Jewel page
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-06-16 13:32:11 -04:00
Casey Bodley
cf8a3c19de doc/rgw: remove Federated Configuration page
Fixes: http://tracker.ceph.com/issues/18082

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-06-16 13:32:10 -04:00
Sage Weil
910405c19c Merge pull request #15133 from cbodley/wip-doc-rgw-remove-fcgi
doc/rgw: remove fastcgi page and sample configs

Reviewed-by: Sage Weil <sage@redhat.com>
2017-05-19 13:13:24 -05:00
Adam C. Emerson
80b285d329 rgw: Write documentation for bucket policies
Signed-off-by: Adam C. Emerson <aemerson@redhat.com>
2017-05-17 14:22:18 -04:00
Casey Bodley
4b338ce9bd doc/rgw: remove fastcgi page and sample configs
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-05-16 22:36:53 -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
John Wilkins
1eda9918f3 Clarified index.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-03-30 14:53:49 -07:00
Kefu Chai
74a84e9be3 doc: indent :maxdepth: using spaces in toc
* indent :maxdepth: directive properly, otherwise sphinx complains
   index.rst:45: WARNING: toctree contains reference to nonexisting
   document u'rados/configuration/    :maxdepth: 1'
* also reindent the entries in toc, so we can add paths without
  documenting their titles. because otherwise the paths inclues an extra
  space, without the proper indent.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:39:40 +08:00
Kefu Chai
a365999c99 docs/radosgw: fix sphinx warning
* upgrade_to_jewel.rst: silence following warning
  upgrade_to_jewel.rst:1: WARNING: Title overline too short.
* index.rst: add links to not-included docs
  add api.rst, layout.rst and upgrade_to_jewel.rst to toc
  silences warning like
  api.rst:: WARNING: document isn't included in any toctree

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:38:30 +08: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
Kefu Chai
a0297f5f60 doc/radosgw: remove reference of purge-temp.rst
purge-temp.rst was removed in 949f917.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-08-09 16:39:30 +08:00
Nathan Cutler
d788bae60d doc/radosgw: rename config.rst to config-fcgi.rst
This file documents how to configure RGW to use Apache/FastCGI, so rename
the file and modify the title and intro to make that clear.

Also, add a note that CGI can pose a security risk - e.g. http://httpoxy.org

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-21 14:17:08 +02:00
Pete Zaitcev
0e622020fa rgw: Add documentation for the Multi-tenancy feature
Signed-off-by: Pete Zaitcev <zaitcev@redhat.com>
2016-06-30 13:15:21 -06:00
Abhishek Lekshmanan
f78af6f38c doc: add multisite to index
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>
2016-04-15 22:27:10 +02:00
Neil Levine
ea66f5c9ee doc: RGW is "built on top of librgw" changed to "librados"
Signed-off-by: Neil Levine <levine@yoyo.org>
2015-02-16 14:54:09 -08:00
John Wilkins
a7e7219345 doc: Index update and librados.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-05-05 12:34:59 -07:00
John Wilkins
6650c0e839 doc: Added new docs to index.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-04-14 09:18:26 -07:00
John Wilkins
2fcaa1fcb2 pdatedoc: Added index link to new install doc. Requires merge of wip-doc-install to work.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-11-04 15:11:49 -08:00
John Wilkins
258396d556 doc: Added entry for federated configuration to the index.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-05 13:15:41 -07:00
John Wilkins
0f56e3ebb5 doc: Nomenclature update.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-08-05 13:44:20 -07:00
John Wilkins
7365d0c36d doc: Updated to reflect glossary usage.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-30 20:27:01 -07:00
John Wilkins
fe164e4438 doc: Republishing the admin operations API for the gateway.
fixes: #4978

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-09 12:08:28 -07:00
Yehuda Sadeh
6a8a58dc4b doc: document swift compatibility
Add a table that specifies swift features compatibility

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-12-11 17:07:37 -08:00