1
0
mirror of https://github.com/minio/docs.git synced 2025-04-19 21:02:14 +03:00
Andrea Longo 162c5ea6cd
Add info for Object Lambda via configuration settings (#1428)
Thank you to @wdinyes for noticing you can configure Object Lambda this
way. New text is not super comprehensive, but hopefully enough to guide
someone in the correct direction. My understanding is not too many
people are using Object Lambda right now.

Staged:

http://192.241.195.202:9000/staging/DOCS-1400/linux/reference/minio-server/settings/object-lambda.html

Fixes https://github.com/minio/docs/issues/1400
2025-02-21 15:28:40 -07:00

6.5 KiB

Object Lambda function settings

minio

Table of Contents

This page describes the settings available to configure MinIO to publish data to an HTTP webhook endpoint and trigger an Object Lambda function. See developers-object-lambda for more complete documentation and tutorials on using these settings.

You can establish or modify settings by defining:

  • an environment variable on the host system prior to starting or restarting the MinIO Server. Refer to your operating system's documentation for how to define an environment variable.
  • a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Enable

Environment Variable

MINIO_LAMBDA_WEBHOOK_ENABLE

Specify "on" to enable the Object Lambda webhook endpoint for a handler function.

Requires specifying MINIO_LAMBDA_WEBHOOK_ENDPOINT.

You can specify multiple webhooks as Lambda targets by appending a unique identifier for each Object Lambda function.

For example, the following command enables two distinct Object Lambda webhook endpoints:

export MINIO_LAMBDA_WEBHOOK_ENABLE_myfunction="on"
export MINIO_LAMBDA_WEBHOOK_ENABLE_yourfunction="on"

Configuration Setting

lambda_webhook enable

Optional

Specify "on" to enable the Object Lambda webhook endpoint for a handler function.

Requires specifying ~lambda_webhook.endpoint.

Example:

mc admin config set myminio lambda_webhook:myfunction endpoint="https://example.com/" enable=on

Endpoint

Environment Variable

MINIO_LAMBDA_WEBHOOK_ENDPOINT

The HTTP endpoint of the lambda webhook for the handler function.

You can specify multiple webhook endpoints as Lambda targets by appending a unique identifier for each Object Lambda function. For example, the following command sets two distinct Object Lambda webhook endpoints:

export MINIO_LAMBDA_WEBHOOK_ENDPOINT_myfunction="http://webhook-1.example.com"
export MINIO_LAMBDA_WEBHOOK_ENDPOINT_yourfunction="http://webhook-2.example.com"

Configuration Setting

lambda_webhook endpoint

Optional

The HTTP endpoint of the lambda webhook for the handler function.

Auth token

Environment Variable

MINIO_LAMBDA_WEBHOOK_AUTH_TOKEN

Specify the opaque string or JWT authorization token to use for authenticating to the lambda webhook service.

You can specify the token for multiple Lambda targets by appending a unique identifier for each Object Lambda function. For example, the following command configures a token for two distinct Object Lambda webhook endpoints:

export MINIO_LAMBDA_WEBHOOK_AUTH_TOKEN_myfunction="1a2b3c4d5e"
export MINIO_LAMBDA_WEBHOOK_AUTH_TOKEN_yourfunction="1a2b3c4d5e"

RELEASE.2023-06-23T20-26-00Z

MinIO redacts this value when returned as part of mc admin config get.

Configuration Setting

lambda_webhook auth_token

Optional

Specify the opaque string or JWT authorization token to use for authenticating to the lambda webhook service.

RELEASE.2023-06-23T20-26-00Z

MinIO redacts this value when returned as part of mc admin config get.

Client cert

Environment Variable

MINIO_LAMBDA_WEBHOOK_CLIENT_CERT

Specify the path to the client certificate to use for performing mTLS authentication to the lambda webhook service.

You can specify the client cert for multiple Lambda targets by appending a unique identifier for each Object Lambda function. For example, the following command configures a cert for two distinct Object Lambda webhook endpoints:

export MINIO_LAMBDA_WEBHOOK_CLIENT_CERT_myfunction="/path/to/cert1"
export MINIO_LAMBDA_WEBHOOK_CLIENT_CERT_yourfunction="/path/to/cert2"

Configuration Setting

lambda_webhook client_cert

Optional

Specify the path to the client certificate to use for performing mTLS authentication to the lambda webhook service.

Client key

Environment Variable

MINIO_LAMBDA_WEBHOOK_CLIENT_KEY

Specify the path to the private key to use for performing mTLS authentication to the lambda webhook service.

You can specify the client key for multiple Lambda targets by appending a unique identifier for each Object Lambda function. For example, the following command configures a key for two distinct Object Lambda webhook endpoints:

export MINIO_LAMBDA_WEBHOOK_CLIENT_KEY_myfunction="/path/to/key1"
export MINIO_LAMBDA_WEBHOOK_CLIENT_KEY_yourfunction="/path/to/key2"

Configuration Setting

lambda_webhook client_key

Optional

Specify the path to the private key to use for performing mTLS authentication to the lambda webhook service.