mirror of
https://github.com/ceph/ceph
synced 2025-03-11 02:39:05 +00:00
rgw/pubsub: add s3-compatible API documentation
Signed-off-by: Yuval Lifshitz <yuvalif@yahoo.com>
This commit is contained in:
Yuval Lifshitz
parent
8ac119fdd5
commit
9fd0f87318
@ -1,11 +1,11 @@
|
||||
=========================
|
||||
==================
|
||||
PubSub Sync Module
|
||||
=========================
|
||||
==================
|
||||
|
||||
.. versionadded:: Nautilus
|
||||
|
||||
This sync module provides a publish and subscribe mechanism for the object store modification
|
||||
events. Events are published into defined topics. Topics can be subscribed to, and events
|
||||
events. Events are published into predefined topics. Topics can be subscribed to, and events
|
||||
can be pulled from them. Events need to be acked. Also, events will expire and disappear
|
||||
after a period of time. A push notification mechanism exists too, currently supporting HTTP and
|
||||
AMQP0.9.1 endpoints.
|
||||
@ -21,29 +21,25 @@ There can be multiple notifications for any specific topic.
|
||||
A subscription to a topic can also be defined. There can be multiple subscriptions for any
|
||||
specific topic.
|
||||
|
||||
A new REST api has been defined to provide configuration and control interfaces for the pubsub
|
||||
mechanisms.
|
||||
|
||||
Events are stored as rgw objects in a special bucket, under a special user. Events cannot
|
||||
be accessed directly, but need to be pulled and acked using the new REST api.
|
||||
|
||||
REST API has been defined to provide configuration and control interfaces for the pubsub
|
||||
mechanisms. This API has two flavors, one is S3-compatible and one is not. The two flavors can be used
|
||||
together, although it is recommended to use the S3-compatible one.
|
||||
|
||||
Events are stored as RGW objects in a special bucket, under a special user. Events cannot
|
||||
be accessed directly, but need to be pulled and acked using the new REST API.
|
||||
|
||||
PubSub Tier Type Configuration
|
||||
-------------------------------------
|
||||
-------------------------------
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"tenant": <tenant>, # default: <empty>
|
||||
"uid": <uid>, # default: "pubsub"
|
||||
"data_bucket_prefix": <prefix> # default: "pubsub-"
|
||||
"data_oid_prefix": <prefix> #
|
||||
|
||||
"events_retention_days": <days> # default: 7
|
||||
}
|
||||
|
||||
|
||||
{
|
||||
"tenant": <tenant>, # default: <empty>
|
||||
"uid": <uid>, # default: "pubsub"
|
||||
"data_bucket_prefix": <prefix> # default: "pubsub-"
|
||||
"data_oid_prefix": <prefix> #
|
||||
"events_retention_days": <days> # default: 7
|
||||
}
|
||||
|
||||
* ``tenant`` (string)
|
||||
|
||||
@ -68,79 +64,129 @@ How many days to keep events that weren't acked.
|
||||
How to Configure
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
See `Multisite Configuration`_ for how to multisite config instructions. The pubsub sync module requires a creation of a new zone. The zone
|
||||
See `Multisite Configuration`_ for multisite configuration instructions. The pubsub sync module requires a creation of a new zone. The zone
|
||||
tier type needs to be defined as ``pubsub``:
|
||||
|
||||
::
|
||||
|
||||
# radosgw-admin zone create --rgw-zonegroup={zone-group-name} \
|
||||
# radosgw-admin zone create --rgw-zonegroup={zone-group-name} \
|
||||
--rgw-zone={zone-name} \
|
||||
--endpoints={http://fqdn}[,{http://fqdn}]
|
||||
--tier-type=pubsub
|
||||
|
||||
|
||||
The tier configuration can be then done using the following command
|
||||
|
||||
::
|
||||
|
||||
# radosgw-admin zone modify --rgw-zonegroup={zone-group-name} \
|
||||
# radosgw-admin zone modify --rgw-zonegroup={zone-group-name} \
|
||||
--rgw-zone={zone-name} \
|
||||
--tier-config={key}={val}[,{key}={val}]
|
||||
|
||||
The ``key`` in the configuration specifies the config variable that needs to be updated, and
|
||||
The ``key`` in the configuration specifies the configuration variable that needs to be updated, and
|
||||
the ``val`` specifies its new value. Nested values can be accessed using period. For example:
|
||||
|
||||
::
|
||||
|
||||
# radosgw-admin zone modify --rgw-zonegroup={zone-group-name} \
|
||||
# radosgw-admin zone modify --rgw-zonegroup={zone-group-name} \
|
||||
--rgw-zone={zone-name} \
|
||||
--tier-config=uid=pubsub
|
||||
|
||||
|
||||
A configuration field can be removed by using ``--tier-config-rm={key}``.
|
||||
|
||||
PubSub Performance Stats
|
||||
-------------------------
|
||||
- **pubsub_event_triggered**: running counter of events with at lease one pubsub topic associated with them
|
||||
- **pubsub_event_lost**: running counter of events that had pubsub topics and subscriptions associated with them but that were not stored or pushed to any of the subscriptions
|
||||
- **pubsub_store_ok**: running counter, for all subscriptions, of stored pubsub events
|
||||
- **pubsub_store_fail**: running counter, for all subscriptions, of pubsub events that needed to be stored but failed
|
||||
- **pubsub_push_ok**: running counter, for all subscriptions, of pubsub events successfully pushed to their endpoint
|
||||
- **pubsub_push_fail**: running counter, for all subscriptions, of pubsub events failed to be pushed to their endpoint
|
||||
- **pubsub_push_pending**: gauge value of pubsub events pushed to a endpoined but not acked or nacked yet
|
||||
- ``pubsub_event_triggered``: running counter of events with at lease one pubsub topic associated with them
|
||||
- ``pubsub_event_lost``: running counter of events that had pubsub topics and subscriptions associated with them but that were not stored or pushed to any of the subscriptions
|
||||
- ``pubsub_store_ok``: running counter, for all subscriptions, of stored pubsub events
|
||||
- ``pubsub_store_fail``: running counter, for all subscriptions, of pubsub events that needed to be stored but failed
|
||||
- ``pubsub_push_ok``: running counter, for all subscriptions, of pubsub events successfully pushed to their endpoint
|
||||
- ``pubsub_push_fail``: running counter, for all subscriptions, of pubsub events failed to be pushed to their endpoint
|
||||
- ``pubsub_push_pending``: gauge value of pubsub events pushed to a endpoint but not acked or nacked yet
|
||||
|
||||
Note that **pubsub_event_triggered** and **pubsub_event_lost** are incremented per event, while: **pubsub_store_ok**, **pubsub_store_fail**, **pubsub_push_ok**, **pubsub_push_fail**, are incremented per store/push action on each subscriptions.
|
||||
Note that ``pubsub_event_triggered`` and ``pubsub_event_lost`` are incremented per event,
|
||||
while: ``pubsub_store_ok``, ``pubsub_store_fail``, ``pubsub_push_ok``, ``pubsub_push_fail``, are incremented per store/push action on each subscriptions.
|
||||
|
||||
PubSub REST API
|
||||
-------------------------
|
||||
|
||||
---------------
|
||||
|
||||
Topics
|
||||
~~~~~~
|
||||
|
||||
Create a Topic
|
||||
``````````````````````````
|
||||
``````````````
|
||||
|
||||
This will create a new topic.
|
||||
This will create a new topic. Topic creation is needed both for both flavors of the API.
|
||||
Optionally the topic could be provided with push endpoint parameters that would be used later
|
||||
when an S3-compatible notification is created.
|
||||
Upon successful request, the response will include the topic ARN that could be later used to reference this topic in an S3-compatible notification request.
|
||||
|
||||
::
|
||||
|
||||
PUT /topics/<topic-name>
|
||||
PUT /topics/<topic-name>[?push-endpoint=<endpoint>[&amqp-exchange=<exchange>][&amqp-ack-level=<level>][&verify-ssl=true|false]]
|
||||
|
||||
Request parameters:
|
||||
|
||||
- push-endpoint: URI of endpoint to send push notification to
|
||||
|
||||
- URI schema is: ``http[s]|amqp://[<user>:<password>@]<fqdn>[:<port>][/<amqp-vhost>]``
|
||||
- Same schema is used for HTTP and AMQP endpoints (except amqp-vhost which is specific to AMQP)
|
||||
- Default values for HTTP/S: no user/password, port 80/443
|
||||
- Default values for AMQP: user/password=guest/guest, port 5672, amqp-vhost is "/"
|
||||
|
||||
- verify-ssl: can be used with https endpoints (ignored for other endpoints), indicate whether the server certificate is validated or not ("true" by default)
|
||||
- amqp-exchange: mandatory parameter for AMQP endpoint. The exchanges must exist and be able to route messages based on topics
|
||||
- amqp-ack-level: No end2end acking is required, as messages may persist in the broker before delivered into their final destination. 2 ack methods exist:
|
||||
|
||||
- "none" - message is considered "delivered" if sent to broker
|
||||
- "broker" message is considered "delivered" if acked by broker
|
||||
|
||||
Response:
|
||||
The ARN will have one of the following format (depending with whether a push-endpoint was defined):
|
||||
|
||||
::
|
||||
|
||||
arn:aws:sns:<zone-group>:<tenant>:<topic>
|
||||
arn:aws:sns:<zone-group>:<tenant>:<webhook|amqp>:<push-endpoint-url>:<topic>
|
||||
|
||||
Get Topic Information
|
||||
````````````````````````````````
|
||||
`````````````````````
|
||||
|
||||
Returns information about specific topic. This includes subscriptions to that topic.
|
||||
Returns information about specific topic. This includes subscriptions to that topic, and push-endpoint information, if provided.
|
||||
|
||||
::
|
||||
|
||||
GET /topics/<topic-name>
|
||||
|
||||
Response will have the following format (JSON):
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"topic":{
|
||||
"user":"",
|
||||
"name":"",
|
||||
"dest":{
|
||||
"bucket_name":"",
|
||||
"oid_prefix":"",
|
||||
"push_endpoint":"",
|
||||
"push_endpoint_args":""
|
||||
},
|
||||
"arn":""
|
||||
},
|
||||
"subs":[]
|
||||
}
|
||||
|
||||
- topic.user: name of the user that created the topic
|
||||
- name: name of the topic
|
||||
- dest.bucket_name: not used
|
||||
- dest.oid_prefix: not used
|
||||
- dest.push_endpoint: in case of S3-compliant notifications, this value will be used as the push-endpoint URL
|
||||
- dest.push_endpoint_args: in case of S3-compliant notifications, this value will be used as the push-endpoint args
|
||||
- topic.arn: topic ARN
|
||||
- subs: list of subscriptions associated with this topic
|
||||
|
||||
Delete Topic
|
||||
````````````````````````````````````
|
||||
````````````
|
||||
|
||||
::
|
||||
|
||||
@ -149,7 +195,7 @@ Delete Topic
|
||||
Delete the specified topic.
|
||||
|
||||
List Topics
|
||||
````````````````````````````````````
|
||||
```````````
|
||||
|
||||
List all topics that user defined.
|
||||
|
||||
@ -157,13 +203,88 @@ List all topics that user defined.
|
||||
|
||||
GET /topics
|
||||
|
||||
|
||||
|
||||
Notifications
|
||||
~~~~~~~~~~~~~
|
||||
S3-Compliant Notifications
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Create a Notification
|
||||
``````````````````````````
|
||||
`````````````````````
|
||||
|
||||
This will create a publisher for a specific bucket into a topic, and a subscription
|
||||
for pushing/pulling events.
|
||||
|
||||
::
|
||||
|
||||
PUT /<bucket name>?notification
|
||||
|
||||
Request parameters are encoded in XML in the body of the request, with the following format:
|
||||
|
||||
::
|
||||
|
||||
<NotificationConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
|
||||
<TopicConfiguration>
|
||||
<Id></Id>
|
||||
<Topic></Topic>
|
||||
<Event></Event>
|
||||
</TopicConfiguration>
|
||||
</NotificationConfiguration>
|
||||
|
||||
- Id: name of the notification
|
||||
- Topic: topic ARN
|
||||
- Event: either ``s3:ObjectCreated:*``, or ``s3:ObjectRemoved:*``. Note that multiple ``Event`` tags may be used
|
||||
|
||||
Delete Notification
|
||||
```````````````````
|
||||
|
||||
Delete a specific, or all S3-compliant notifications from a bucket. Associated subscriptions will also be deleted.
|
||||
|
||||
::
|
||||
|
||||
DELETE /bucket?notification[=<notification-id>]
|
||||
|
||||
Request parameters:
|
||||
|
||||
- notification-id: name of the notification (if not provided, all S3-compliant notifications on the bucket are deleted)
|
||||
|
||||
Note that this is an extension to the S3 notification API
|
||||
|
||||
Get/List Notifications
|
||||
``````````````````````
|
||||
|
||||
Get a specific S3-compliant notification, or list all S3-compliant notifications defined on a bucket.
|
||||
|
||||
::
|
||||
|
||||
GET /bucket?notification[=<notification-id>]
|
||||
|
||||
Request parameters:
|
||||
|
||||
- notification-id: name of the notification (if not provided, all S3-compliant notifications on the bucket are listed)
|
||||
|
||||
Response is XML formatted:
|
||||
|
||||
::
|
||||
|
||||
<NotificationConfiguration>
|
||||
<TopicConfiguration>
|
||||
<Id></Id>
|
||||
<Topic></Topic>
|
||||
<Event></Event>
|
||||
</TopicConfiguration>
|
||||
</NotificationConfiguration>
|
||||
|
||||
- Id: name of the notification
|
||||
- Topic: topic ARN
|
||||
- Event: either ``s3:ObjectCreated:*``, or ``s3:ObjectRemoved:*``. Note that multiple ``Event`` tags may be used
|
||||
|
||||
Notes:
|
||||
- Getting information on a specific notification is an extension to the S3 notification API
|
||||
- When multiple notifications are fetched from the bucket, multiple ``NotificationConfiguration`` tags will be used
|
||||
|
||||
Non S3-Compliant Notifications
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Create a Notification
|
||||
`````````````````````
|
||||
|
||||
This will create a publisher for a specific bucket into a topic.
|
||||
|
||||
@ -171,15 +292,13 @@ This will create a publisher for a specific bucket into a topic.
|
||||
|
||||
PUT /notifications/bucket/<bucket>?topic=<topic-name>[&events=<event>[,<event>]]
|
||||
|
||||
Request parameters:
|
||||
|
||||
Request Params:
|
||||
- topic-name: name of topic
|
||||
- event: event type (string), one of: OBJECT_CREATE, OBJECT_DELETE
|
||||
|
||||
|
||||
- topic-name: name of topic
|
||||
- event: event type (string), one of: OBJECT_CREATE, OBJECT_DELETE
|
||||
|
||||
Delete Notification Information
|
||||
````````````````````````````````
|
||||
```````````````````````````````
|
||||
|
||||
Delete publisher from a specific bucket into a specific topic.
|
||||
|
||||
@ -187,13 +306,45 @@ Delete publisher from a specific bucket into a specific topic.
|
||||
|
||||
DELETE /notifications/bucket/<bucket>?topic=<topic-name>
|
||||
|
||||
Request Params:
|
||||
- topic-name: name of topic
|
||||
Request parameters:
|
||||
|
||||
- topic-name: name of topic
|
||||
|
||||
List Notifications
|
||||
``````````````````
|
||||
|
||||
Create Subscription
|
||||
````````````````````````````````````
|
||||
List all topics with associated events defined on a bucket.
|
||||
|
||||
::
|
||||
|
||||
GET /notifications/bucket/<bucket>
|
||||
|
||||
Response will have the following format (JSON):
|
||||
|
||||
::
|
||||
|
||||
{"topics":[
|
||||
{
|
||||
"topic":{
|
||||
"user":"",
|
||||
"name":"",
|
||||
"dest":{
|
||||
"bucket_name":"",
|
||||
"oid_prefix":"",
|
||||
"push_endpoint":"",
|
||||
"push_endpoint_args":""
|
||||
}
|
||||
"arn":""
|
||||
},
|
||||
"events":[]
|
||||
}
|
||||
]}
|
||||
|
||||
Subscriptions
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Create a Subscription
|
||||
`````````````````````
|
||||
|
||||
Creates a new subscription.
|
||||
|
||||
@ -201,61 +352,187 @@ Creates a new subscription.
|
||||
|
||||
PUT /subscriptions/<sub-name>?topic=<topic-name>[&push-endpoint=<endpoint>[&amqp-exchange=<exchange>][&amqp-ack-level=<level>][&verify-ssl=true|false]]
|
||||
|
||||
Request Params:
|
||||
Request parameters:
|
||||
|
||||
- topic-name: name of topic
|
||||
- push-endpoint: URI of endpoint to send push notification to
|
||||
- topic-name: name of topic
|
||||
- push-endpoint: URI of endpoint to send push notification to
|
||||
|
||||
- URI schema is: ``http|amqp://[<user>:<password>@]<fqdn>[:<port>][/<amqp-vhost>]``
|
||||
- Same schema is used for HTTP and AMQP endpoints (except amqp-vhost which is specific to AMQP)
|
||||
- Default values for HTTP: no user/password, port 80
|
||||
- Default values for AMQP: user/password=guest/guest, port 5672, amqp-vhost is "/"
|
||||
- URI schema is: ``http[s]|amqp://[<user>:<password>@]<fqdn>[:<port>][/<amqp-vhost>]``
|
||||
- Same schema is used for HTTP and AMQP endpoints (except amqp-vhost which is specific to AMQP)
|
||||
- Default values for HTTP/S: no user/password, port 80/443
|
||||
- Default values for AMQP: user/password=guest/guest, port 5672, amqp-vhost is "/"
|
||||
|
||||
- verify-ssl: can be used with https endpoints (ignored for other endpoints), indicate whether the server certificate is validated or not ("true" by default)
|
||||
- amqp-exchange: mandatory parameter for AMQP endpoint. The exchanges must exist and be able to route messages based on topics
|
||||
- amqp-ack-level: 2 ack levels exist: "none" - message is considered "delivered" if sent to broker;
|
||||
"broker" message is considered "delivered" if acked by broker.
|
||||
No end2end acking is required, as messages may persist in the broker before delivered into their final destination
|
||||
- verify-ssl: can be used with https endpoints (ignored for other endpoints), indicate whether the server certificate is validated or not ("true" by default)
|
||||
- amqp-exchange: mandatory parameter for AMQP endpoint. The exchanges must exist and be able to route messages based on topics
|
||||
- amqp-ack-level: No end2end acking is required, as messages may persist in the broker before delivered into their final destination. 2 ack methods exist:
|
||||
|
||||
Get Subscription Info
|
||||
````````````````````````````````````
|
||||
- "none": message is considered "delivered" if sent to broker
|
||||
- "broker": message is considered "delivered" if acked by broker
|
||||
|
||||
Returns info about specific subscription
|
||||
Get Subscription Information
|
||||
````````````````````````````
|
||||
|
||||
Returns information about specific subscription.
|
||||
|
||||
::
|
||||
|
||||
GET /subscriptions/<sub-name>
|
||||
|
||||
Response will have the following format (JSON):
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"user":"",
|
||||
"name":"",
|
||||
"topic":"",
|
||||
"dest":{
|
||||
"bucket_name":"",
|
||||
"oid_prefix":"",
|
||||
"push_endpoint":"",
|
||||
"push_endpoint_args":""
|
||||
}
|
||||
"s3_id":""
|
||||
}
|
||||
|
||||
- user: name of the user that created the subscription
|
||||
- name: name of the subscription
|
||||
- topic: name of the topic the subscription is associated with
|
||||
|
||||
Delete Subscription
|
||||
`````````````````````````````````
|
||||
```````````````````
|
||||
|
||||
Removes a subscription
|
||||
Removes a subscription.
|
||||
|
||||
::
|
||||
|
||||
DELETE /subscriptions/<sub-name>
|
||||
|
||||
|
||||
Events
|
||||
~~~~~~
|
||||
|
||||
Pull Events
|
||||
`````````````````````````````````
|
||||
```````````
|
||||
|
||||
Pull events sent to a specific subscription
|
||||
Pull events sent to a specific subscription.
|
||||
|
||||
::
|
||||
|
||||
GET /subscriptions/<sub-name>?events[&max-entries=<max-entries>][&marker=<marker>]
|
||||
|
||||
Request Params:
|
||||
- marker: pagination marker for list of events, if not specified will start from the oldest
|
||||
- max-entries: max number of events to return
|
||||
Request parameters:
|
||||
|
||||
- marker: pagination marker for list of events, if not specified will start from the oldest
|
||||
- max-entries: max number of events to return
|
||||
|
||||
The response will hold information on the current marker and whether there are more events not fetched:
|
||||
|
||||
::
|
||||
|
||||
{"next_marker":"","is_truncated":"",...}
|
||||
|
||||
|
||||
The actual content of the response is depended with how the subscription was created.
|
||||
In case that the subscription was created via an S3-compatible notification,
|
||||
the events will have an S3-compatible record format (JSON):
|
||||
|
||||
::
|
||||
|
||||
{"Records":[
|
||||
{
|
||||
"eventVersion":"2.1"
|
||||
"eventSource":"aws:s3",
|
||||
"awsRegion":"",
|
||||
"eventTime":"",
|
||||
"eventName":"",
|
||||
"userIdentity":{
|
||||
"principalId":""
|
||||
},
|
||||
"requestParameters":{
|
||||
"sourceIPAddress":""
|
||||
},
|
||||
"responseElements":{
|
||||
"x-amz-request-id":"",
|
||||
"x-amz-id-2":""
|
||||
},
|
||||
"s3":{
|
||||
"s3SchemaVersion":"1.0",
|
||||
"configurationId":"",
|
||||
"bucket":{
|
||||
"name":"",
|
||||
"ownerIdentity":{
|
||||
"principalId":""
|
||||
},
|
||||
"arn":""
|
||||
},
|
||||
"object":{
|
||||
"key":"",
|
||||
"size": ,
|
||||
"eTag":"",
|
||||
"versionId":"",
|
||||
"sequencer": ""
|
||||
}
|
||||
},
|
||||
"eventId":"",
|
||||
}
|
||||
]}
|
||||
|
||||
- awsRegion: zonegroup
|
||||
- eventTime: timestamp indicating when the event was triggered
|
||||
- eventName: either ``s3:ObjectCreated:``, or ``s3:ObjectRemoved:``
|
||||
- userIdentity: not supported
|
||||
- requestParameters: not supported
|
||||
- responseElements: not supported
|
||||
- s3.configurationId: notification ID that created the subscription for the event
|
||||
- s3.eventId: unique ID of the event, that could be used for acking (an extension to the S3 notification API)
|
||||
- s3.bucket.name: name of the bucket
|
||||
- s3.bucket.ownerIdentity.principalId: owner of the bucket
|
||||
- s3.bucket.arn: ARN of the bucket
|
||||
- s3.object.key: object key
|
||||
- s3.object.size: not supported
|
||||
- s3.object.eTag: object etag
|
||||
- s3.object.version: object version in case of versioned bucket
|
||||
- s3.object.sequencer: monotonically increasing identifier of the change per object (hexadecimal format)
|
||||
|
||||
In case that the subscription was not created via an S3-compatible notification,
|
||||
the events will have the following event format (JSON):
|
||||
|
||||
::
|
||||
|
||||
{"events":[
|
||||
{
|
||||
"id":"",
|
||||
"event":"",
|
||||
"timestamp":"",
|
||||
"info":{
|
||||
"attrs":{
|
||||
"mtime":""
|
||||
},
|
||||
"bucket":{
|
||||
"bucket_id":"",
|
||||
"name":"",
|
||||
"tenant":""
|
||||
},
|
||||
"key":{
|
||||
"instance":"",
|
||||
"name":""
|
||||
}
|
||||
}
|
||||
}
|
||||
]}
|
||||
|
||||
- id: unique ID of the event, that could be used for acking (an extension to the S3 notification API)
|
||||
- event: either ``OBJECT_CREATE``, or ``OBJECT_DELETE``
|
||||
- timestamp: timestamp indicating when the event was sent
|
||||
- info.attrs.mtime: timestamp indicating when the event was triggered
|
||||
- info.bucket.bucket_id: id of the bucket
|
||||
- info.bucket.name: name of the bucket
|
||||
- info.bucket.tenant: tenant the bucket belongs to
|
||||
- info.key.instance: object version in case of versioned bucket
|
||||
- info.key.name: object key
|
||||
|
||||
Ack Event
|
||||
`````````````````````````````````
|
||||
`````````
|
||||
|
||||
Ack event so that it can be removed from the subscription history.
|
||||
|
||||
@ -263,8 +540,8 @@ Ack event so that it can be removed from the subscription history.
|
||||
|
||||
POST /subscriptions/<sub-name>?ack&event-id=<event-id>
|
||||
|
||||
Request parameters:
|
||||
|
||||
Request Params:
|
||||
- event-id: id of event to be acked
|
||||
- event-id: id of event to be acked
|
||||
|
||||
.. _Multisite Configuration: ./multisite.rst
|
||||
|
||||
@ -97,7 +97,7 @@ struct rgw_pubsub_s3_record {
|
||||
std::string eventVersion;
|
||||
// aws:s3
|
||||
std::string eventSource;
|
||||
// zone?
|
||||
// zonegroup
|
||||
std::string awsRegion;
|
||||
// time of the request
|
||||
ceph::real_time eventTime;
|
||||
@ -123,11 +123,11 @@ struct rgw_pubsub_s3_record {
|
||||
std::string bucket_arn;
|
||||
// object key
|
||||
std::string object_key;
|
||||
// object size
|
||||
// object size (not implemented)
|
||||
uint64_t object_size;
|
||||
// object etag
|
||||
std::string object_etag;
|
||||
// object version id bucket is versioned (not implemented)
|
||||
// object version id bucket is versioned
|
||||
std::string object_versionId;
|
||||
// hexadecimal value used to determine event order for specific key
|
||||
std::string object_sequencer;
|
||||
|
||||
@ -780,7 +780,7 @@ std::string unique_to_topic(const std::string& unique_topic, const std::string&
|
||||
}
|
||||
|
||||
// command (S3 compliant): PUT /<bucket name>?notification
|
||||
// a "topic", a "notification" and a subscription will be auto-generated
|
||||
// a "notification" and a subscription will be auto-generated
|
||||
// actual configuration is XML encoded in the body of the message
|
||||
class RGWPSCreateNotif_ObjStore_S3 : public RGWPSCreateNotifOp {
|
||||
rgw_pubsub_s3_notifications configurations;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user