ObjectScale supports the configuration of bucket level event notification to allow you to easily monitor when certain configurable events occur within the bucket, such as when objects are created or deleted within the bucket. Bucket event notifications can be utilized to build out distributed and decoupled modern applications.
To set up ObjectScale's bucket event notification feature, you must configure two independent components:
Configure the destination WebHook server
Configure the Bucket Event Notifications
Configure the destination WebHook server Overview
For ObjectScale the only supported destination is a WebHook. WebHooks are a way to receive information when it happens, rather than continually polling for that data.
The following is the expected schema for configuring the WebhookConfig element:
Identifier which uniquely identifies this destination among all other WebHook configured within an account in the object store.
Endpoint
Webhook server endpoint.
AuthToken
Opaque string or JWT authorization token.
BackupLimit
Maximum limit size for undelivered messages.
Comment
(Optional) Comment to this setting.
The WebHook name must be unique among WebHooks within an account in the object store. Once configured, ObjectScale will internally build the <Urn> element, which you can collect with a GET.
ObjectScale supports these Destination Configuration Manager (DCM) APIs for interacting with the destination WebHook server:
Each bucket uses an
Event Rule section with the required fields to configure event notifications for that bucket. Using the ObjectScale UI, you can create a new bucket or modify an existing bucket to add, edit, or delete event rules.
Event Rule Name - Type a name for the new event.
Events - Select one or more event types that will trigger this event notification.
Prefix/Suffix - Type the object name prefix or suffix values that will trigger this event notification.
Send To - Select the notification destination to be used to send the notifications for the configured event(s).
You must have at least one notification destination for this account to set up a bucket event notification rule.
NOTE:Click on
Add Event Rule to add multiple event rules. But, you cannot create configurations on the same bucket that share a common event type.
When using the API, a notification configuration for a bucket is an XML document describing zero or more topic configurations. If no configuration is set on a bucket, it will implicitly have an empty NotificationConfiguration element.
For example, shown below is the request.body of the NotificationConfiguration without any topic configurations: