From 44df33eca7059083c046f049fd79f6245a0f57c2 Mon Sep 17 00:00:00 2001 From: Amit Prinz Setter Date: Mon, 25 Nov 2024 14:20:01 -0800 Subject: [PATCH] Bucket Notifications - docs Signed-off-by: Amit Prinz Setter --- doc/bucket-notifications.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/bucket-notifications.md diff --git a/doc/bucket-notifications.md b/doc/bucket-notifications.md new file mode 100644 index 000000000..083622e32 --- /dev/null +++ b/doc/bucket-notifications.md @@ -0,0 +1,25 @@ +# Bucket Notifications + +## NooBaa CRD configuration + +NooBaa CRD contains a field named 'bucketNotifications' (under "spec" field) that manages bucket notifications. + +bucketNotifications value is an object: + + { + enabled: Boolean, + pvc: String, + connections: [SecretReference] + } + +- enabled: This field must be set to true to enable bucket notifications. +- pvc: Bucket notifications uses a PVC to store pending notifications. +This field is used to specify an existing PVC to use. +The PVC must support RWX access mode. +If CephFS is available, and this field is left empty, a PVC would be allocated from CephFS. +- connections: An array of secrets that contain the data on how to connect to the external notification server. + +## Connection secrets +The structure of a connection secret is the same as connection file. +Please refer to the Bucket Notification document in [noobaa-core](https://github.com/noobaa/noobaa-core/blob/master/docs/bucket-notifications.md). +The operator will mount the secrets as files in the core pod at /etc/notif_connect/.