Bucket notifications
Bucket notification APIs can be used to provide configuration and control interfaces for the bucket notification mechanism.
- In all topic actions, the parameters are URL encoded, and sent in the message body using
application/x-www-form-urlencodedcontent type. - Any bucket notification already associated with the topic needs to be re-created for the topic update to take effect.
Bucket notifications provide a way to send information out of the Ceph Object Gateway when certain events happen in the bucket. Bucket notifications can be sent to HTTP, AMQP0.9.1, and Kafka endpoints. A notification entry must be created to send bucket notifications for events on a specific bucket and to a specific topic. A bucket notification can be created on a subset of event types or by default for all event types. The bucket notification can filter out events based on key prefix or suffix, regular expression matching the keys, and the metadata attributes attached to the object, or the object tags. Bucket notifications have a REST API to provide configuration and control interfaces for the bucket notification mechanism.
Sending a bucket notification when an object is synced to a zone lets the external system get information into the zone syncing status at the object level. The bucket notification event types s3:ObjectSynced:* and s3:ObjectSynced:Created, when configured via the bucket notification mechanism, send a notification event from the synced RGW upon successful sync of an object. Both the topics and the notification configuration should be done separately in each zone from which the notification events are being sent.
For more information, see the S3 bucket notifications for event-driven architectures chapter, within the IBM Storage Ceph Solutions Guide Redpaper publication.