Commit Graph

314 Commits

Author SHA1 Message Date
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
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
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
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