Commit Graph

670 Commits

Author SHA1 Message Date
zdover23
2f3f05a130
Merge pull request #36954 from HeinleinSupport/wip-doc-remove-ceph-deploy
doc: remove references to ceph-deploy

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-09-04 07:15:35 +10:00
J. Eric Ivancich
5e20e9c99a
Merge pull request #33942 from pritha-srivastava/rgw-sts-new-keycloak-examples
rgw: Updating STS document with references to new keycloak

Reviewed-by: Matt Benjamin <mbenjami@redhat.com>
2020-09-03 13:12:59 -04:00
Casey Bodley
1e4e394699
Merge pull request #36218 from mkogan1/wip-cache-put-post
rgw: add PUT and POST req support to data cache

Reviewed-by: Or Friedmann <ofriedma@redhat.com>
Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
2020-09-03 10:38:17 -04:00
ypdai
0bfca9fc8e
doc: Update multisite-sync-policy.rst
Signed-off-by: ypdai <self19900924@gmail.com>
2020-09-03 10:51:01 +08:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.

Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
2020-09-02 21:14:36 +02:00
Vikhyat Umrao
4628a28f35
Merge pull request #36883 from mhackett/wip-mhackett-47190
doc: document tuning of radosgw lifecycle
2020-09-02 08:50:03 -07:00
Casey Bodley
71e6f5361c
Merge pull request #34293 from yuvalif/notifications_persistent_delivery2
rgw/notifications: add persistent delivery to notifications

Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-09-02 09:35:57 -04:00
Kefu Chai
2782ba21ab
Merge pull request #36879 from tchaikov/wip-doc-stable-release
doc: bump up sphinx to 3.2.1 and define "stable-release" global substitution

Reviewed-by: Willem Jan Withagen <wjw@digiware.nl>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-09-01 11:04:23 +08:00
Kefu Chai
5238f9f62b doc: fix broken hyper link
and always reference multisite.rst using tha label not the file.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-01 09:53:18 +08: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
Qiaowei Ren
6488e116c3 doc: update QATzip doc for removing snappy and lz4 support
This patch update the documentation about QAT acceleration for encryption
and compression.

QATZip provide the interfaces for several compression algorithm, including
deflate, snapp and lz4, but currently only deflate can be accelerated by QAT
hardware.

Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
2020-08-25 15:39:47 +08:00
Yuval Lifshitz
898536b5e3 rgw/notification: documentation for persistent notifications
Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-08-19 21:33:05 +03:00
Mark Kogan
6251d2b6c1 rgw: add PUT and POST req support to data cache
facilitates the full usage of the Nginx cache endpoint
with s3 tools that support AWSv4
like s3cmd,aws-cli, benchmarking tools like hsbench
and also hadoop/s3a.

Co-authored-by: Or Friedmann <ofriedma@redhat.com>
Signed-off-by: Mark Kogan <mkogan@redhat.com>
2020-07-21 15:23:57 +03:00
Matt Benjamin
d9f5c1cc1d
Merge pull request #35481 from pritha-srivastava/wip-rgw-keycloak-doc-correction
rgw/sts: Removing references to token introspection url,
2020-07-09 07:48:16 -04:00
Andreas Unterkircher
41f26bffe2 rgw: add a doc hint that the topic-name is used as AMQP routing-key
Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-07-07 11:23:41 +03:00
wangyunqing
852a1f653f doc/radosgw/archive-sync-module.rst: fix url of "Multisite Configuration"
Signed-off-by: wangyunqing <wangyunqing@inspur.com>
2020-06-28 16:06:14 +08:00
Matt Benjamin
a094e84158
Merge pull request #33228 from galsalomon66/s3select_integration_into_RGW_2
rgw: add s3select support
2020-06-25 11:05:22 -04:00
Casey Bodley
2a9a479f35
Merge pull request #35331 from yuvalif/fix_issue_43536
rgw/pubsub: remove deprecated radogw-admin pubsub creation commands

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-06-24 10:58:31 -04:00
gal salomon
61d6813726 adding s3select sub-module; integrating sub-module into RGW; current commit is able to run s3-select queries on CSV-s3object;
Signed-off-by: gal salomon <gal.salomon@gmail.com>
2020-06-23 05:19:02 +03:00
Kefu Chai
23e5359f02
Merge pull request #35317 from dsavineau/doc_radosgw_key_typo
doc/radosgw/admin: fix key subuser typo

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-06-16 09:41:27 +08:00
Yuval Lifshitz
4c486c32c6 rgw/pubsub: remove deprecated radogw-admin pubsub creation commands
make topic and subscription read commands an official feature

Fixes: https://tracker.ceph.com/issues/43536

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-06-09 11:56:46 +03:00
Pritha Srivastava
a9a608ce20 rgw/sts: Removing references to token introspection url,
client id and client password.

Signed-off-by: Pritha Srivastava <prsrivas@redhat.com>
2020-06-08 21:25:12 +05:30
J. Eric Ivancich
28956affe2
Merge pull request #32393 from clwluvw/opa-access-key
rgw: Add subuser to OPA request

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-06-06 15:10:55 -04:00
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
Sebastian Wagner
10b4f7a6d8 doc/cephadm: Adopt single-site RGW
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-06-05 12:55:15 +02:00
Casey Bodley
3f922a5a84
Merge pull request #33646 from ofriedma/wip-mkogan-ofriedma-add-cache-api
rgw: Adding data cache and CDN capabilities

Reviewed-by: Mark Kogan <mkogan@redhat.com>
Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-06-04 12:11:11 -04:00
ofriedma
d73b879ac1 rgw: fix nginx-rgw docs
Signed-off-by: Or Friedmann <ofriedma@redhat.com>

Signed-off-by: Mark Kogan <mkogan@redhat.com>
2020-06-01 12:24:19 +03:00
Dimitri Savineau
55b687a624 doc/radosgw/admin: fix key subuser typo
The subuser parameter needs two dashes.

Signed-off-by: Dimitri Savineau <dsavinea@redhat.com>
2020-05-29 13:47:56 -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
Or Friedmann
94c81f3094 rgw: create rgw-cache example directory
Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2020-05-19 10:41:28 +03:00
Or Friedmann
892e9fa5fe rgw: fix nginx cache docs
Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2020-05-19 10:41:28 +03:00
Or Friedmann
a4ae27242a fix docs
Signed-off-by: Or Friedmann <ofriedma@redhat.com>
2020-05-19 10:41:28 +03:00
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
Casey Bodley
90dfff94ad
Merge pull request #34764 from ianwatsonrh/master
Docs: vault kv and transit engine updates

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-05-15 15:08:55 -04: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
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
Casey Bodley
e68c60ac73
Merge pull request #34376 from yuvalif/fix_amqp_routable_option
rgw/amqp: fix the "routable" delivery mode

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-05-01 09:00:01 -04: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
Yuval Lifshitz
a13aeafe30 rgw/doc: clarify topic creation format
also, fix some typos, and 'push-endpoint' parameter

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-04-21 14:08:28 +03:00
Yuval Lifshitz
73db460e52 rgw/amqp: fix the "routable" delivery mode
this option was not exposed to the configuration API
however, it was still set, as hardcoded value in the code
(details:
https://www.rabbitmq.com/confirms.html#publisher-confirms)

Fixes: https://tracker.ceph.com/issues/44915

Signed-off-by: Yuval Lifshitz <yuvalif@yahoo.com>
2020-04-19 10:25:56 +03:00
Kefu Chai
f5e52438af
Merge pull request #34228 from shonpaz123/add_notifications_documentation
doc/rgw: add documentation for bucket notifications filters and supported push endpoints

Reviewed-by: Yuval Lifshitz <yuvalif@yahoo.com>
2020-04-15 07:51:34 +08:00
Kefu Chai
f05fe55bb7
Merge pull request #34265 from shonpaz123/add_sc_doc
doc/rgw: add documentation for allowed storage classes for client SDKs

Reviewed-by: Or Friedmann <ofriedma@redhat.com>
2020-04-15 07:46:55 +08: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
Seena Fallah
793aaaaed9 rgw: Add subuser to OPA request
Signed-off-by: Seena Fallah <seenafallah@gmail.com>
2020-04-09 00:15:20 +04:30
Shon Paz
ba6fa84538 doc/rgw: add documentation for allowed storage classes for client SDKs
When trying to use AWS S3 SDKs with a non-default storage class, clients should call their storage class as one of the generic storage class names provided by Amazon (such as STANDARD_IA, ONEZONE_IA, GLACIER etc), or else the SDK will drop the request complaining the storage class name is not allowed

jenkins render docs

Signed-off-by: Shon Paz <spaz@redhat.com>
2020-03-28 16:10:53 +03:00
Shon Paz
9d202c89c1 doc/rgw: add documentation for bucket notifications filters and supported push endpoints
We already have Kafka supported as a push endpoint (has been merged lately), in addition it is important to know that although we have extra filters AWS S3 notifications doesn't have, it will cost in extending the AWS SDKs with the new capabilities.

Signed-off-by: Shon Paz <spaz@redhat.com>
2020-03-28 14:20:35 +03:00
Shon Paz
fd884a9ce8 doc/rgw: add documentation for bucket notifications filters and supported push endpoints
We already have Kafka supported as a push endpoint (has been merged lately), in addition it is important to know that although we have extra filters AWS S3 notifications doesn't have, it will cost in extending the AWS SDKs with the new capabilities.

Signed-off-by: Shon Paz <spaz@redhat.com>
2020-03-27 00:36:19 +02:00
Casey Bodley
761e59e57c
Merge pull request #33917 from yuvalif/fix_bucket_notification_json_format
rgw/pubsub: invalid json format in bucket notification example

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2020-03-24 14:08:11 -04:00
Xie Xingguo
ec404a9a9e
Merge pull request #34070 from bangmingcheng/wip-doc-ceph-chenbm
doc: fix a spelling error at /doc/radosgw/dynamicresharding.rst

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-03-21 09:01:29 +08:00