From b28ce38ca9e1da8ab5da7f18a22d6df3c46a771e Mon Sep 17 00:00:00 2001 From: Guillaume Moutier Date: Fri, 1 May 2020 09:26:17 -0400 Subject: [PATCH] ceph: bucket notifications CRD documentation This documents the Ceph topics and buckets notification management by rook through CRs. Signed-off-by: Guillaume Moutier Signed-off-by: Jiffin Tony Thottan --- .../object/ceph-bucket-notification-crd.md | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 design/ceph/object/ceph-bucket-notification-crd.md diff --git a/design/ceph/object/ceph-bucket-notification-crd.md b/design/ceph/object/ceph-bucket-notification-crd.md new file mode 100644 index 000000000..04d461e49 --- /dev/null +++ b/design/ceph/object/ceph-bucket-notification-crd.md @@ -0,0 +1,87 @@ +# Ceph bucket notifications CRD + +## Overview + +Ceph added support for the bucket notifications feature from Nautilus onwards. It allows sending messages to various endpoints when a new event occurs on a bucket [ref](https://docs.ceph.com/docs/master/radosgw/notifications/) + +Setup of those notifications are normally done by sending HTTP requests to the RGW, either to create/delete topics pointing to specific endpoints, or create/delete bucket notifications based on those topics. + +This functionality eases this process by avoiding to use external tools or scripts. It is replaced by creation of CR definitions that contain all the information necessary to create topics and/or notifications, which the rook operator processes. + +## Goals + +Creates a CRD for topics and a CRD for notifications, defining all the necessary and optional information for the various endpoints. + +Extends the rook operator to handle the CRs that would be submitted by users. + +## Implementation + +The CR for a topic configuration takes this form: + +```yaml +apiVersion: ceph.rook.io/v1 +kind: CephBucketTopic +metadata: + name: # name of the topic + namespace: # namespace where topic belongs +Spec: + endpoint: #(mandatory) URI of an endpoint to send push notification to + opaqueData: #(optional) opaque data is set in the topic configuration + persistent: false #(optional) indication whether notifications to this endpoint are persistent or not (`false` by default) + # Endpoint specific parameters + http: + verifySSL: true #indicate whether the server certificate is validated by the client or not (`true` by default) + amqp: + ackLevel: broker # none/routable/broker, optional (default - broker) + amqpExchange: direct # exchanges must exist and be able to route messages based on topics + kafka: + useSSL: true # secure connection will be used for connecting with the broker (`false` by default) + caLocation: # this specified CA will be used, instead of the default one, to authenticate the broker + ackLevel: broker # none/broker, optional (default - broker) +``` +P.S : Endpoint can be of different format depends on the server +- http -> `http[s]://[: `amqp://[:@][:][/]` +- kafka -> `kafka://[:@][: