Commit Graph

51 Commits

Author SHA1 Message Date
Michael Prokop
d98b3e36a9 doc: fix typos
s/amount of times/number of times/
s/assosciated/associated/
s/availabe/available/
s/Commiting/Committing/
s/Containter/Container/
s/dependant/dependent/
s/developement/development/
s/filesytem/filesystem/
s/guarenteed/guaranteed/
s/hiearchy/hierarchy/
s/intance/instance/
s/Interger/Integer/
s/mutiple/multiple/
s/nubmer/number/
s/occured/occurred/
s/overriden/overridden/
s/reseted/reset/
s/sytem/system/
s/unkown/unknown/

Signed-off-by: Michael Prokop <mika@grml.org>
2019-09-26 09:17:07 +02:00
Yuval Lifshitz
751c4514e0
Merge pull request #28971 from yuvalif/wip-yuval-pubsub-api2
rgw/pubsub: add S3 compliant API to master zone
2019-09-20 01:35:02 +03:00
Casey Bodley
bf49aff3a1 rgw: disable compression/encryption on Appendable objects
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2019-09-13 14:49:46 -04:00
Yuval Lifshitz
543f8f7a27 rgw/pubsub: add notification filtering
Signed-off-by: Yuval Lifshitz <yuvalif@yahoo.com>
2019-09-11 19:24:55 +03:00
Yuval Lifshitz
923799fd96 rgw/pubsub: support deletion markers and multipart upload
Signed-off-by: Yuval Lifshitz <yuvalif@yahoo.com>
2019-09-10 18:54:05 +03:00
Soumya Koduri
eb6eddbe8d Validate bucket names as per revised s3 spec
As per amazon s3 spec -
https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html

* The s3 bucket names should not contain upper case letters or underscore.
* Name cannot end with dash or have consecutive periods, or dashes adjacent
  to periods.
* Each label in the bucket name must start and end with a lowercase
  letter or a number.
* Name cannot exceed 63 characters.

This change is to enforce these rules if rgw_relaxed_s3_bucket_names is set to
'false' which is by default.

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

Signed-off-by: Soumya Koduri <skoduri@redhat.com>
2019-08-08 16:54:12 +05:30
zhang Shaowen
823f4376be rgw: fix doc compile warning caused by objectops.rst
Signed-off-by: zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-06-18 09:16:39 +08:00
zhang Shaowen
81960500d0 doc:fix radosgw bucketops doc compile error
Signed-off-by: zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-06-17 17:07:07 +08:00
zhang Shaowen
18949105ae rgw: add object lock doc.
Signed-off-by: zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-06-12 11:19:04 +08:00
Casey Bodley
e97668bb7a doc/rgw: document CreateBucketConfiguration for s3 PUT Bucket api
Fixes: http://tracker.ceph.com/issues/39597

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2019-05-06 09:33:07 -04:00
Casey Bodley
f2bb87b7ec
Merge pull request #25985 from l-vo/update_php_doc
doc/radosgw: update documentation examples with the current S3 PHP client

Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
2019-04-09 09:40:42 -04:00
Adam C. Emerson
bd94c93fad doc/radosgw: Document mappings of S3 Operations to ACL grants
Since the ACL documentation is a bit sparse, let people know exactly
what operations they can expect to enable with a given ACL grant.

Fixes: https://tracker.ceph.com/issues/38523
Signed-off-by: Adam C. Emerson <aemerson@redhat.com>
2019-03-07 16:42:51 -05:00
Lan Liu
0a875211a5 doc: fix typo in objectops.rst
Signed-off-by: Lan Liu <liulan@umcloud.com>
2019-02-26 18:07:43 +08:00
zhang Shaowen
f806e1ecf0 rgw: object's append attr will be removed after it's synced to another zone.
Signed-off-by: zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-02-20 16:15:46 +08:00
zhang Shaowen
5197c69ee5 rgw: fix compile error for appending object
Signed-off-by: zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-02-12 11:14:55 +08:00
Zhang Shaowen
03be834728 rgw: Add append object api
Signed-off-by: Zhang Shaowen <zhangshaowen@cmss.chinamobile.com>
2019-02-12 11:14:55 +08:00
Laurent VOULLEMIER
0d0bb1c574 doc/radosgw: update doc with last S3 client
The documentation for the S3 PHP client usage is about an old client. This update the examples to the current S3 PHP client.

Signed-off-by: Laurent VOULLEMIER <laurent.voullemier@gmail.com>
2019-02-07 11:11:25 +01: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
Kefu Chai
2358cf154c
Merge pull request #22162 from liuzhanhao/master
doc: Update cpp.rst to accommodate the new APIs in libs3

Reviewed-by: Kefu Chai <kchai@redhat.com>
2018-10-18 12:29:07 +08:00
李丙洋 10208981
53feb4ad4e doc: Fix Spelling Error of Radosgw
Signed-off-by: Li Bingyang <li.bingyang1@zte.com.cn>
2018-09-11 15:30:20 +08:00
Zhanhao (Jasper) Liu
ea100828d5
doc: Update cpp.rst to fix bug in demo code
Update cpp.rst to fix the possible problems brought by not closing the FILE pointer properly in the demo code.

Signed-off-by: Zhanhao Liu <jasperlau95@gmail.com>
2018-06-07 15:56:09 +08:00
Zhanhao (Jasper) Liu
72cfa54be9 doc: Update cpp.rst to accommodate the new APIs in libs3
Update cpp.rst to accommodate the new APIs for the libs3 library. Some APIs in the current tutorial doesn't match the updated APIs in the libs3.h library and thus cannot be compiled.

Signed-off-by: Zhanhao Liu <jasperlau95@gmail.com>
2018-05-23 17:55:46 +08: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
Kefu Chai
127d25ccbd doc: fix warning reported by "build-doc linkcheck"
all the HTTP 301 (moved permanently) should be killed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-24 15:58:48 +08:00
Yao Zongyou
8e3380f20a doc: fix typo in php.rst
Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-09-16 13:54:03 +08:00
Kefu Chai
2670d244fd doc: various fixes
- radosgw/s3/bucketops.rst: fix Malformed table.
- operations/health-checks.rst: Title underline too short
- rbd/rados-rbd-cmds.rst: Title underline too short
- rados/operations/index.rst: include health-checks in toc

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-08-01 17:31:36 +08: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
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
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
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
36203c28ba doc: configuring virtual hosted buckets for radosgw
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2016-10-03 14:25:23 -04: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
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
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
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
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
shawn
5c395ff856 doc: add bucket object version description.
bucket object version has been supported, but do not have description in the docs,
so add this part.

Signed-off-by: shawn chen <cxwshawn@gmail.com>
2015-07-30 10:09:16 +08:00
Abhishek Lekshmanan
a1ba3852cc doc: rgw document s3 bucket location features
Fixes: #10142
Reported-by: Neil Levine <nlevine@redhat.com>
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2014-11-24 23:36:21 +05:30
Ashish Chandra
f7ca1bf10f Update python.rst
Signed-off-by:ashish.a.chandra@ril.com
2014-08-25 17:36:29 +05:30
John Wilkins
54d230529b doc: Added Java example for setting protocol to HTTP.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-31 11:15:20 -07:00
Alexandre Marangone
ac9fa4336e Fix tips in documentation
Use of .. tip: instead of .. tip:: resulting in content not
being displayed.

Signed-off-by: Alexandre Marangone <alexandre.marangone@inktank.com>
2013-03-20 21:17:53 -07:00
carsonoid
b244b87f28 Update doc/radosgw/s3/python.rst
Note about creating conn object for non-ssl implementations.
2013-03-05 11:03:08 -08:00
Dan Mick
aec2a4742c s3/php: update to 1.5? version of API
Something like v1.5 of the Amazon PHP library requires the AmazonS3
constructor to be given an array of parameters rather than using
the globals.  More research needs to happen, and particularly
about the v2 API, but this might solve someone's problem with
v1.5 while we do that research.

Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-01-25 21:25:45 -08:00
John Wilkins
2e7cba7bca doc: fixed indent in python example.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-10 14:14:09 -08:00