]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: Small improvements in s3-notification-compatibility.rst 64823/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Tue, 5 Aug 2025 05:14:13 +0000 (12:14 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Tue, 5 Aug 2025 05:14:13 +0000 (12:14 +0700)
Attempt a small fix to a grammatical error in a sentence.
It should also refer to "below" and not "above", probably.

End full sentences in full stops.

Indent an unordered list consistently so that it renders consistently
with the same bullets.
Also indent all various blocks at the same columns consistently.

Wrap lines before column 80 while we're at it.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/radosgw/s3-notification-compatibility.rst

index 2f3a9ece7464b5eb22d845395f646db99a841f46..09af343a1e70c41239f71f4b40625aef15f5e4ae 100644 (file)
@@ -4,20 +4,24 @@
 S3 Bucket Notifications Compatibility
 =====================================
 
-Ceph's `Bucket Notifications`_ API follows `AWS S3 Bucket Notifications API`_. However, some differences exist, as listed below.
+Ceph's `Bucket Notifications`_ API follows `AWS S3 Bucket Notifications API`_.
+However, some differences exist, as listed below.
 
 
 .. note::
 
-    Compatibility is different depending on which of the above mechanism is used
+   Compatibility is different depending on which of the below mechanisms
+   is used.
 
 Supported Destination
 ---------------------
 
-AWS supports: **SNS**, **SQS** and **Lambda** as possible destinations (AWS internal destinations).
+AWS supports: **SNS**, **SQS** and **Lambda** as possible destinations (AWS
+internal destinations).
 Currently, we support: **HTTP/S**, **Kafka** and **AMQP**.
 
-We are using the **SNS** ARNs to represent the **HTTP/S**, **Kafka** and **AMQP** destinations.
+We are using the **SNS** ARNs to represent the **HTTP/S**, **Kafka** and
+**AMQP** destinations.
 
 Notification Configuration XML
 ------------------------------
@@ -37,13 +41,16 @@ REST API Extension
 
 Ceph's bucket notification API has the following extensions:
 
-- Deletion of a specific notification, or all notifications on a bucket, using the ``DELETE`` verb
+- Deletion of a specific notification, or all notifications on a bucket,
+  using the ``DELETE`` verb
 
- - In S3, all notifications are deleted when the bucket is deleted, or when an empty notification is set on the bucket
+  - In S3, all notifications are deleted when the bucket is deleted, or
+    when an empty notification is set on the bucket.
 
-- Getting the information on a specific notification (when more than one exists on a bucket)
+- Getting the information on a specific notification (when more than one
+  exists on a bucket)
 
-  - In S3, it is only possible to fetch all notifications on a bucket
+  - In S3, it is only possible to fetch all notifications on a bucket.
 
 - In addition to filtering based on prefix/suffix of object keys we support:
 
@@ -53,15 +60,18 @@ Ceph's bucket notification API has the following extensions:
 
   - Filtering based on object tags
 
-- Each one of the additional filters extends the S3 API and using it will require extension of the client SDK (unless you are using plain HTTP).
+- Each one of the additional filters extends the S3 API and using it will
+  require extension of the client SDK (unless you are using plain HTTP).
 
-- Filtering overlapping is allowed, so that same event could be sent as different notification
+- Filtering overlapping is allowed, so that same event could be sent as
+  different notification.
 
 
 Unsupported Fields in the Event Record
 --------------------------------------
 
-The records sent for bucket notification follows the format described in: `Event Message Structure`_.
+The records sent for bucket notification follows the format described in:
+`Event Message Structure`_.
 However, the ``requestParameters.sourceIPAddress`` field will be sent empty.
 
 
@@ -141,32 +151,39 @@ Event Types
 
 .. note::
 
-   The ``s3:ObjectRemoved:DeleteMarkerCreated`` event presents information on the latest version of the object
+   The ``s3:ObjectRemoved:DeleteMarkerCreated`` event presents information
+   on the latest version of the object.
 
 .. note::
 
-   In case of multipart upload, an ``ObjectCreated:CompleteMultipartUpload`` notification will be sent at the end of the process.
+   In case of multipart upload, an ``ObjectCreated:CompleteMultipartUpload``
+   notification will be sent at the end of the process.
 
 .. note::
 
-   The ``s3:ObjectSynced:Create`` event is sent when an object successfully syncs to a zone. It must be explicitly set for each zone.
+   The ``s3:ObjectSynced:Create`` event is sent when an object successfully
+   syncs to a zone. It must be explicitly set for each zone.
 
 Topic Configuration
 -------------------
-In the case of bucket notifications, the topics management API will be derived from `AWS Simple Notification Service API`_.
-Note that most of the API is not applicable to Ceph, and only the following actions are implemented:
+In the case of bucket notifications, the topics management API will be
+derived from `AWS Simple Notification Service API`_.
+Note that most of the API is not applicable to Ceph, and only the following
+actions are implemented:
 
- - ``CreateTopic``
- - ``DeleteTopic``
- - ``ListTopics``
+- ``CreateTopic``
+- ``DeleteTopic``
+- ``ListTopics``
 
 We also have the following extensions to topic configuration:
 
- - In ``GetTopic`` we allow fetching a specific topic, instead of all user topics
- - In ``CreateTopic``
+- In ``GetTopic`` we allow fetching a specific topic, instead of all
+  user topics.
+- In ``CreateTopic``:
 
-  - we allow setting endpoint attributes
-  - we allow setting opaque data that will be sent to the endpoint in the notification
+  - We allow setting endpoint attributes.
+  - We allow setting opaque data that will be sent to the endpoint in
+    the notification.
 
 
 .. _AWS Simple Notification Service API: https://docs.aws.amazon.com/sns/latest/api/API_Operations.html