Publish Events to PostgreSQL — MinIO Object Storage for Linux (original) (raw)
Table of Contents
MinIO supports publishing bucket notification events toPostgreSQL. MinIO supports PostgreSQL 9.5 and later only.
Add a PostgreSQL Endpoint to a MinIO Deployment
The following procedure adds a new PostgreSQL service endpoint for supportingbucket notifications in a MinIO deployment.
Prerequisites
PostgreSQL 9.5 and later
MinIO relies on features introduced with PostgreSQL 9.5.
MinIO mc Command Line Tool
This procedure uses the mc command line tool for certain actions. See the mc Quickstart for installation instructions.
1) Add the PostgreSQL Endpoint to MinIO
You can configure a new PostgreSQL service endpoint using either environment variables or by setting runtime configuration settings.
Environment Variables
MinIO supports specifying the PostgreSQL service endpoint and associated configuration settings usingenvironment variables. Theminio 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_="on" export MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_="host=postgresql-endpoint.example.net port=4222" export MINIO_NOTIFY_POSTGRES_TABLE_="minioevents" export MINIO_NOTIFY_POSTGRES_FORMAT_="namespace|access" export MINIO_NOTIFY_POSTGRES_MAX_OPEN_CONNECTIONS_="2" export MINIO_NOTIFY_POSTGRES_QUEUE_DIR_="/opt/minio/events" export MINIO_NOTIFY_POSTGRES_QUEUE_LIMIT_="100000" export MINIO_NOTIFY_POSTGRES_COMMENT_="PostgreSQL Notification Event Logging for MinIO"
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 ofPRIMARY.
If the specified<IDENTIFIER>matches an existing PostgreSQL service endpoint on the MinIO deployment, the new settings _override_any existing settings for that endpoint. Usemc admin config get notify_postgres to review the currently configured PostgreSQL endpoints on the MinIO deployment.Replace
<ENDPOINT>with the PostgreSQL Connection Stringfor PostgreSQL service endpoint. MinIO supportskey=valueformat 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.
Configuration Settings
MinIO supports adding or updating PostgreSQL endpoints on a runningminio server process using the mc admin config set command and the notify_postgres configuration key. You must restart theminio 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:
mc admin config set ALIAS/ notify_postgres:IDENTIFIER
connection_string="ENDPOINT"
table=""
format=""
max_open_connections=""
queue_dir=""
queue_limit=""
comment=""
- Replace
IDENTIFIERwith a unique descriptive string for the PostgreSQL service endpoint. The following examples in this procedure assume an identifier ofPRIMARY.
If the specifiedIDENTIFIERmatches an existing PostgreSQL service endpoint on the MinIO deployment, the new settings _override_any existing settings for that endpoint. Usemc admin config get notify_postgres to review the currently configured PostgreSQL endpoints on the MinIO deployment. - Replace
<ENDPOINT>with the PostgreSQL URI connection stringof the PostgreSQL service endpoint. MinIO supportskey=valueformat 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 MinIO Deployment
You must restart the MinIO deployment to apply the configuration changes. Use the mc admin service restart command to restart the deployment.
mc admin service restart ALIAS
Replace ALIAS with the alias of the deployment to restart.
The minio 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
- Copy and run the following command, replacing
ALIASwith the alias of the deployment.
mc admin info --json ALIAS - 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
- Install jq
- Copy and run the following command, replacing
ALIASwith the alias of the deployment.
mc admin info --json ALIAS | jq .info.sqsARN
This returns the ARN to use for notifications, such asarn:minio:sqs::primary:postgresql
3) Configure Bucket Notifications using the PostgreSQL Endpoint as a Target
Use the mc event add command to add a new bucket notification event with the configured PostgreSQL service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:postgresql
--event EVENTS
- Replace
ALIASwith the alias of a MinIO deployment. - Replace
BUCKETwith the name of the bucket in which to configure the ßevent. - Replace
EVENTSwith a comma-separated list of events for which MinIO triggers notifications.
Use mc event ls to view all configured bucket events for a given notification target:
mc 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 thes3:ObjectCreated:Put event, you can use themc cp command to create a new object in the bucket and trigger a notification.
mc cp ~/data/new-object.txt ALIAS/BUCKET
Update a PostgreSQL Endpoint in a MinIO Deployment
The following procedure updates an existing PostgreSQL service endpoint for supporting bucket notifications in a MinIO deployment.
Prerequisites
PostgreSQL 9.5 and later
MinIO relies on features introduced with PostgreSQL 9.5.
MinIO mc Command Line Tool
This procedure uses the mc command line tool for certain actions. See the mc Quickstart for installation instructions.
1) List Configured PostgreSQL Endpoints In The Deployment
Use the mc admin config get command to list the currently configured PostgreSQL service endpoints in the deployment:
mc admin config get ALIAS/ notify_postgres
Replace ALIAS with the alias of the MinIO 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 anPostgreSQL Notification Settings. Theconnection_string key specifies the PostgreSQL service endpoint for the given notify_postgres key. Thenotify_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 mc admin config set command to set the new configuration for the PostgreSQL service endpoint:
mc admin config set ALIAS/ notify_postgres:IDENTIFIER
connection_string="ENDPOINT"
table=""
format=""
max_open_connections=""
queue_dir=""
queue_limit=""
comment=""
The following configuration settings are the minimum required for a PostgreSQL service endpoint:
All other configuration settings are optional. SeePostgreSQL Notification Settings for a complete list of PostgreSQL configuration settings.
3) Restart the MinIO Deployment
You must restart the MinIO deployment to apply the configuration changes. Use the mc admin service restart command to restart the deployment.
mc admin service restart ALIAS
Replace ALIAS with the alias of the deployment to restart.
The minio 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 thes3:ObjectCreated:Put event, you can use themc cp command to create a new object in the bucket and trigger a notification.
mc cp ~/data/new-object.txt ALIAS/BUCKET