Commit Graph

21 Commits

Author SHA1 Message Date
Michael Fritch
e1023aa65e
doc/rgw: update to python3 print syntax
python3 requires parens for a `print` statement

Signed-off-by: Michael Fritch <mfritch@suse.com>
2021-04-15 15:38:16 -06: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
Matthew Oliver
9f40b38d3e doc: Add a RGW swift auth note
Swift accounts are not like normal accounts, they are more akin to a
bank account that multile people could share. Or in the case of a cloud
it is usually mapped to the tenant.

Radosgw deals with this with a user and subuser, which is great, but a
little confusing. So this patch adds a note to those used to the Swift
API to make it more clear.

Signed-off-by: Matthew Oliver <moliver@suse.com>
2020-01-02 00:32:01 +00: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
J. Eric Ivancich
6da5a5888c rgw: ability to list bucket contents in unsorted order for efficiency
Add the ability to list the contents of a bucket without the results
being sorted. This can have performance benefits since all bucket
shards do not need to be queried. This is done by adding a parameter
to the REST query string (i.e., "allow_unordered" [note underscore]
for swift or "allow-unordered" [note hyphen] for s3) to true.

This works with other request parameters such as marker, end_marker,
and prefix. But it does not work when delimeter is used. Also, because
the results are not in order, a subsequent marker may precede an
earlier marker.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2018-04-11 13:01:03 -04:00
John Wilkins
60e6cf509c doc/rgw: Removed contractions for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:54:37 -07:00
hrchu
39d67a5ae4 doc: rgw: Rewrite Java swift examples
cloudfiles is both unavailabe in maven and github.
Rewrite examples with joss.

Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-31 21:14:53 +08:00
SirishaGuduru
ac3b85319c doc: Fixes radosgw-admin ex: in swift auth section
In the swift authentication page, an example is
provided for creating a new user with radosgw-admin.
This example creates a user, but afaict, doesn't
create a user which can access swift (at any rate,
with out further actions).

Fixes: #16687
Signed-off-by: SirishaGuduru <SGuduru@walmartlabs.com>
2016-12-23 15:03:50 +05:30
Uday Mullangi
5af460091c doc: correcting the object name
Signed-off-by: umullangi@walmartlabs.com
2016-12-07 11:47:20 +05:30
Diwakar Goel
9688587cbf doc:Correcting the sample python tempurl generation script
Fixes: http://tracker.ceph.com/issues/15258
Signed-off-by: Diwakar Goel <diwakargoel@gmail.com>
2016-06-04 20:52:40 -07:00
Yehuda Sadeh
ea0302b7a9 Merge pull request #3648 from theanalyst/doc/swift-temp-url
doc: swift tempurl functionality

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2015-02-20 13:03:00 -08:00
Dmytro Iurchenko
cdfc23f0e2 rgw: fix doc, A typo in command line argument name
Signed-off-by: Dmytro Iurchenko <diurchenko@mirantis.com>
2015-02-10 09:18:01 -08:00
Abhishek Lekshmanan
baaa055042 doc: swift tempurl functionality
Adding documentation for swift tempurl functionality along with a
snippet to generate the temporary url, since the swift temp-url binary
will not work out of the box with radosgw as the path expected is
different

Fixes: #10184
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2015-02-10 16:59:52 +05:30
Dmytro Iurchenko
8cbfac4207 Wrong HTTP header name
According to http://docs.openstack.org/api/openstack-object-storage/1.0/content/POST_updateObjectMeta__v1__account___container___object__storage_object_services.html#POST_updateObjectMeta__v1__account___container___object__storage_object_services-Request setting metadata to an object  needs X-Object-Meta-{key}  rather than X-Container-Meta-{key}.

Signed-off-by: Dmytro Iurchenko <diurchenko@mirantis.com>
2015-01-21 17:37:28 +02:00
Tim Freund
19955fca53 doc: Replace cloudfiles with swiftclient in Python Swift example
The Cloud Files client library is no longer supported by Rackspace.
Users installing the package receive the following warning:

DeprecationWarning: python-cloudfiles has been deprecated as of August
1, 2013. Please see https://github.com/openstack/python-swiftclient.

This commit updates the documentation to use the python-swiftclient
package.

Signed-off-by: Tim Freund <tim@freunds.net>
2015-01-09 21:50:11 -05:00
John Wilkins
b965398980 doc: Fixed broken hyperlink.
Fixes: #9116

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-28 17:45:51 -07:00
Danny Al-Gaaf
d1a888e0f2 swift/containerops.rst: fix some typos
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2014-03-09 01:02:43 +01:00
John Wilkins
fb4cba4bd5 doc: Removed this doc. Nothing referenced it, and parent directory echoes content.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-17 18:32:59 -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
John Wilkins
4e1d973e46 doc: Fixed heading text.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-07-18 07:35:35 -07:00
John Wilkins
3a377c44e1 doc: Overhauled Swift API documentation.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-07-17 21:28:59 -07:00