Dell EMC ObjectScale 1.2.x Administration Guide

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:

    <WebhookConfig>
      <AuthToken>token</AuthToken>
      <BackupLimit>1000</BackupLimit>
      <Comment>comment</Comment>
      <Endpoint>http://10.55.66.77:3000/hook</Endpoint>
      <Name>MyWebhook</Name>
    </WebhookConfig>

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:

• GetEventDestinationConfiguration (type, name)
• DeleteEventDestinationConfiguration (type, name)
• ListEventDestinationConfigurations (type)
• PutEventDestinationConfiguration (type, name, config)

Configure the Bucket Event Notifications Overview

You can use the ObjectScale UI or the S3 API for PutBucketNotificationConfiguration and/or GetBucketNotificationConfiguration to configure bucket event notifications by creating an Event Rule that will trigger an event notification when the event occurs.

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.

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:

<NotificationConfiguration>
</NotificationConfiguration>

When creating new bucket notifications, use the following syntax for the request.body of the BucketNotificationConfiguration xml:

<NotificationConfiguration>
    <TopicConfiguration>
        <Id>Name</Id>
        <Event>event-type</Event>
        ...
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>(prefix|suffix)</Name>
                    <Value>string</Value>
                </FilterRule>
                ...
            </S3Key>
        </Filter>
        <Topic>webhook-urn</Topic>
    </TopicConfiguration>
    ...
</NotificationConfiguration>

For example, the following NotificationConfiguration file shows how to configure a notification to a webhook any time an object is created.

<NotificationConfiguration>
    <TopicConfiguration>
        <Id>CreateEvents</Id>
        <Topic>createWebhook</Topic>
        <Event>s3:ObjectCreated:*</Event>
    </TopicConfiguration>
</NotificationConfiguration>