1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00

Object Lambda docs (#800)

Object Lambda functions to transform objects via a webhook. Expand and
refine the developer docs from


c4d71bc1a5/docs/lambda/README.md

into a new page in the user documentation.

Staged

http://192.241.195.202:9000/staging/DOCS-754/linux/html/developers/transforms-with-object-lambda.html

Notes for reviewers:

In addition to the items noted in inline comments, some general things
to confirm:
* Accurate usage/terminology? Is this how we talk about the relevant
topics?
* Any technical points that need more/more correct detail?
* What would someone need to know to go from trying this dev example to
having a real function in their production environment?

[x] Add new docs page in Developers
[x] Add envars to envar list

Fixes https://github.com/minio/docs/issues/754
This commit is contained in:
Andrea Longo
2023-04-19 15:05:48 -06:00
committed by GitHub
parent ed88e699ab
commit 6d65d8aba2
4 changed files with 401 additions and 3 deletions

View File

@ -621,13 +621,13 @@ audit log webhook endpoints:
export MINIO_AUDIT_WEBHOOK_ENABLE_PRIMARY="on"
export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_PRIMARY="TOKEN"
export MINIO_AUDIT_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net
export MINIO_AUDIT_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net"
export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem"
export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem"
export MINIO_AUDIT_WEBHOOK_ENABLE_SECONDARY="on"
export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_SECONDARY="TOKEN"
export MINIO_AUDIT_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-1.example.net
export MINIO_AUDIT_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-1.example.net"
export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem"
export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem"
@ -2238,6 +2238,35 @@ endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
:mc-conf:`notify_webhook comment <notify_webhook.comment>`
configuration setting.
.. _minio-server-envvar-object-lambda-webhook:
Object Lambda
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following section documents environment variables for configuring MinIO to publish data to an HTTP webhook endpoint and trigger an Object Lambda function.
See :ref:`developers-object-lambda` for more complete documentation and tutorials on using these environment variables.
You can specify multiple webhook endpoints as Lambda targets by appending a unique identifier ``_FUNCTIONNAME`` for each Object Lambda function.
For example, the following command sets two distinct Object Lambda webhook endpoints:
.. code-block:: shell
:class: copyable
export MINIO_LAMBDA_WEBHOOK_ENABLE_myfunction="on"
export MINIO_LAMBDA_WEBHOOK_ENDPOINT_myfunction="http://webhook-1.example.net"
export MINIO_LAMBDA_WEBHOOK_ENABLE_yourfunction="on"
export MINIO_LAMBDA_WEBHOOK_ENDPOINT_yourfunction="http://webhook-2.example.net"
.. envvar:: MINIO_LAMBDA_WEBHOOK_ENABLE
Specify ``"on"`` to enable the Object Lambda webhook endpoint for a handler function.
Requires specifying :envvar:`MINIO_LAMBDA_WEBHOOK_ENDPOINT`.
.. envvar:: MINIO_LAMBDA_WEBHOOK_ENDPOINT
The HTTP endpoint of the webhook for the handler function.
.. _minio-server-envvar-external-identity-management-ad-ldap:
Active Directory / LDAP Identity Management