Home GitHub
Buckit Object Storage User Guide

Publish Events to PostgreSQL

Buckit supports publishing bucket notification events to PostgreSQL. Buckit supports PostgreSQL 9.5 and later only.

Add a PostgreSQL Endpoint to a Buckit Deployment

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

Prerequisites

PostgreSQL 9.5 and later

Buckit relies on features introduced with PostgreSQL 9.5.

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 PostgreSQL Endpoint to Buckit

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

Buckit supports specifying the PostgreSQL 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 a PostgreSQL service endpoint. The minimum required variables are:

   export MINIO_NOTIFY_POSTGRES_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_<IDENTIFIER>="host=postgresql-endpoint.example.net port=4222"
   export MINIO_NOTIFY_POSTGRES_TABLE_<IDENTIFIER>="minioevents"
   export MINIO_NOTIFY_POSTGRES_FORMAT_<IDENTIFIER>="namespace|access"
   export MINIO_NOTIFY_POSTGRES_MAX_OPEN_CONNECTIONS_<IDENTIFIER>="2"
   export MINIO_NOTIFY_POSTGRES_QUEUE_DIR_<IDENTIFIER>="/opt/minio/events"
   export MINIO_NOTIFY_POSTGRES_QUEUE_LIMIT_<IDENTIFIER>="100000"
   export MINIO_NOTIFY_POSTGRES_COMMENT_<IDENTIFIER>="PostgreSQL Notification Event Logging for Buckit"

  • Replace <IDENTIFIER> with a unique descriptive string for the PostgreSQL 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 PostgreSQL service endpoint on the Buckit deployment, the new settings override any existing settings for that endpoint. Use bm admin config get notify_postgres to review the currently configured PostgreSQL endpoints on the Buckit deployment.

  • Replace <ENDPOINT> with the PostgreSQL Connection String for PostgreSQL service endpoint. Buckit supports key=value format for the connection string. For example:

    "host=https://postgresql.example.com port=5432 ..."

    For more complete documentation on supported PostgreSQL connection string parameters, see PostgreSQL Connection String.

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

Buckit supports adding or updating PostgreSQL endpoints on a running buckit server process using the bm admin config set command and the notify_postgres 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 PostgreSQL service endpoint. The minimum required setting are:

bm admin config set ALIAS/ notify_postgres:IDENTIFIER \
   connection_string="ENDPOINT" \
   table="<string>" \
   format="<string>" \
   max_open_connections="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

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

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

  • Replace <ENDPOINT> with the PostgreSQL URI connection string of the PostgreSQL service endpoint. Buckit supports key=value format for the PostgreSQL connection string. For example:

    "host=https://postgresql.example.com port=5432 ..."

    For more complete documentation on supported PostgreSQL connection string parameters, see PostgreSQL Connection String.

See PostgreSQL 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 PostgreSQL target similar to the following:

SQS ARNs: arn:minio:sqs::primary:postgresql

You must specify the ARN resource when configuring bucket notifications with the associated PostgreSQL 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:postgresql.

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:postgresql

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

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

bm event add ALIAS/BUCKET arn:minio:sqs::primary:postgresql \
  --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:postgresql

4) Validate the Configured Events

Perform an action on the bucket for which you configured the new event and check the PostgreSQL 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 a PostgreSQL Endpoint in a Buckit Deployment

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

Prerequisites

PostgreSQL 9.5 and later

Buckit relies on features introduced with PostgreSQL 9.5.

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 PostgreSQL Endpoints In The Deployment

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

bm admin config get ALIAS/ notify_postgres

Replace ALIAS with the alias of the Buckit deployment.

The command output resembles the following:

notify_postgres:primary queue_dir="" connection_string="postgresql://" queue_limit="0"  table="" format="namespace"
notify_postgres:secondary queue_dir="" connection_string="" queue_limit="0"  table="" format="namespace"

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

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

2) Update the PostgreSQL Endpoint

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

bm admin config set ALIAS/ notify_postgres:IDENTIFIER \
   connection_string="ENDPOINT" \
   table="<string>" \
   format="<string>" \
   max_open_connections="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

The following configuration settings are the minimum required for a PostgreSQL service endpoint:

All other configuration settings are optional. See PostgreSQL Notification Settings for a complete list of PostgreSQL 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 PostgreSQL target similar to the following:

SQS ARNs: arn:minio:sqs::primary:postgresql

4) Validate the Changes

Perform an action on a bucket which has an event configuration using the updated PostgreSQL service endpoint and check the PostgreSQL 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