Commit Graph

348 Commits

Author SHA1 Message Date
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
Drunkard Zhang
5e3ae6d9d3 doc: typo fixes
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-19 09:34:48 +08:00
Drunkard Zhang
9eeec442d5 doc: remove duplicated section in doc/radosgw/adminops
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-19 09:16:52 +08: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
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