Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bucket Notifications - docs #1480

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Bucket Notifications - docs #1480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions doc/bucket-notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/.
Loading