Commit Graph

445 Commits

Author SHA1 Message Date
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
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
Drunkard Zhang
63855e381e doc: add hyperlink on ACL settings
The link listed at bottom but never used, I think it's missed by author.

Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-16 20:32:29 +08:00
Drunkard Zhang
0f811b3d5d doc: typo fixes in doc/radosgw/multisite
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-16 20:20:49 +08:00
Kefu Chai
7b676f4f0f Merge pull request #14384 from hrchu/radosgw-admin-key
doc: rgw: Rewrite the key management

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-28 23:32:16 +08:00
Yehuda Sadeh
4db11779a8 Merge pull request #14803 from hrchu/rgwadmin-api-doc-usage-conf
doc: rgw: note rgw_enable_usage_log option in adminops guide

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2017-04-27 08:42:09 -07:00
hrchu
e7896f6858 doc: rgw: note rgw_enable_usage_log option in adminops guide
Signed-off-by: hrchu <petertc@gmail.com>
2017-04-27 00:52:24 +00:00
Kefu Chai
4b12805914 Merge pull request #13824 from Jing-Scott/doc-update-swift-static-web
doc: update the support status of swift static website

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-04-27 00:17:49 +08:00
hrchu
e922a98daa doc: rgw: Get user usage needs to specify user
Signed-off-by: hrchu <petertc@gmail.com>
2017-04-26 10:47:58 +00:00
hrchu
a1a0dcfa40 doc: rgw: Rewrite the key management
The create/remove key section in the doc is a bit confusing.
Rewrite it and give more examples.

Signed-off-by: hrchu <hrchu@cht.com.tw>
2017-04-26 14:55:32 +08:00
Sage Weil
1919297826 Merge pull request #14494 from drunkard/master
doc: two minor fixes
2017-04-25 12:11:03 -05:00
Peter Maloney
3c08894fe0 doc: fix link that pointed to a nonexistent file
commit d788bae60d renamed config.rst to config-fcgi.rst

Reported-by: fusl in #ceph on irc.oftc.net
Signed-off-by: Peter Maloney <peter.maloney@brockmann-consult.de>
2017-04-23 20:33:03 +02:00
Casey Bodley
2b341bfd62 Merge pull request #14335 from hrchu/radosgw-admin-api-subuser
doc: rgw: Clean up create subuser parameters

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-22 11:49:05 -04:00
Casey Bodley
07b1c0dfc8 Merge pull request #14268 from hrchu/swift/java
doc: rgw: Rewrite Java swift examples

Reviewed-by: Orit Wasserman <owasserm@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-21 11:17:14 -04:00
Casey Bodley
9a0f17b6f4 Merge pull request #14055 from hrchu/radosgw-admin-api-user-caps
doc: correct and improve add user capability section

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-21 10:54:55 -04:00
Casey Bodley
a510acfe78 Merge pull request #13956 from hrchu/rgw-admin-doc
Indicate how to add multiple admin capbabilies

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-21 10:52:28 -04:00
Casey Bodley
307060e010 Merge pull request #14372 from hrchu/rgwadmin-admin-doc-usage
doc: rgw: correct get usage parameter default value

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2017-04-21 10:50:55 -04:00
Casey Bodley
6a1e10fdff Merge pull request #13483 from ceph/wip-rgw-encryption-doc
doc: rgw server-side encryption and barbican

Reviewed-by: Adam C. Emerson <aemerson@redhat.com>
2017-04-18 12:27:27 -04:00
Kefu Chai
125f27e3e8 Merge pull request #10851 from atheism/rgw-s3-doc-update
doc/radosgw/s3/cpp.rst: update usage of libs3 APIs to make the examples work

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-04-14 10:18:10 +08:00
Drunkard Zhang
3c70331d6b doc: indent style fixes
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-04-13 12:51:44 +08:00
Hans van den Bogert
b26f62265b doc: rgw: remove mention of megabytes for quotas
Remove mention of confusing reference to megabytes in opening paragraph of "quota management".
To remove further confusion, mention that setting a size for '--max-size' is in bytes by default.

Signed-off-by: Hans van den Bogert <hansbogert@gmail.com>
2017-04-09 13:40:29 +02:00
hrchu
9a29d8c0af doc: rgw: correct get usage parameter default value
Signed-off-by: hrchu <petertc@gmail.com>
2017-04-06 15:06:31 +00:00
Harald Klein
864db8e5ee add RGW ldap auth documentation
Signed-off-by: Harald Klein <hari@vt100.at>
2017-04-05 12:01:48 +02:00
hrchu
26393de17d doc: rgw: Clean up create subuser parameters
"gen-subuser" is unavailable, remove it. Hence, "subuser" is required.

Signed-off-by: hrchu <hrchu@cht.com.tw>
2017-04-05 14:08:05 +08:00
Casey Bodley
8e31c002e3 doc/rgw: update section on global quotas
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-04-03 14:48:58 -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
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
John Wilkins
925f290023 Ported the downstream (and tested) document upstream.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-03-30 14:54:42 -07:00
John Wilkins
1eda9918f3 Clarified index.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-03-30 14:53:49 -07:00
Casey Bodley
4b73fcb070 Merge pull request #14122 from hrchu/rgwadmin-doc-quota
doc: correct the quota section

Reviewed-by: Daniel Gryniewicz <dang@redhat.com>
2017-03-29 10:38:16 -04:00
hrchu
51a88267f0 doc: rgw: correct the quota section
Add the missing option and fix typo.

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

Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-29 02:17:04 +00:00
Casey Bodley
d515057646 doc/rgw: instructions for changing multisite master zone
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2017-03-22 12:42:49 -04:00
Kefu Chai
b935248197 Merge pull request #13997 from tchaikov/wip-doc-fixings
doc:  fixes to silence sphinx-build

Reviewed-by: Brad Hubbard <bhubbard@redhat.com>
2017-03-21 11:46:12 +08:00
hrchu
6d49b7c438 doc: correct and improve add user capability section
- "user-caps" should be located in the request parameter instead of body in example
 - Indicate how to add multiple admin capbabilies

Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-21 09:44:17 +08:00
hrchu
fffe28f217 doc: Indicate how to add multiple admin capbabilies
Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-17 08:53:32 +08: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
hrchu
4e5ad2e697 doc: add bucket-id to link bucket in adminops.rst
The link bucket operation requires the bucket-id parameter.

Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-03-10 09:35:47 +08:00
Jing Wenjun
6344072b65 doc: update the support status of swift static website
the feature of static website in Swift API is supported now.

Signed-off-by: Jing Wenjun <jingwenjun@cmss.chinamobile.com>
2017-03-07 15:20:45 +08:00
Abhishek Lekshmanan
a47bcf70c9
doc: rgw: make a note abt system users vs normal users
Mention that system users don't behave like normal users in context of
normal rest operations

Fixes: http://tracker.ceph.com/issues/18889
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2017-02-16 17:40:50 +01: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
Yehuda Sadeh
fc9a03ec4f Merge pull request #12646 from SirishaGuduru/swift-api-auth-doc-change
doc: Fixes radosgw-admin ex: in swift auth section

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2017-01-30 08:36:32 -08:00
liuchang0812
fbe7c32ae5 doc: correct S3 lifecycle support explain
Fixes: http://tracker.ceph.com/issues/18459

Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2017-01-18 17:56:11 +08:00
hrchu
70a7ef99bb doc: Update keystone.rst
Make it clear that project/domain options accept name instead of id.

Signed-off-by: Chu, Hua-Rong <hrchu@cht.com.tw>
2017-01-03 09:27:13 +00: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
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
Uday Mullangi
5af460091c doc: correcting the object name
Signed-off-by: umullangi@walmartlabs.com
2016-12-07 11:47:20 +05:30
Ken Dreyer
7b0ba9d323 doc: fix capitalization in RGW admin ops
lower-case second word in this sentence.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-12-05 11:59:14 -07:00
Kefu Chai
78b03e3af2 Merge pull request #11987 from Liuchang0812/patch-2
doc: Update layout.rst, move commands to CODE block

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Alfredo Deza <adeza@redhat.com>
2016-12-04 20:21:56 +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
Orit Wasserman
3c8711e613 rgw: add documentation for upgrading with rgw_region_root_pool
Signed-off-by: Orit Wasserman <owasserm@redhat.com>
2016-11-28 16:34:02 +01:00
whu_liuchang
525331bff1 doc: moves commands to the Code block
* move commands to the Code block, make document more clear
* change `metadata/bucket index/data` items to subsubtitle
* use itemize list for commands varibales, fix the problem that all variables comments appear in one line.

Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2016-11-18 04:38:27 +00:00
Orit Wasserman
6d8f7bfe59 rgw: add recovery procedure for upgrade to older version of jewel
Fixes: http://tracker.ceph.com/issues/17820
Signed-off-by: Orit Wasserman <owasserm@redhat.com>
2016-11-14 15:36:45 +01:00
Yehuda Sadeh
8cb3a5d42f Merge pull request #11392 from Oloremo/keystone_docs
Update keystone doc about v3 options

Reviewed-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2016-11-11 15:40:47 -08:00
Kefu Chai
8fd95430fe doc: add doc for pybind of rgw
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-11-09 21:07:29 +08:00
Yehuda Sadeh
ace03b97ab Merge pull request #8712 from diwakargoel/master
doc: Correcting the sample python tempurl generation script.

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2016-11-07 10:41:04 -08:00
Kefu Chai
6478a3dd1d Merge pull request #11617 from umullan/brokenlinks
doc: Fixing the broken hyperlinks by pointing to correct documentation.

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-11-04 01:03:10 +08:00
Orit Wasserman
40ba752410 Merge pull request #11494 from aclamk/wip-rgw-compression
[RGW] Wip rgw compression
Reviewed-by: Orit Wasserman <owasserm@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2016-11-03 17:25:02 +01:00
Weibing Zhang
654112000e doc: rgw: fix a typo in S3 java api example
ObjectSummary.getSize() should be objectSummary.getSize()

Signed-off-by: Weibing Zhang <zhangweibing@unitedstack.com>
2016-11-03 18:23:02 +08:00
Uday Mullangi
7c7395c1cc doc: Fixing the broken hyperlinks by pointing to correct documentation.
Signed-off-by: umullangi@walmartlabs.com
2016-11-03 14:55:12 +05:30
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
Orit Wasserman
63e86e542e Merge pull request #11280 from ceph/wip-17440
rgw: fixes for virtual hosting of buckets
Reviewed-by: Orit Wasserman <owasserm@redhat.com>
2016-11-01 10:14:13 +01:00
Casey Bodley
90b8196b4b Merge pull request #11269 from yehudasa/wip-multipart-uploads-cp
rgw: multipart upload copy

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2016-10-12 14:48:28 -04:00
Proskurin Kirill
d869df59e9 Update keystone doc about v3 options
Signed-off-by: Proskurin Kirill <kproskurin@mirantis.com>
2016-10-11 09:12:44 +00:00
Yehuda Sadeh
1b90ab375e Merge pull request #11127 from SirishaGuduru/multitenancy-doc-change
Changed config parameter "rgw keystone make new tenants" in radosgw multitenancy

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2016-10-05 09:07:17 -07:00
Yehuda Sadeh
086cebc9a3 Merge pull request #10159 from mhackett/wip-mhackett-16604
doc: add rgw_enable_usage_log option in Rados Gateway admin guide

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2016-10-05 09:04:02 -07:00
Yehuda Sadeh
a173427232 Merge pull request #10641 from weiqiaomiao/wqm-wip-rgw-s3api
doc/radosgw: fix description of response elements 'Part'

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2016-10-05 08:55:34 -07:00
Yehuda Sadeh
5b3cd2efbe Merge pull request #10223 from mikulely/doc-s3-static-website-support
doc: update s3 static webiste feature support status

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-10-04 17:12:30 -07:00
Casey Bodley
36203c28ba doc: configuring virtual hosted buckets for radosgw
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2016-10-03 14:25:23 -04:00
Javier M. Mellid
8a7ebeee2f rgw: doc: add multipart uploads copy part feature as supported
Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
2016-09-28 17:12:28 -07:00
SirishaGuduru
bd9695d50c doc: Radosgw multitenancy config paramater change
Radosgw multitenancy configuration parameter
"rgw keystone make new tenants" never works even
applied. When gone through the code, itseems this
parameter is not used. But "rgw keystone implicit
tenants" works as the code looks for this.

Modified the configuration parameter in two files
mentioned below from "rgw keystone make new tenants"
to "rgw keystone implicit tenants"

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

Signed-off-by: SirishaGuduru <SGuduru@walmartlabs.com>
2016-09-19 12:06:36 +05:30
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
zhangweibing
0d96dec971 doc/radosgw/s3/cpp.rst: update usage of libs3 APIs to make the examples work
Signed-off-by: Weibing Zhang <zhangweibing@unitedstack.com>
2016-08-25 11:14:38 +08:00
Casey Bodley
dce782ce92 Merge pull request #10676 from Yan-waller/yj-wip-rgwdocmultisite
rgw/doc: fix indent

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2016-08-12 14:57:23 -04:00
Yan Jun
e001e67897 rgw/doc: fix typo and indent.
Signed-off-by: Yan Jun <yan.jun8@zte.com.cn>
2016-08-12 09:28:43 +08:00
weiqiaomiao
9c3fe46a7e doc/radosgw: fix description of response elements 'Part'
Signed-off-by: weiqiaomiao <wei.qiaomiao@zte.com.cn>
2016-08-10 14:11:43 +08:00
Kefu Chai
a9bf4869de doc/radosgw: fix the table formatting
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-08-09 16:39:30 +08: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
Yehuda Sadeh
05f634c9b7 Merge pull request #10331 from rzarzynski/wip-rgw-keystone-doc-fix
rgw, doc: fix formatting around Keystone-related options.

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-07-22 13:13:13 -07: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
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
Jiaying Ren
3a148db3f0 doc: update s3 static webiste feature support status
As 7e0a7a3d44 has been merged, static
website is supported now.

Signed-off-by: Jiaying Ren <jiaying.ren@umcloud.com>
2016-07-09 15:25:37 +08:00
Mike Hackett
3564ee3c06 doc: add rgw_enable_usage_log option in Rados Gateway
admin guide

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

Signed-off-by: Mike Hackett <mhackett@redhat.com>
2016-07-07 10:31:50 -04: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
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
Orit Wasserman
7554ef048d Merge pull request #9188 from rzarzynski/wip-rgw-swift-versioning-new-2
rgw: improve support for Swift's object versioning.
Reviewed-by: Orit Wasserman <owasserm@redhat.com>
2016-06-20 12:36:53 +02:00
Yan Jun
32de201aee doc/rgw: correct radosgw-admin command name
Signed-off-by: Yan Jun <yan.jun8@zte.com.cn>
2016-06-06 19:46:53 +08:00
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
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
Yehuda Sadeh
9661bbbbd7 Merge pull request #9060 from mikulely/fix-rgw-multiste-doc
doc: fix rgw multiste config

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-06-02 08:52:42 +03:00
Vikhyat Umrao
62eec902c7 rgw: support size suffixes for --max-size in
radosgw-admin command

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

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2016-05-26 23:01:26 +05:30
Vikhyat Umrao
949f917af8 rgw : cleanup radosgw-admin temp command as it was deprecated
and also implementation code for this command was removed in commit
8d7c8828b0

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

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2016-05-26 15:43:41 +05:30
Orit Wasserman
02e84e8964 Merge pull request #8533 from theanalyst/rgw/rest-user-get
rgw_rest_admin: return -EINVAL for improper user info requests
Reviewed-by: Orit Wasserman <owasserm@redhat.com>
2016-05-24 20:18:03 +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
Jiaying Ren
c1be48dd14 doc: improve rgw multiste config
1. fix typos
2. fix wrong indent
3. misc cosmetic improvements

Signed-off-by: Jiaying Ren <jiaying.ren@umcloud.com>
2016-05-23 12:15:08 +08:00
Javier M. Mellid
4003c2fe57 rgw: doc: bucket request payment update
S3 doc update.

The bucket request payment feature is available in Jewel

commits:

899d7754fe
461bd7fa08

Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
2016-05-19 11:22:40 +02:00
Kefu Chai
ba5b40c0ce Merge pull request #8955 from xiexingguo/xxg-wip-docrgw
doc/rgw: fix typo, abbreviation error etc.

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-05-11 20:09:58 +08: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
xie xingguo
4c58365ca3 doc/rgw: fix hyperlinks which can't work
Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-05-06 13:44:19 +02:00
xie xingguo
0210745309 doc/rgw: hyperlink of "Ceph Object Gateway" doesn't work
Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-05-06 13:44:19 +02: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
xie xingguo
1633c7d36d doc/rgw: fix typo, abbreviation error etc.
Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-05-06 09:31:03 +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
Abhishek Lekshmanan
d0eeb62480 doc:explain service tenant config for rgw keystone
Explain the configuration of `rgw keystone admin user`, tenant and
password which avoids the need for setting the keystone admin token
shared secret in ceph configuration, since this token is recommended to
be disabled in production environments.

Fixes: #13066, #13519
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-25 17:48:33 +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
Casey Bodley
2dd8942c71 Merge pull request #8664 from theanalyst/doc/rgw/fix-multisite-zone
doc: multisite: fix json output for zone create
2016-04-20 10:33:05 -04:00
Abhishek Lekshmanan
ec6ff4d5e8 doc: mutlisite: fix json output for zone create
creation of ``us-west`` was wrongly showing ``us-east-2`` output

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-20 12:53:55 +02:00
Abhishek Lekshmanan
88369e298b doc: rgw multisite, add pools section & minor cosmetic improvements
`Pool Configuration` was mentioned previously but didn't contain any
info, adding this section and minor cosmetic changes to a few headings
after looking at the html view.

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-19 11:02:22 +02: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
Abhishek Lekshmanan
c2e4106bbf doc: rgw multisite documentation
Adding basic documentation for new multisite features, with an example
showing 3 zones in a zonegroup.

Fixes: http://tracker.ceph.com/issues/15247
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-15 22:25:55 +02:00
Abhishek Lekshmanan
a803f0e3be doc: rgw_adminops uid is required for UserInfo requests
Specify that uid is a required param for GET /admin/user requests

Fixes: http://tracker.ceph.com/issues/15455
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-04-11 15:17:28 +02:00
Kris Jurka
0a622e6054 doc: rgw admin uses "region list" not "regions list" 2016-04-08 21:47:28 -07:00
Vikhyat Umrao
418d9bebda doc: rgw_region_root_pool option should be in [global]
add new option rgw_zonegroup_root_pool from Jewel.

Fixes: #15244

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2016-03-23 17:34:13 +05:30
Pete Zaitcev
e9259486de rgw: Allow an implicit tenant in case of Keystone
This, unfortunately, introduces possible double lookups, but
they should be cached. Also, the logic appears somewhat convoluted,
although the intent is quite simple: if you're an OpenStack user
with a Keystone authentication, we allow an implicit tenant of
the same name as the user.

Signed-off-by: Pete Zaitcev <zaitcev@redhat.com>

Conflicts:
	src/rgw/rgw_swift.cc
2016-03-15 16:48:00 -07:00
Pete Zaitcev
bb9f5ab1b4 rgw: Allow to serve Swift off the URL root
In most public clouds OpenStack Swift URL is based on the tree
root, like:
  https://swift.domain.com/v1/AUTH_tenant

Our convention is to have a path, like:
  https://domain.com/swift/v1/AUTH_tenant

The path is configurable, but even if someone manages to set
an empty prefix, we print headers with %s/%s/v1 where the extra
slash is baked in. In addition, the empty prefix means "use the
/swift default".

To provide compatibility, this patch uses a trick. The empty
prefix remains to mean "/swift", but then we use "/" (one slash)
to create the needed empty prefix.

Signed-off-by: Pete Zaitcev <zaitcev@redhat.com>
2016-03-14 09:29:44 -06:00
Abhishek Lekshmanan
ea9cb4fffa doc: rgw explain keystone's verify ssl switch
Adding info about `rgw keystone verify ssl` to configuration reference,
also adding a note in rgw keystone to explain the usage.

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-03-01 12:49:51 +01:00
Sage Weil
1d2948fdcc Merge pull request #7027 from mathslinux/fix-s3-csharp-doc
doc: fix S3 C# example
2016-01-29 08:46:47 -05:00
Sage Weil
428805adf9 Merge pull request #6930 from wido/rgw-key-docs
doc: use 'ceph auth get-or-create' for creating RGW keyring

Reviewed-by: Sage Weil <sage@redhat.com>
2016-01-29 08:45:16 -05:00
Dunrong Huang
41fcd877c1 doc: s/InvalidCap/InvalidCapability
InvalidCapability is more readable

Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-24 20:37:19 +08:00
Dunrong Huang
29f9d10ea9 doc: add missing semicolon
Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-23 15:57:22 +08:00
Dunrong Huang
be55a275de doc: s/Bucket/BucketName
from amazon s3 documentaion, the name shoule be BucketName rather than Bucket.

Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-23 15:35:12 +08:00
Dunrong Huang
dd065d890b doc: update SetACL API
Since v2 and later version, SetACLRequest() and SetACL() were removed,
and replaced by PutACLRequest() and PutACL()

Reference:
http://docs.aws.amazon.com/sdkfornet/latest/apidocs/items/MS3_S3PutACL_PutACLRequestNET4_5.html
http://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/MS3_S3PutACL_PutACLRequest.html

Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-23 15:24:03 +08:00
Dunrong Huang
d46297e7d8 doc: s/ListBucketResponse/ListBucketsResponse
From following documentation:
  - http://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/MS3ListBucketsResponsector_.html
  - http://docs.aws.amazon.com/sdkfornet/latest/apidocs/items/TS3ListBucketsResponse_NET4_5.html
the correct class name is ListBucketsResponse.

Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-23 15:15:43 +08:00
Dunrong Huang
fd6fca7f28 doc: `Amazon.AWSClientFactory' is obsolete
From http://blogs.aws.amazon.com/net/post/Tx2JT7AYCL2F6CB/ , Amazon.AWSClientFactory was removed

Signed-off-by: Dunrong Huang <riegamaths@gmail.com>
2015-12-23 12:09:53 +08:00
Orit Wasserman
cacc38e9cc Merge pull request #7005 from YankunLi/patch-4
delete default zone
2015-12-22 16:26:13 +01:00
YankunLi
4dd86ca93e correct radosgw-admin command
the command to disable users quota should be 'radosgw-admin quota disable --quota-scope=<user | bucket> --uid=<uid>'
2015-12-22 13:56:50 +08:00
YankunLi
b1df12c000 delete default zone
if the default zone exist, delete the default zone from both the east and west pools.
2015-12-22 13:46:13 +08:00
Wido den Hollander
f4a077c72d doc: Use 'ceph auth get-or-create' for creating RGW keyring
This saves us a lot of steps which the old documentation took. The
result is however the same.
2015-12-15 13:35:28 +01:00
Yehuda Sadeh
54a6222501 Merge pull request #6829 from LenzGr/master
doc: Fixed incorrect name of a "List Multipart Upload Parts" Response Entity

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2015-12-07 11:09:41 -08:00
Lenz Grimmer
3e23e45dd7 doc: Fixed incorrect name of a "List Multipart Upload Parts" Response Entity
Fixed incorrect name of a "List Multipart Upload Parts" Response Entity:
"InitiatedMultipartUploadsResult" -> "ListPartsResult"

Fixes: #14003

Signed-off-by: Lenz Grimmer <lenz@grimmer.com>
2015-12-07 15:54:49 +01:00
Pete Zaitcev
f7ca00a6e9 rgw: make APIs to work with tenants
Previous commits introduced the tenant infrastructure such as
rgw_user, but did not allow anyone to access it productively.

Done:
 - radosgw-admin
 - bucket creation, listing, deletion with non-empty tenant
 - COPY
 - ACLs
 - Using colon for S3 with URL addressing

TODO:
 - Fix S3 remapping of DNS so that period turns into colon in buckets,
   possibly using typed endpoint domains, some assuming tenants
 - Have Swift authentication to set tenant into URL, then pick it there
 - Resolve leftover XXX

Signed-off-by: Pete Zaitcev <zaitcev@redhat.com>
2015-11-25 11:16:06 -08:00
Yehuda Sadeh
0507cff4eb Merge pull request #5969 from rzarzynski/wip-conf-md-add
rgw: extend rgw_extended_http_attrs to affect Swift accounts and containers as well

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
2015-11-06 13:58:05 -08:00
Sage Weil
3eccde9d9c Merge tag 'v9.2.0'
v9.2.0
2015-11-04 19:40:17 -05:00
Loic Dachary
912a06830b Merge pull request #6248 from rzarzynski/wip-rgw-swift-acctmd-doc-infernalis
rgw, doc: remove remark for lack of custom account metadata of Swift API

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-10-17 00:48:55 +02:00
YankunLi
2cf8d20aee update radosgw-admin command
the command "radosgw-admin caps remove" should be "radosgw-admin caps rm" 
radosgw-admin:
commands
caps rm                    remove user capabilities
2015-10-14 10:54:52 +08:00
Radoslaw Zarzynski
fca97db93a rgw, doc: remove remark for lack of custom account metadata of Swift.
Backport: infernalis
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2015-10-13 16:47:32 +02:00
Radoslaw Zarzynski
8f28913b41 rgw, doc: mention that Swift objexp is supported now.
Backport: infernalis
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2015-10-09 10:18:20 +02:00
Radoslaw Zarzynski
c6e681a92f rgw: improve documentation for rgw_extended_http_attrs config opt.
Signed-off-by: Radoslaw Zarzynski <rzarzynski@mirantis.com>
2015-09-17 18:32:39 +02:00
Javier M. Mellid
71909b64b8 doc: rgw: update x-amz-request-id status
Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
2015-09-10 11:25:17 +02:00
Sage Weil
7d781f7a09 doc: 'ceph --admin-daemon ...' -> 'ceph daemon ...'
Signed-off-by: Sage Weil <sage@redhat.com>
2015-09-04 15:59:34 -04:00
Loic Dachary
539acac876 Merge pull request #5702 from Sandy4999/wip-doc-sandy
doc:radosgw: correct typos of the command removing a subuser

Reviewed-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2015-09-01 23:57:53 +02:00
Kefu Chai
cbe85ec126 doc: fix the code-block in ruby.rst
* and add the link to library homepage in the section titles

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-09-02 02:51:05 +08:00
Kadu Ribeiro
d05e531dc0 doc: update ruby doc with the aws-sdk gem usage
Since I'm using ceph with the `aws-sdk` gem (https://github.com/aws/aws-sdk-ruby) instead `aws-s3` (https://github.com/marcel/aws-s3) because the aws-s3 have a trouble with the new active support (https://github.com/marcel/aws-s3/issues/98) (and the downgrade active-support wasn't a option), I proposed change the doc to receive the usage instructions with the aws-sdk gem.

I used ceph with aws-sdk gem with this commands.

Thanks so much

Signed-off-by: Carlos E Ribeiro <mail@carlosribeiro.me>
2015-08-31 11:28:05 -03:00
Sangdi Xu
c901e855a5 doc:radosgw: correct typos of the command removing a subuser
Fix typos in the example command removing a subuser, and delete the 'The Ceph Object Gateway' tag as it should not appear there.

Signed-off-by: Sangdi Xu <xu.sangdi@h3c.com>
2015-08-28 18:19:23 +08:00