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

Update minio.py and mc references for simplified structure

This commit is contained in:
Ravind Kumar
2022-02-25 14:43:42 -05:00
committed by Ravind Kumar
parent 4669f340a8
commit 74e55a6ded
87 changed files with 963 additions and 990 deletions

View File

@ -182,7 +182,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured AMQP
@ -207,7 +207,7 @@ event with the configured AMQP service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:amqp \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -226,7 +226,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the AMQP service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -286,7 +286,7 @@ configured AMQP service endpoints in the deployment:
mc admin config get ALIAS/ notify_amqp
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -353,7 +353,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured AMQP
@ -368,7 +368,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
AMQP service endpoint and check the AMQP service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -173,7 +173,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured Elasticsearch
@ -198,7 +198,7 @@ event with the configured Elasticsearch service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:elasticsearch \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -217,7 +217,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the Elasticsearch service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -269,7 +269,7 @@ configured Elasticsearch service endpoints in the deployment:
mc admin config get ALIAS/ notify_elasticsearch
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -333,7 +333,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured
@ -349,7 +349,7 @@ Elasticsearch target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
Elasticsearch service endpoint and check the Elasticsearch service for the
notification data. The action required depends on which
:mc-cmd:`events <mc-event-add-event>` were specified when configuring the bucket
:mc-cmd:`events <mc event add --event>` were specified when configuring the bucket
notification.
For example, if the bucket notification configuration includes the

View File

@ -180,7 +180,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured
@ -205,7 +205,7 @@ event with the configured Kafka service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:kafka \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -224,7 +224,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the Kafka service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -277,7 +277,7 @@ configured Kafka service endpoints in the deployment:
mc admin config get ALIAS/ notify_kafka
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -346,7 +346,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured
@ -361,7 +361,7 @@ Kafka target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
Kafka service endpoint and check the Kafka service for the notification data.
The action required depends on which :mc-cmd:`events <mc-event-add-event>` were
The action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -185,7 +185,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured MQTT
@ -210,7 +210,7 @@ event with the configured MQTT service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -229,7 +229,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the MQTT service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -286,7 +286,7 @@ configured MQTT service endpoints in the deployment:
mc admin config get ALIAS/ notify_mqtt
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -360,7 +360,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured MQTT
@ -375,7 +375,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
MQTT service endpoint and check the MQTT service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -172,7 +172,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured MySQL
@ -197,7 +197,7 @@ event with the configured MySQL service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:mysql \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -216,7 +216,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the MySQL service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -266,7 +266,7 @@ configured MySQL service endpoints in the deployment:
mc admin config get ALIAS/ notify_mysql
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -333,7 +333,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured MySQL
@ -348,7 +348,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
MySQL service endpoint and check the MySQL service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -172,7 +172,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured NATS
@ -197,7 +197,7 @@ event with the configured NATS service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:nats \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -216,7 +216,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the NATS service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -261,7 +261,7 @@ configured NATS service endpoints in the deployment:
mc admin config get ALIAS/ notify_nats
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -333,7 +333,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured NATS
@ -348,7 +348,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
NATS service endpoint and check the NATS service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -153,7 +153,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured NSQ
@ -178,7 +178,7 @@ event with the configured NSQ service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:nsq \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -197,7 +197,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the NSQ service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -242,7 +242,7 @@ configured NSQ service endpoints in the deployment:
mc admin config get ALIAS/ notify_nsq
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -304,7 +304,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured NSQ
@ -319,7 +319,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
NSQ service endpoint and check the NSQ service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -175,7 +175,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured PostgreSQL
@ -200,7 +200,7 @@ event with the configured PostgreSQL service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:postgresql \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -219,7 +219,7 @@ a given notification target:
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 :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -269,7 +269,7 @@ configured PostgreSQL service endpoints in the deployment:
mc admin config get ALIAS/ notify_postgresql
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -338,7 +338,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured PostgreSQL
@ -353,7 +353,7 @@ target similar to the following:
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 :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -155,7 +155,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured Redis
@ -180,7 +180,7 @@ event with the configured Redis service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:redis \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -199,7 +199,7 @@ a given notification target:
Perform an action on the bucket for which you configured the new event and
check the Redis service for the notification data. The action required
depends on which :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -244,7 +244,7 @@ configured Redis service endpoints in the deployment:
mc admin config get ALIAS/ notify_redis
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -306,7 +306,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured Redis
@ -321,7 +321,7 @@ target similar to the following:
Perform an action on a bucket which has an event configuration using the updated
Redis service endpoint and check the Redis service for the notification data. The
action required depends on which :mc-cmd:`events <mc-event-add-event>` were
action required depends on which :mc-cmd:`events <mc event add --event>` were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the

View File

@ -153,7 +153,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured
@ -178,7 +178,7 @@ event with the configured Webhook service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:webhook \
--event EVENTS
- Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of a MinIO deployment.
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment.
- Replace ``BUCKET`` with the name of the bucket in which to configure the
event.
- Replace ``EVENTS`` with a comma-separated list of :ref:`events
@ -197,7 +197,7 @@ a given notification target:
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 :mc-cmd:`events <mc-event-add-event>` were specified
depends on which :mc-cmd:`events <mc event add --event>` were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
@ -242,7 +242,7 @@ configured Webhook service endpoints in the deployment:
mc admin config get ALIAS/ notify_webhook
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the MinIO deployment.
Replace ``ALIAS`` with the :ref:`alias <alias>` of the MinIO deployment.
The command output resembles the following:
@ -304,7 +304,7 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
mc admin service restart ALIAS
Replace ``ALIAS`` with the :mc:`alias <mc-alias>` of the deployment to
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
restart.
The :mc:`minio server` process prints a line on startup for each configured Webhook
@ -319,7 +319,7 @@ target similar to the following:
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 :mc-cmd:`events <mc-event-add-event>`
data. The action required depends on which :mc-cmd:`events <mc event add --event>`
were specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the