Home GitHub
Buckit Object Storage User Guide

Publish Events to Webhook

Buckit supports publishing bucket notification events to a Webhook service endpoint.

Add a Webhook Endpoint to a Buckit Deployment

The following procedure adds a new Webhook service endpoint for supporting bucket notifications in a Buckit deployment.

Prerequisites

Buckit bm Command Line Tool

This procedure uses the bm command line tool for certain actions. See the bm Quickstart for installation instructions.

1) Add the Webhook Endpoint to Buckit

You can configure a new Webhook service endpoint using either environment variables or by setting runtime configuration settings.

Buckit supports specifying the Webhook service endpoint and associated configuration settings using environment variables. The buckit server process applies the specified settings on its next startup.

The following example code sets all environment variables related to configuring an Webhook service endpoint. The minimum required variables are MINIO_NOTIFY_WEBHOOK_ENABLE and MINIO_NOTIFY_WEBHOOK_ENDPOINT:

   export MINIO_NOTIFY_WEBHOOK_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_WEBHOOK_ENDPOINT_<IDENTIFIER>="ENDPOINT"
   export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_CLIENT_CERT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_CLIENT_KEY_<IDENTIFIER>="<string>"

  • Replace <IDENTIFIER> with a unique descriptive string for the Webhook service endpoint. Use the same <IDENTIFIER> value for all environment variables related to the new target service endpoint. The following examples assume an identifier of PRIMARY.

    If the specified <IDENTIFIER> matches an existing Webhook service endpoint on the Buckit deployment, the new settings override any existing settings for that endpoint. Use bm admin config get notify_webhook to review the currently configured Webhook endpoints on the Buckit deployment.

  • Replace <ENDPOINT> with the URL of the Webhook service endpoint. For example:

    https://webhook.example.com

See Webhook Service for Bucket Notifications for complete documentation on each environment variable.

Buckit supports adding or updating Webhook endpoints on a running buckit server process using the bm admin config set command and the notify_webhook configuration key. You must restart the buckit server process to apply any new or updated configuration settings.

The following example code sets all settings related to configuring an Webhook service endpoint. The minimum required setting is notify_webhook endpoint:

bm admin config set ALIAS/ notify_webhook:IDENTIFIER \
   endpoint="<ENDPOINT>" \
   auth_token="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   client_cert="<string>" \
   client_key="<string>"

  • Replace IDENTIFIER with a unique descriptive string for the Webhook service endpoint. The following examples in this procedure assume an identifier of PRIMARY.

    If the specified IDENTIFIER matches an existing Webhook service endpoint on the Buckit deployment, the new settings override any existing settings for that endpoint. Use bm admin config get notify_webhook to review the currently configured Webhook endpoints on the Buckit deployment.

  • Replace ENDPOINT with the URL of the Webhook service endpoint. For example:

    https://webhook.example.com

See Webhook Bucket Notification Configuration Settings for complete documentation on each setting.

1) Restart the Buckit Deployment

You must restart the Buckit deployment to apply the configuration changes. Use the bm admin service restart command to restart the deployment.

bm admin service restart ALIAS

Replace ALIAS with the alias of the deployment to restart.

The buckit server process prints a line on startup for each configured Webhook target similar to the following:

SQS ARNs: arn:minio:sqs::primary:webhook

You must specify the ARN resource when configuring bucket notifications with the associated Webhook deployment as a target.

Identifying the ARN for your bucket notifications

You defined the <IDENTIFIER> to assign to the target ARN for your bucket notifications when creating the endpoint previously. The steps below return the ARNs configured on the deployment. Identify the ARN created previously by looking for the <IDENTIFIER> you specified.

Review the JSON output

  1. Copy and run the following command, replacing ALIAS with the alias of the deployment.

    bm admin info --json ALIAS

  2. In the JSON output, look for the key info.sqsARN.

    The ARN you need is the value of that key that matches the <IDENTIFIER> you specified.

    For example, arn:minio:sqs::primary:webhook.

Use jq to parse the JSON for the value

  1. Install jq

  2. Copy and run the following command, replacing ALIAS with the alias of the deployment.

    bm admin info --json ALIAS | jq  .info.sqsARN

    This returns the ARN to use for notifications, such as arn:minio:sqs::primary:webhook

3) Configure Bucket Notifications using the Webhook Endpoint as a Target

Use the bm event add command to add a new bucket notification event with the configured Webhook service as a target:

bm event add ALIAS/BUCKET arn:minio:sqs::primary:webhook \
  --event EVENTS

  • Replace ALIAS with the alias of a Buckit deployment.

  • Replace BUCKET with the name of the bucket in which to configure the event.

  • Replace EVENTS with a comma-separated list of events for which Buckit triggers notifications.

Use bm event ls to view all configured bucket events for a given notification target:

bm event ls ALIAS/BUCKET arn:minio:sqs::primary:webhook

4) Validate the Configured Events

Perform an action on the bucket for which you configured the new event and check the Webhook service for the notification data. The action required depends on which events were specified when configuring the bucket notification.

For example, if the bucket notification configuration includes the s3:ObjectCreated:Put event, you can use the bm cp command to create a new object in the bucket and trigger a notification.

bm cp ~/data/new-object.txt ALIAS/BUCKET

Update an Webhook Endpoint in a Buckit Deployment

The following procedure updates an existing Webhook service endpoint for supporting bucket notifications in a Buckit deployment.

Prerequisites

Buckit bm Command Line Tool

This procedure uses the bm command line tool for certain actions. See the bm Quickstart for installation instructions.

1) List Configured Webhook Endpoints In The Deployment

Use the bm admin config get command to list the currently configured Webhook service endpoints in the deployment:

bm admin config get ALIAS/ notify_webhook

Replace ALIAS with the alias of the Buckit deployment.

The command output resembles the following:

notify_webhook:primary endpoint="https://webhook.example.com" auth_token="" queue_limit="0" queue_dir="" client_cert="" client_key=""
notify_webhook:secondary endpoint="https://webhook.example.com" auth_token="" queue_limit="0" queue_dir="" client_cert="" client_key=""

The notify_webhook key is the top-level configuration key for an Webhook Service Notification Settings. The endpoint key specifies the Webhook service endpoint for the given notify_webhook key. The notify_webhook:<IDENTIFIER> suffix describes the unique identifier for that Webhook service endpoint.

Note the identifier for the Webhook service endpoint you want to update for the next step.

2) Update the Webhook Endpoint

Use the bm admin config set command to set the new configuration for the Webhook service endpoint:

bm admin config set ALIAS/ notify_webhook:IDENTIFIER \
   endpoint="<ENDPOINT>" \
   auth_token="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   client_cert="<string>" \
   client_key="<string>"

The notify_webhook endpoint configuration setting is the minimum required for an Webhook service endpoint. All other configuration settings are optional. See Webhook Service Notification Settings for a complete list of Webhook configuration settings.

3) Restart the Buckit Deployment

You must restart the Buckit deployment to apply the configuration changes. Use the bm admin service restart command to restart the deployment.

bm admin service restart ALIAS

Replace ALIAS with the alias of the deployment to restart.

The buckit server process prints a line on startup for each configured Webhook target similar to the following:

SQS ARNs: arn:minio:sqs::primary:webhook

4) Validate the Changes

Perform an action on a bucket which has an event configuration using the updated Webhook service endpoint and check the Webhook service for the notification data. The action required depends on which events were specified when configuring the bucket notification.

For example, if the bucket notification configuration includes the s3:ObjectCreated:Put event, you can use the bm cp command to create a new object in the bucket and trigger a notification.

bm cp ~/data/new-object.txt ALIAS/BUCKET
Buckit documentation adapted from MinIO Open Source documentation. Licensed under the Creative Commons Attribution 4.0 International License. Creative Commons License