From a6d554acdc2ed2b512003da2a77abb2fa12633c5 Mon Sep 17 00:00:00 2001 From: Ravind Kumar Date: Tue, 23 May 2023 17:29:48 -0400 Subject: [PATCH] DOCS-807, DOCS-846, Misc. Bug fixes (#861) Closes #807 Closes #846 --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com> --- .../minio-user-management.rst | 8 +- .../monitoring/publish-events-to-amqp.rst | 4 +- .../publish-events-to-elasticsearch.rst | 4 +- .../monitoring/publish-events-to-kafka.rst | 4 +- .../monitoring/publish-events-to-mqtt.rst | 4 +- .../monitoring/publish-events-to-mysql.rst | 4 +- .../monitoring/publish-events-to-nats.rst | 4 +- .../monitoring/publish-events-to-nsq.rst | 4 +- .../publish-events-to-postgresql.rst | 4 +- .../monitoring/publish-events-to-redis.rst | 4 +- .../monitoring/publish-events-to-webhook.rst | 4 +- .../AssumeRoleWithLDAPIdentity.rst | 15 ++++ source/operations/troubleshooting.rst | 3 + source/reference/deprecated/mc-ilm-rm.rst | 3 + source/reference/minio-mc-admin.rst | 14 +++- .../minio-mc-admin/mc-admin-bucket-remote.rst | 31 +------- .../mc-admin-cluster-bucket-export.rst | 72 +++++++++++++++++ .../mc-admin-cluster-bucket-import.rst | 79 +++++++++++++++++++ .../mc-admin-cluster-bucket.rst | 60 ++++++++++++++ .../mc-admin-cluster-iam-export.rst | 64 +++++++++++++++ .../mc-admin-cluster-iam-import.rst | 73 +++++++++++++++++ .../minio-mc-admin/mc-admin-cluster-iam.rst | 56 +++++++++++++ .../minio-mc-admin/mc-admin-group.rst | 32 ++++---- .../minio-mc-admin/mc-admin-idp-ldap.rst | 37 ++++++++- .../minio-mc-admin/mc-admin-idp-openid.rst | 12 +-- .../minio-mc-admin/mc-admin-policy-list.rst | 16 ++-- .../minio-mc-admin/mc-admin-policy-remove.rst | 16 ++-- .../minio-mc-admin/mc-admin-policy.rst | 4 +- .../minio-mc-admin/mc-admin-replicate.rst | 2 +- .../minio-mc-admin/mc-admin-user-list.rst | 21 ++--- .../minio-mc-admin/mc-admin-user-remove.rst | 21 ++--- .../mc-admin-user-svcacct-list.rst | 15 ++-- .../mc-admin-user-svcacct-remove.rst | 13 +-- .../minio-mc-admin/mc-admin-user-svcacct.rst | 2 +- .../minio-mc-admin/mc-admin-user.rst | 4 +- source/reference/minio-mc.rst | 6 +- source/reference/minio-mc/mc-event-list.rst | 17 ++-- source/reference/minio-mc/mc-event-remove.rst | 33 ++++---- source/reference/minio-mc/mc-event.rst | 4 +- source/reference/minio-mc/mc-ilm-rule-ls.rst | 3 + source/reference/minio-mc/mc-ilm-tier-ls.rst | 3 + source/reference/minio-mc/mc-ilm-tier-rm.rst | 3 + source/reference/minio-mc/mc-mirror.rst | 8 +- source/reference/minio-mc/mc-replicate-ls.rst | 3 + source/reference/minio-mc/mc-replicate-rm.rst | 3 + source/reference/minio-mc/mc-share-list.rst | 25 +++--- source/reference/minio-mc/mc-tag-list.rst | 7 ++ source/reference/minio-mc/mc-tag-remove.rst | 9 ++- source/reference/minio-mc/mc-tag-set.rst | 7 ++ 49 files changed, 676 insertions(+), 168 deletions(-) create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-bucket-export.rst create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-bucket-import.rst create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-bucket.rst create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-iam-export.rst create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-iam-import.rst create mode 100644 source/reference/minio-mc-admin/mc-admin-cluster-iam.rst diff --git a/source/administration/identity-access-management/minio-user-management.rst b/source/administration/identity-access-management/minio-user-management.rst index 5e9036b3..d0f1ef6d 100644 --- a/source/administration/identity-access-management/minio-user-management.rst +++ b/source/administration/identity-access-management/minio-user-management.rst @@ -156,16 +156,16 @@ Replace ``USERNAME`` with the ``ACCESSKEY`` created in the previous step. Delete a User ~~~~~~~~~~~~~ -Use the :mc:`mc admin user remove` command to remove a user on a +Use the :mc:`mc admin user rm` command to remove a user on a MinIO deployment: .. code-block:: shell :class: copyable - mc admin user remove ALIAS USERNAME + mc admin user rm ALIAS USERNAME -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc:`alias ` of the MinIO deployment. -- Replace :mc-cmd:`USERNAME ` with the name of +- Replace :mc-cmd:`USERNAME ` with the name of the user to remove. \ No newline at end of file diff --git a/source/administration/monitoring/publish-events-to-amqp.rst b/source/administration/monitoring/publish-events-to-amqp.rst index 251641e2..291b020a 100644 --- a/source/administration/monitoring/publish-events-to-amqp.rst +++ b/source/administration/monitoring/publish-events-to-amqp.rst @@ -206,13 +206,13 @@ event with the configured AMQP service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:amqp + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:amqp 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-elasticsearch.rst b/source/administration/monitoring/publish-events-to-elasticsearch.rst index e3f55def..ac552130 100644 --- a/source/administration/monitoring/publish-events-to-elasticsearch.rst +++ b/source/administration/monitoring/publish-events-to-elasticsearch.rst @@ -198,13 +198,13 @@ event with the configured Elasticsearch service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:elasticsearch + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:elasticsearch 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-kafka.rst b/source/administration/monitoring/publish-events-to-kafka.rst index a295e87d..f5ee5c16 100644 --- a/source/administration/monitoring/publish-events-to-kafka.rst +++ b/source/administration/monitoring/publish-events-to-kafka.rst @@ -205,13 +205,13 @@ event with the configured Kafka service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:kafka + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:kafka 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-mqtt.rst b/source/administration/monitoring/publish-events-to-mqtt.rst index 089a8f70..c8e46171 100644 --- a/source/administration/monitoring/publish-events-to-mqtt.rst +++ b/source/administration/monitoring/publish-events-to-mqtt.rst @@ -209,13 +209,13 @@ event with the configured MQTT service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:MQTT + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:MQTT 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-mysql.rst b/source/administration/monitoring/publish-events-to-mysql.rst index c644611b..fe404669 100644 --- a/source/administration/monitoring/publish-events-to-mysql.rst +++ b/source/administration/monitoring/publish-events-to-mysql.rst @@ -197,13 +197,13 @@ event with the configured MySQL service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:mysql + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:mysql 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-nats.rst b/source/administration/monitoring/publish-events-to-nats.rst index c8b5d770..5a8347ee 100644 --- a/source/administration/monitoring/publish-events-to-nats.rst +++ b/source/administration/monitoring/publish-events-to-nats.rst @@ -196,13 +196,13 @@ event with the configured NATS service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:nats + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:nats 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-nsq.rst b/source/administration/monitoring/publish-events-to-nsq.rst index 706241a4..55a0fa5a 100644 --- a/source/administration/monitoring/publish-events-to-nsq.rst +++ b/source/administration/monitoring/publish-events-to-nsq.rst @@ -174,12 +174,12 @@ Use the :mc:`mc event add` command to add a new bucket notification event with t - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for a given notification target: +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:nsq + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:nsq 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-postgresql.rst b/source/administration/monitoring/publish-events-to-postgresql.rst index 0457229f..5946f36d 100644 --- a/source/administration/monitoring/publish-events-to-postgresql.rst +++ b/source/administration/monitoring/publish-events-to-postgresql.rst @@ -199,13 +199,13 @@ event with the configured PostgreSQL service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:postgresql + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:postgresql 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-redis.rst b/source/administration/monitoring/publish-events-to-redis.rst index c48152be..d5067f2c 100644 --- a/source/administration/monitoring/publish-events-to-redis.rst +++ b/source/administration/monitoring/publish-events-to-redis.rst @@ -179,13 +179,13 @@ event with the configured Redis service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:redis + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:redis 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/monitoring/publish-events-to-webhook.rst b/source/administration/monitoring/publish-events-to-webhook.rst index 14951c6e..82981ce7 100644 --- a/source/administration/monitoring/publish-events-to-webhook.rst +++ b/source/administration/monitoring/publish-events-to-webhook.rst @@ -177,13 +177,13 @@ event with the configured Webhook service as a target: - Replace ``EVENTS`` with a comma-separated list of :ref:`events ` for which MinIO triggers notifications. -Use :mc:`mc event list` to view all configured bucket events for +Use :mc:`mc event ls` to view all configured bucket events for a given notification target: .. code-block:: shell :class: copyable - mc event list ALIAS/BUCKET arn:minio:sqs::primary:webhook + mc event ls ALIAS/BUCKET arn:minio:sqs::primary:webhook 4) Validate the Configured Events ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/developers/security-token-service/AssumeRoleWithLDAPIdentity.rst b/source/developers/security-token-service/AssumeRoleWithLDAPIdentity.rst index 861e59ce..9272377b 100644 --- a/source/developers/security-token-service/AssumeRoleWithLDAPIdentity.rst +++ b/source/developers/security-token-service/AssumeRoleWithLDAPIdentity.rst @@ -79,6 +79,21 @@ This endpoint supports the following query parameters: Specify ``2011-06-15``. + * - ``DurationSeconds`` + - integer + - *Optional* + + Specify the number of seconds after which the temporary credentials + expire. Defaults to ``3600``. + + - The minimum value is ``900`` or 15 minutes. + - The maximum value is ``604800`` or 7 days. + + If ``DurationSeconds`` is omitted, MinIO checks the JWT token for an + ``exp`` claim before using the default duration. See + `RFC 7519 4.1.4: Expiration Time Claim + `__ + for more information on JSON web token expiration. * - ``Policy`` - string diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index 377e876e..3e8c53c4 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -40,6 +40,9 @@ For more information, see details at the |SUBNET| page. Registering Your MinIO Deployment with SUBNET --------------------------------------------- +Starting with :minio-release:`RELEASE.2023-04-07T05-28-58Z`, the Console prompts you to restart the deployment after registering with SUBNET. +You can restart through the Console by selecting :guilabel:`Restart` in the top banner or by using :mc-cmd:`mc admin service restart`. + .. tab-set:: .. tab-item:: Console diff --git a/source/reference/deprecated/mc-ilm-rm.rst b/source/reference/deprecated/mc-ilm-rm.rst index 0cf2cae9..84ab189a 100644 --- a/source/reference/deprecated/mc-ilm-rm.rst +++ b/source/reference/deprecated/mc-ilm-rm.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc ilm remove .. mc:: mc ilm rm .. versionchanged:: RELEASE.2022-12-24T15-21-38Z @@ -27,6 +28,8 @@ MinIO Bucket. .. end-mc-ilm-rm-desc +The :mc:`mc ilm remove` command has equivalent functionality to :mc:`mc ilm rm`. + .. tab-set:: .. tab-item:: EXAMPLE diff --git a/source/reference/minio-mc-admin.rst b/source/reference/minio-mc-admin.rst index 66bc403d..f56aced0 100644 --- a/source/reference/minio-mc-admin.rst +++ b/source/reference/minio-mc-admin.rst @@ -40,6 +40,16 @@ The following table lists :mc:`mc admin` commands: :start-after: start-mc-admin-bucket-remote-desc :end-before: end-mc-admin-bucket-remote-desc + * - :mc:`mc admin cluster bucket` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-bucket.rst + :start-after: start-mc-admin-cluster-bucket-desc + :end-before: end-mc-admin-cluster-bucket-desc + + * - :mc:`mc admin cluster iam` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-iam.rst + :start-after: start-mc-admin-cluster-iam-desc + :end-before: end-mc-admin-cluster-iam-desc + * - :mc-cmd:`mc admin console` - .. include:: /reference/minio-mc-admin/mc-admin-console.rst :start-after: start-mc-admin-console-desc @@ -194,7 +204,9 @@ See :ref:`minio-mc-global-options`. :hidden: :glob: - /reference/minio-mc-admin/mc-admin-bucket-remote.rst + /reference/minio-mc-admin/mc-admin-bucket-remote + /reference/minio-mc-admin/mc-admin-cluster-bucket + /reference/minio-mc-admin/mc-admin-cluster-iam /reference/minio-mc-admin/mc-admin-config /reference/minio-mc-admin/mc-admin-console /reference/minio-mc-admin/mc-admin-decommission diff --git a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst index 72ff72de..9baa4688 100644 --- a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst +++ b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst @@ -205,36 +205,11 @@ Syntax - ``mc admin bucket remote ls`` replaced by :mc-cmd:`mc replicate ls` - Lists all remote targets associated to a bucket on the MinIO deployment. The - command has the following syntax: - - .. code-block:: shell - :class: copyable - - mc admin bucket remote ls SOURCE --service "replication" - - The command accepts the following arguments: - - .. mc-cmd:: SOURCE - - The full path to the bucket for which the command returns the configured - remote targets. Specify the :mc-cmd:`alias ` of a configured - MinIO deployment as the prefix to the bucket path. For example: - - .. code-block:: shell - :class: copyable - - mc admin bucket remote ls play/mybucket - - .. mc-cmd:: --service - - - *Required* - - Specify ``"replication"``. + Lists all remote targets associated to a bucket on the MinIO deployment. + Use ``mc admin bucket remote ls --help`` for usage syntax. -.. mc-cmd:: rm +.. mc-cmd:: rm, remove :fullpath: .. versionchanged:: RELEASE.2022-12-24T15-21-38Z diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-bucket-export.rst b/source/reference/minio-mc-admin/mc-admin-cluster-bucket-export.rst new file mode 100644 index 00000000..911bef27 --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-bucket-export.rst @@ -0,0 +1,72 @@ +.. _minio-mc-admin-cluster-bucket-export: + +================================== +``mc admin cluster bucket export`` +================================== + +.. default-domain:: minio + +.. mc:: mc admin cluster bucket export + +Description +----------- + +.. versionadded:: RELEASE.2022-06-17T02-52-50Z + +.. start-mc-admin-cluster-bucket-export-desc + +The :mc:`mc admin cluster bucket export` command exports bucket metadata for use with the :mc:`mc admin cluster bucket import` command. + +.. end-mc-admin-cluster-bucket-export-desc + +You can use this command to manually back up the metadata for the specified MinIO bucket. +The command always saves the output as ``cluster-metadata.zip``. + +If you specify only the deployment as the target, this command backs up all bucket metadata on the target deployment. + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following command exports all bucket metadata for the ``myminio`` deployment. + + .. code-block:: shell + :class: copyable + + mc admin cluster bucket export myminio + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] admin cluster bucket export \ + ALIAS[/BUCKET] + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :mc-cmd:`alias ` of the MinIO deployment. + +.. mc-cmd:: BUCKET + :optional: + + The bucket to export metadata for. + + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-bucket-import.rst b/source/reference/minio-mc-admin/mc-admin-cluster-bucket-import.rst new file mode 100644 index 00000000..58993cfc --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-bucket-import.rst @@ -0,0 +1,79 @@ +.. _minio-mc-admin-cluster-bucket-import: + +================================== +``mc admin cluster bucket import`` +================================== + +.. default-domain:: minio + +.. mc:: mc admin cluster bucket import + +Description +----------- + +.. versionadded:: RELEASE.2022-06-17T02-52-50Z + +.. start-mc-admin-cluster-bucket-import-desc + +The :mc:`mc admin cluster bucket import` command imports bucket metadata as created by the :mc:`mc admin cluster bucket export` command. + +.. end-mc-admin-cluster-bucket-import-desc + +You can use this command to manually restore the metadata to the specified bucket on a MinIO deployment. + +If you specify only the deployment as the target, this command applies the metadata objects to all matching buckets on the target. + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following command imports the specified metadata to the ``myminio`` deployment. + + .. code-block:: shell + :class: copyable + + mc admin cluster bucket import myminio ~/minio-metadata-backup/myminio-cluster.zip + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] admin cluster bucket import \ + ALIAS[/BUCKET] \ + METADATA.ZIP + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :mc-cmd:`alias ` of the MinIO deployment. + +.. mc-cmd:: METADATA.ZIP + :required: + + The path to the metadata file to import. + + Use :mc:`mc admin cluster bucket export` to export bucket metadata for use with this command. + +.. mc-cmd:: BUCKET + :optional: + + The bucket to apply the imported metadata to. + + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-bucket.rst b/source/reference/minio-mc-admin/mc-admin-cluster-bucket.rst new file mode 100644 index 00000000..707beff4 --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-bucket.rst @@ -0,0 +1,60 @@ +.. _minio-mc-admin-cluster-bucket: + +=========================== +``mc admin cluster bucket`` +=========================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. mc:: mc admin cluster bucket + +Description +----------- + +.. versionadded:: RELEASE.2022-06-17T02-52-50Z + +.. start-mc-admin-cluster-bucket-desc + +The :mc:`mc admin cluster bucket` command and its subcommands provide tools for manually importing and exporting MinIO bucket metadata. + +.. end-mc-admin-cluster-bucket-desc + +This metadata includes configurations related to features like :ref:`lifecycle management rules `. +You can use this metadata as a snapshot of the bucket configuration for restoration later, such as part of :abbr:`BC/DR (Business Continuity / Disaster Recovery)` or backup/restore operations. + +You can use this command on individual buckets *or* on all buckets in a MinIO deployment. +For automatic synchronization of all buckets in a deployment to a remote site, use :ref:`site replication `. + +The :mc:`mc admin cluster bucket` command has the following subcommands: + +.. list-table:: + :header-rows: 1 + :widths: 40 60 + + * - Subcommand + - Description + + * - :mc:`~mc admin cluster bucket import` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-bucket-import.rst + :start-after: start-mc-admin-cluster-bucket-import-desc + :end-before: end-mc-admin-cluster-bucket-import-desc + + * - :mc:`~mc admin cluster bucket export` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-bucket-export.rst + :start-after: start-mc-admin-cluster-bucket-export-desc + :end-before: end-mc-admin-cluster-bucket-export-desc + + + +.. toctree:: + :titlesonly: + :hidden: + + /reference/minio-mc-admin/mc-admin-cluster-bucket-import + /reference/minio-mc-admin/mc-admin-cluster-bucket-export + + diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-iam-export.rst b/source/reference/minio-mc-admin/mc-admin-cluster-iam-export.rst new file mode 100644 index 00000000..f574584b --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-iam-export.rst @@ -0,0 +1,64 @@ +.. _minio-mc-admin-cluster-iam-export: + +=============================== +``mc admin cluster iam export`` +=============================== + +.. default-domain:: minio + +.. mc:: mc admin cluster iam export + +Description +----------- + +.. versionadded:: RELEASE.2022-06-26T18-51-48Z + +.. start-mc-admin-cluster-iam-export-desc + +The :mc:`mc admin cluster iam export` command exports :ref:`IAM ` metadata for use with the :mc:`mc admin cluster iam import` command. + +.. end-mc-admin-cluster-iam-export-desc + +The command saves the output as ``ALIAS-iam-metadata.zip``, where ``ALIAS`` is the :mc:`alias ` of the MinIO deployment. + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following command exports all IAM metadata for the ``myminio`` deployment. + + .. code-block:: shell + :class: copyable + + mc admin cluster iam export myminio + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] admin cluster iam export ALIAS + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + +Starting with :mc-release:`RELEASE.2023-05-04T18-10-16Z`, :mc:`mc admin cluster iam export` adds support for aliases ending with a trailing forward slash ``ALIAS/``. +Prior to this release, the command would fail when provided a trailing forward slash. + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :ref:`alias ` of the MinIO deployment to export IAM metadata for. + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-iam-import.rst b/source/reference/minio-mc-admin/mc-admin-cluster-iam-import.rst new file mode 100644 index 00000000..0ebb2e92 --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-iam-import.rst @@ -0,0 +1,73 @@ +.. _minio-mc-admin-cluster-iam-import: + +=============================== +``mc admin cluster iam import`` +=============================== + +.. default-domain:: minio + +.. mc:: mc admin cluster iam import + +Description +----------- + +.. versionadded:: RELEASE.2022-06-17T02-52-50Z + +.. start-mc-admin-cluster-iam-import-desc + +The :mc:`mc admin cluster iam import` command imports :ref:`IAM ` metadata as created by the :mc:`mc admin cluster iam export` command. + +.. end-mc-admin-cluster-iam-import-desc + +You can use this command to manually restore IAM metadata settings for a MinIO deployment. + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following command imports the IAM metadata of the specified file onto the ``myminio`` deployment. + + .. code-block:: shell + :class: copyable + + mc admin cluster iam import myminio ~/minio-metadata-backup/myminio-cluster.zip + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] admin cluster iam import \ + ALIAS \ + IAM-METADATA.ZIP + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + +Starting with :mc-release:`RELEASE.2023-05-04T18-10-16Z`, :mc:`mc admin cluster iam import` adds support for aliases ending with a trailing forward slash ``ALIAS/``. +Prior to this release, the command would fail when provided a trailing forward slash. + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :mc-cmd:`alias ` of the MinIO deployment. + +.. mc-cmd:: IAM-METADATA.ZIP + :required: + + The path to the IAM metadata file to import. + + Use the :mc:`mc admin cluster iam export` to export IAM metadata for use with this command. + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals diff --git a/source/reference/minio-mc-admin/mc-admin-cluster-iam.rst b/source/reference/minio-mc-admin/mc-admin-cluster-iam.rst new file mode 100644 index 00000000..f35a5fbd --- /dev/null +++ b/source/reference/minio-mc-admin/mc-admin-cluster-iam.rst @@ -0,0 +1,56 @@ +.. _minio-mc-admin-cluster-iam: + +======================== +``mc admin cluster iam`` +======================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. mc:: mc admin cluster iam + +Description +----------- + +.. versionadded:: RELEASE.2022-06-26T18-51-48Z + +.. start-mc-admin-cluster-iam-desc + +The :mc:`mc admin cluster iam` command and its subcommands provide tools for manually importing and exporting MinIO :ref:`identity and access management (IAM) ` metadata. + +.. end-mc-admin-cluster-iam-desc + +For automatic synchronization of all IAM configurations in a deployment to a remote site, use :ref:`site replication `. + +The :mc:`mc admin cluster iam` command has the following subcommands: + +.. list-table:: + :header-rows: 1 + :widths: 40 60 + + * - Subcommand + - Description + + * - :mc:`~mc admin cluster iam import` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-iam-import.rst + :start-after: start-mc-admin-cluster-iam-import-desc + :end-before: end-mc-admin-cluster-iam-import-desc + + * - :mc:`~mc admin cluster iam export` + - .. include:: /reference/minio-mc-admin/mc-admin-cluster-iam-export.rst + :start-after: start-mc-admin-cluster-iam-export-desc + :end-before: end-mc-admin-cluster-iam-export-desc + + + +.. toctree:: + :titlesonly: + :hidden: + + /reference/minio-mc-admin/mc-admin-cluster-iam-import + /reference/minio-mc-admin/mc-admin-cluster-iam-export + + diff --git a/source/reference/minio-mc-admin/mc-admin-group.rst b/source/reference/minio-mc-admin/mc-admin-group.rst index a4e3c17e..26d19758 100644 --- a/source/reference/minio-mc-admin/mc-admin-group.rst +++ b/source/reference/minio-mc-admin/mc-admin-group.rst @@ -92,15 +92,15 @@ Use :mc-cmd:`mc admin group add` to create a new group to an S3-compatible host: List Available Groups ~~~~~~~~~~~~~~~~~~~~~ -Use :mc-cmd:`mc admin group list` to list list all groups on an S3-compatible +Use :mc-cmd:`mc admin group ls` to list list all groups on an S3-compatible host: .. code-block:: shell :class: copyable - mc admin group list ALIAS + mc admin group ls ALIAS -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the S3-compatible host. @@ -124,18 +124,18 @@ S3-compatible host: Remove a Group ~~~~~~~~~~~~~~ -Use :mc-cmd:`mc admin group remove` to remove a group from an S3-compatible +Use :mc-cmd:`mc admin group rm` to remove a group from an S3-compatible host: .. code-block:: shell :class: copyable - mc admin group remove ALIAS GROUPNAME + mc admin group rm ALIAS GROUPNAME -- Replace :mc-cmd:`ALIAS ` with the +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the S3-compatible host. -- Replace :mc-cmd:`GROUPNAME ` with the +- Replace :mc-cmd:`GROUPNAME ` with the name of the group. Disable a Group @@ -183,10 +183,10 @@ Quick Reference :mc-cmd:`mc admin group info TARGET GROUPNAME ` Returns detailed information for a group on the MinIO deployment. -:mc-cmd:`mc admin group list TARGET ` +:mc-cmd:`mc admin group ls TARGET ` Returns a list of all groups on the MinIO deployment. -:mc-cmd:`mc admin group remove TARGET GROUPNAME ` +:mc-cmd:`mc admin group rm TARGET GROUPNAME ` Removes a group on the MinIO deployment. :mc-cmd:`mc admin group enable TARGET GROUPNAME ` @@ -221,7 +221,7 @@ Syntax .. mc-cmd:: GROUPNAME The name of the group. The command creates the group if it does not - already exist. Use :mc-cmd:`mc admin group list` to review the existing + already exist. Use :mc-cmd:`mc admin group ls` to review the existing groups on a deployment. .. mc-cmd:: MEMBERS @@ -229,7 +229,7 @@ Syntax The name of the user to add to the group. The user *must* exist on the :mc-cmd:`~mc admin group add TARGET` MinIO - deployment. Use :mc-cmd:`mc admin user list` to review the available + deployment. Use :mc-cmd:`mc admin user ls` to review the available users on the deployment. .. mc-cmd:: info @@ -256,7 +256,7 @@ Syntax The name of the group. -.. mc-cmd:: list +.. mc-cmd:: ls, list :fullpath: List all groups on the target MinIO deployment. The command has the @@ -265,7 +265,7 @@ Syntax .. code-block:: shell :class: copyable - mc admin group list TARGET + mc admin group ls TARGET The command accepts the following arguments: @@ -274,19 +274,19 @@ Syntax The :mc-cmd:`alias ` of a configured MinIO deployment from which to retrieve groups. -.. mc-cmd:: remove +.. mc-cmd:: rm, remove :fullpath: Removes a group on the target MinIO deployment. Removing a group does *not* remove any users with membership in the group. Use - :mc-cmd:`mc admin user remove` to remove users from a group. + :mc-cmd:`mc admin user rm` to remove users from a group. The command has the following syntax: .. code-block:: shell :class: copyable - mc admin group remove TARGET GROUPNAME + mc admin group rm TARGET GROUPNAME The command accepts the following arguments: diff --git a/source/reference/minio-mc-admin/mc-admin-idp-ldap.rst b/source/reference/minio-mc-admin/mc-admin-idp-ldap.rst index 3c8881a5..ca9267cd 100644 --- a/source/reference/minio-mc-admin/mc-admin-idp-ldap.rst +++ b/source/reference/minio-mc-admin/mc-admin-idp-ldap.rst @@ -43,7 +43,10 @@ The :mc-cmd:`mc admin idp ldap` command has the following subcommands: * - :mc-cmd:`mc admin idp ldap update` - Modify an existing AD/LDAP IDP server configuration. - * - :mc-cmd:`mc admin idp ldap remove` + * - :mc-cmd:`mc admin idp ldap ls` + - Lists AD/LDAP server configurations. + + * - :mc-cmd:`mc admin idp ldap rm` - Remove an AD/LDAP IDP server configuration from a deployment. * - :mc-cmd:`mc admin idp ldap info` @@ -141,7 +144,33 @@ Syntax - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to update for AD/LDAP integration. - Replace the ``[CFG_PARAM#]`` with each of the :ref:`configuration setting ` key-value pairs to update in the format of ``PARAMETER="value"``. -.. mc-cmd:: remove +.. mc-cmd:: ls, list + + Lists the existing set of configurations for an AD/LDAP provider. + + .. tab-set:: + + .. tab-item:: EXAMPLE + + The following example lists the AD/LDAP configuration settings for the ``myminio`` deployment. + + .. code-block:: shell + :class: copyable + + mc admin idp ldap ls myminio + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] admin idp ldap ls ALIAS + + - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to list the AD/LDAP integration. + +.. mc-cmd:: rm, remove Remove the existing configuration for an AD/LDAP provider. @@ -154,7 +183,7 @@ Syntax .. code-block:: shell :class: copyable - mc admin idp ldap remove myminio + mc admin idp ldap rm myminio .. tab-item:: SYNTAX @@ -163,7 +192,7 @@ Syntax .. code-block:: shell :class: copyable - mc [GLOBALFLAGS] admin idp ldap remove \ + mc [GLOBALFLAGS] admin idp ldap rm \ ALIAS - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to remove the AD/LDAP integration. diff --git a/source/reference/minio-mc-admin/mc-admin-idp-openid.rst b/source/reference/minio-mc-admin/mc-admin-idp-openid.rst index 03dd3065..09d26fb9 100644 --- a/source/reference/minio-mc-admin/mc-admin-idp-openid.rst +++ b/source/reference/minio-mc-admin/mc-admin-idp-openid.rst @@ -146,7 +146,7 @@ Syntax If not specified, the command updates the default configuration. - Replace the ``[CFG_PARAM#]`` with each of the :ref:`configuration setting ` key-value pairs to update in the format of ``PARAMETER="value"``. -.. mc-cmd:: remove +.. mc-cmd:: rm, remove Remove an existing set of configurations for an OpenID provider. @@ -159,7 +159,7 @@ Syntax .. code-block:: shell :class: copyable - mc admin idp openid remove myminio test_config + mc admin idp openid rm myminio test_config .. tab-item:: SYNTAX @@ -168,7 +168,7 @@ Syntax .. code-block:: shell :class: copyable - mc [GLOBALFLAGS] admin idp openid remove \ + mc [GLOBALFLAGS] admin idp openid rm \ ALIAS \ [CFG_NAME] @@ -176,7 +176,7 @@ Syntax - Replace ``CFG_NAME`` with a unique string for this configuration. If not specified, the command removes the default configurations. -.. mc-cmd:: list +.. mc-cmd:: ls, list Outputs a list of existing configuration sets for OpenID providers. @@ -189,7 +189,7 @@ Syntax .. code-block:: shell :class: copyable - mc admin idp openid list myminio + mc admin idp openid ls myminio .. tab-item:: SYNTAX @@ -198,7 +198,7 @@ Syntax .. code-block:: shell :class: copyable - mc [GLOBALFLAGS] admin idp openid list ALIAS + mc [GLOBALFLAGS] admin idp openid ls ALIAS - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment to list OpenID integrations for. diff --git a/source/reference/minio-mc-admin/mc-admin-policy-list.rst b/source/reference/minio-mc-admin/mc-admin-policy-list.rst index 3e81b3cb..9d0f842d 100644 --- a/source/reference/minio-mc-admin/mc-admin-policy-list.rst +++ b/source/reference/minio-mc-admin/mc-admin-policy-list.rst @@ -1,6 +1,6 @@ -======================== -``mc admin policy list`` -======================== +====================== +``mc admin policy ls`` +====================== .. default-domain:: minio @@ -8,6 +8,7 @@ :local: :depth: 2 +.. mc:: mc admin policy ls .. mc:: mc admin policy list Syntax @@ -19,6 +20,7 @@ Lists all policies on the target MinIO deployment. .. end-mc-admin-policy-list-desc +The :mc:`mc admin policy list` command has equivalent functionality to :mc:`mc admin policy ls`. .. tab-set:: @@ -29,7 +31,7 @@ Lists all policies on the target MinIO deployment. .. code-block:: shell :class: copyable - mc admin policy list play + mc admin policy ls play .. tab-item:: SYNTAX @@ -38,7 +40,7 @@ Lists all policies on the target MinIO deployment. .. code-block:: shell :class: copyable - mc admin policy list TARGET + mc admin policy ls TARGET .. include:: /includes/common-minio-mc.rst :start-after: start-minio-syntax @@ -48,7 +50,7 @@ Lists all policies on the target MinIO deployment. Parameters ~~~~~~~~~~ -The :mc-cmd:`mc admin policy list` command accepts the following arguments: +The :mc-cmd:`mc admin policy ls` command accepts the following arguments: .. mc-cmd:: TARGET @@ -69,7 +71,7 @@ List the policies that exist on the deployment at alias ``myminio``. .. code-block:: shell :class: copyable - mc admin policy list myminio + mc admin policy ls myminio Output ~~~~~~ diff --git a/source/reference/minio-mc-admin/mc-admin-policy-remove.rst b/source/reference/minio-mc-admin/mc-admin-policy-remove.rst index 38a1a904..12285ab3 100644 --- a/source/reference/minio-mc-admin/mc-admin-policy-remove.rst +++ b/source/reference/minio-mc-admin/mc-admin-policy-remove.rst @@ -1,6 +1,6 @@ -========================== -``mc admin policy remove`` -========================== +====================== +``mc admin policy rm`` +====================== .. default-domain:: minio @@ -9,6 +9,7 @@ :depth: 2 .. mc:: mc admin policy remove +.. mc:: mc admin policy rm Syntax ------ @@ -19,6 +20,7 @@ Removes an IAM policy from the target MinIO deployment. .. end-mc-admin-policy-remove-desc +The :mc:`mc admin policy remove` command has equivalent functionality to :mc:`mc admin policy rm`. .. tab-set:: @@ -29,7 +31,7 @@ Removes an IAM policy from the target MinIO deployment. .. code-block:: shell :class: copyable - mc admin policy remove myminio writeonly + mc admin policy rm myminio writeonly .. tab-item:: SYNTAX @@ -38,7 +40,7 @@ Removes an IAM policy from the target MinIO deployment. .. code-block:: shell :class: copyable - mc admin policy remove TARGET POLICYNAME + mc admin policy rm TARGET POLICYNAME .. include:: /includes/common-minio-mc.rst :start-after: start-minio-syntax @@ -48,7 +50,7 @@ Removes an IAM policy from the target MinIO deployment. Parameters ~~~~~~~~~~ -The :mc-cmd:`mc admin policy create` command accepts the following arguments: +The :mc-cmd:`mc admin policy rm` command accepts the following arguments: .. mc-cmd:: TARGET @@ -73,4 +75,4 @@ Remove a policy called ``listbuckets``. .. code-block:: shell :class: copyable - mc admin policy remove myminio listbuckets \ No newline at end of file + mc admin policy rm myminio listbuckets \ No newline at end of file diff --git a/source/reference/minio-mc-admin/mc-admin-policy.rst b/source/reference/minio-mc-admin/mc-admin-policy.rst index a32941c8..5d57ddd9 100644 --- a/source/reference/minio-mc-admin/mc-admin-policy.rst +++ b/source/reference/minio-mc-admin/mc-admin-policy.rst @@ -73,12 +73,12 @@ Subcommands :start-after: start-mc-admin-policy-info-desc :end-before: end-mc-admin-policy-info-desc - * - :mc:`~mc admin policy list` + * - :mc:`~mc admin policy ls` - .. include:: /reference/minio-mc-admin/mc-admin-policy-list.rst :start-after: start-mc-admin-policy-list-desc :end-before: end-mc-admin-policy-list-desc - * - :mc:`~mc admin policy remove` + * - :mc:`~mc admin policy rm` - .. include:: /reference/minio-mc-admin/mc-admin-policy-remove.rst :start-after: start-mc-admin-policy-remove-desc :end-before: end-mc-admin-policy-remove-desc diff --git a/source/reference/minio-mc-admin/mc-admin-replicate.rst b/source/reference/minio-mc-admin/mc-admin-replicate.rst index fd6af274..5a1eaeb1 100644 --- a/source/reference/minio-mc-admin/mc-admin-replicate.rst +++ b/source/reference/minio-mc-admin/mc-admin-replicate.rst @@ -186,7 +186,7 @@ Syntax Available values are ``enable`` and ``disable``. If not defined, MInIO uses asynchronous site replication. -.. mc-cmd:: rm +.. mc-cmd:: rm, remove :fullpath: .. versionchanged:: RELEASE.2023-01-11T03-14-16Z diff --git a/source/reference/minio-mc-admin/mc-admin-user-list.rst b/source/reference/minio-mc-admin/mc-admin-user-list.rst index 1f89ed68..78dd92c0 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-list.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-list.rst @@ -1,8 +1,8 @@ .. _minio-mc-admin-user-list: -====================== -``mc admin user list`` -====================== +==================== +``mc admin user ls`` +==================== .. default-domain:: minio @@ -11,6 +11,7 @@ :depth: 2 .. mc:: mc admin user list +.. mc:: mc admin user ls Syntax @@ -18,11 +19,13 @@ Syntax .. start-mc-admin-user-list-desc -The :mc:`mc admin user list` command lists all :ref:`MinIO users ` on the target MinIO deployment. +The :mc:`mc admin user ls` command lists all :ref:`MinIO users ` on the target MinIO deployment. .. end-mc-admin-user-list-desc -:mc-cmd:`mc admin user list` does *not* return the access key or secret key associated to a user. +The :mc:`mc admin user list` command has equivalent functionality to :mc:`mc admin user ls`. + +:mc-cmd:`mc admin user ls` does *not* return the access key or secret key associated to a user. Use :mc-cmd:`mc admin user info` to retrieve detailed user information, including the user access key. To manage external Identity Provider users, see :mc:`OIDC ` or :mc:`AD/LDAP `. @@ -36,7 +39,7 @@ To manage external Identity Provider users, see :mc:`OIDC ` .. code-block:: shell :class: copyable - mc admin user list myminio + mc admin user ls myminio .. tab-item:: SYNTAX @@ -76,14 +79,14 @@ Example List Available Users ~~~~~~~~~~~~~~~~~~~~ -Use :mc-cmd:`mc admin user list` to list all users on a MinIO deployment: +Use :mc-cmd:`mc admin user ls` to list all users on a MinIO deployment: .. code-block:: shell :class: copyable - mc admin user list ALIAS + mc admin user ls ALIAS -- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the MinIO deployment. +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the MinIO deployment. The output resembles the following: diff --git a/source/reference/minio-mc-admin/mc-admin-user-remove.rst b/source/reference/minio-mc-admin/mc-admin-user-remove.rst index 83aa4c2c..a9584079 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-remove.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-remove.rst @@ -1,8 +1,8 @@ .. _minio-mc-admin-user-remove: -======================== -``mc admin user remove`` -======================== +===================== +``mc admin user rm`` +===================== .. default-domain:: minio @@ -11,16 +11,19 @@ :depth: 2 .. mc:: mc admin user remove +.. mc:: mc admin user rm Syntax ------ .. start-mc-admin-user-remove-desc -The :mc:`mc admin user remove` command removes a :ref:`MinIO user ` on the target MinIO deployment. +The :mc:`mc admin user rm` command removes a :ref:`MinIO user ` on the target MinIO deployment. .. end-mc-admin-user-remove-desc +The :mc:`mc admin user remove` command has equivalent functionality to :mc:`mc admin user rm`. + To manage external Identity Provider users, see :mc:`OIDC ` or :mc:`AD/LDAP `. .. tab-set:: @@ -32,7 +35,7 @@ To manage external Identity Provider users, see :mc:`OIDC ` .. code-block:: shell :class: copyable - mc admin user remove myminio myuser + mc admin user rm myminio myuser .. tab-item:: SYNTAX @@ -78,16 +81,16 @@ Example Remove a User ~~~~~~~~~~~~~ -Use :mc-cmd:`mc admin user remove` to remove a user from a MinIO deployment: +Use :mc-cmd:`mc admin user rm` to remove a user from a MinIO deployment: .. code-block:: shell :class: copyable - mc admin user remove ALIAS USERNAME + mc admin user rm ALIAS USERNAME -- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the MinIO deployment. +- Replace :mc-cmd:`ALIAS ` with the :mc-cmd:`alias ` of the MinIO deployment. -- Replace :mc-cmd:`USERNAME ` with the username of the user to remove. +- Replace :mc-cmd:`USERNAME ` with the username of the user to remove. Behavior -------- diff --git a/source/reference/minio-mc-admin/mc-admin-user-svcacct-list.rst b/source/reference/minio-mc-admin/mc-admin-user-svcacct-list.rst index adc2aadf..e22ea1bd 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-svcacct-list.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-svcacct-list.rst @@ -1,8 +1,8 @@ .. _minio-mc-admin-svcacct-list: -============================== -``mc admin user svcacct list`` -============================== +============================ +``mc admin user svcacct ls`` +============================ .. default-domain:: minio @@ -11,6 +11,7 @@ :depth: 2 .. mc:: mc admin user svcacct list +.. mc:: mc admin user svcacct ls Syntax @@ -18,10 +19,12 @@ Syntax .. start-mc-admin-svcacct-list-desc -The :mc-cmd:`mc admin user svcacct list` command lists all access keys associated to the specified user. +The :mc:`mc admin user svcacct ls` command lists all access keys associated to the specified user. .. end-mc-admin-svcacct-list-desc +The alias :mc:`mc admin user svcacct list` has equivalent functionality to :mc:`mc admin user svcacct ls`. + .. tab-set:: .. tab-item:: EXAMPLE @@ -31,7 +34,7 @@ The :mc-cmd:`mc admin user svcacct list` command lists all access keys associate .. code-block:: shell :class: copyable - mc admin user svcacct list myminio admin1 + mc admin user svcacct ls myminio admin1 .. tab-item:: SYNTAX @@ -40,7 +43,7 @@ The :mc-cmd:`mc admin user svcacct list` command lists all access keys associate .. code-block:: shell :class: copyable - mc [GLOBALFLAGS] admin user svcacct list \ + mc [GLOBALFLAGS] admin user svcacct ls \ ALIAS \ USER diff --git a/source/reference/minio-mc-admin/mc-admin-user-svcacct-remove.rst b/source/reference/minio-mc-admin/mc-admin-user-svcacct-remove.rst index e90743d7..b8502904 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-svcacct-remove.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-svcacct-remove.rst @@ -1,8 +1,8 @@ .. _minio-mc-admin-svcacct-remove: -================================ -``mc admin user svcacct remove`` -================================ +============================ +``mc admin user svcacct rm`` +============================ .. default-domain:: minio @@ -11,6 +11,7 @@ :depth: 2 .. mc:: mc admin user svcacct remove +.. mc:: mc admin user svcacct rm Syntax @@ -18,9 +19,11 @@ Syntax .. start-mc-admin-svcacct-remove-desc -The :mc-cmd:`mc admin user svcacct remove` command removes an access key associated to a user on the deployment. +The :mc:`mc admin user svcacct rm` command removes an access key associated to a user on the deployment. .. end-mc-admin-svcacct-remove-desc + +The :mc:`mc admin user svcacct remove` command has equivalent functionality to :mc:`mc admin user svcacct rm`. Applications can no longer authenticate using that access key after removal. @@ -33,7 +36,7 @@ Applications can no longer authenticate using that access key after removal. .. code-block:: shell :class: copyable - mc admin user svcacct remove myminio myuserserviceaccount + mc admin user svcacct rm myminio myuserserviceaccount .. tab-item:: SYNTAX diff --git a/source/reference/minio-mc-admin/mc-admin-user-svcacct.rst b/source/reference/minio-mc-admin/mc-admin-user-svcacct.rst index d0c244cb..c7442c07 100644 --- a/source/reference/minio-mc-admin/mc-admin-user-svcacct.rst +++ b/source/reference/minio-mc-admin/mc-admin-user-svcacct.rst @@ -67,7 +67,7 @@ The :mc:`mc admin user svcacct` command has the following subcommands: :start-after: start-mc-admin-svcacct-list-desc :end-before: end-mc-admin-svcacct-list-desc - * - :mc:`~mc admin user svcacct remove` + * - :mc:`~mc admin user svcacct rm` - .. include:: /reference/minio-mc-admin/mc-admin-user-svcacct-remove.rst :start-after: start-mc-admin-svcacct-remove-desc :end-before: end-mc-admin-svcacct-remove-desc diff --git a/source/reference/minio-mc-admin/mc-admin-user.rst b/source/reference/minio-mc-admin/mc-admin-user.rst index f93b0714..875a5658 100644 --- a/source/reference/minio-mc-admin/mc-admin-user.rst +++ b/source/reference/minio-mc-admin/mc-admin-user.rst @@ -69,12 +69,12 @@ Subcommands :start-after: start-mc-admin-user-info-desc :end-before: end-mc-admin-user-info-desc - * - :mc:`~mc admin user list` + * - :mc:`~mc admin user ls` - .. include:: /reference/minio-mc-admin/mc-admin-user-list.rst :start-after: start-mc-admin-user-list-desc :end-before: end-mc-admin-user-list-desc - * - :mc:`~mc admin user remove` + * - :mc:`~mc admin user rm` - .. include:: /reference/minio-mc-admin/mc-admin-user-remove.rst :start-after: start-mc-admin-user-remove-desc :end-before: end-mc-admin-user-remove-desc diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 8a369c9d..2082762f 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -217,8 +217,8 @@ The following table lists :mc-cmd:`mc` commands: :end-before: end-mc-encrypt-desc * - | :mc:`mc event add` - | :mc:`mc event list` - | :mc:`mc event remove` + | :mc:`mc event ls` + | :mc:`mc event rm` - .. include:: /reference/minio-mc/mc-event.rst :start-after: start-mc-event-desc :end-before: end-mc-event-desc @@ -337,7 +337,7 @@ The following table lists :mc-cmd:`mc` commands: :end-before: end-mc-rm-desc * - | :mc:`mc share download` - | :mc:`mc share list` + | :mc:`mc share ls` | :mc:`mc share upload` - .. include:: /reference/minio-mc/mc-share.rst :start-after: start-mc-share-desc diff --git a/source/reference/minio-mc/mc-event-list.rst b/source/reference/minio-mc/mc-event-list.rst index e8556568..e8cbcde3 100644 --- a/source/reference/minio-mc/mc-event-list.rst +++ b/source/reference/minio-mc/mc-event-list.rst @@ -1,8 +1,8 @@ .. _minio-mc-event-list: -================= -``mc event list`` -================= +=============== +``mc event ls`` +=============== .. default-domain:: minio @@ -11,17 +11,20 @@ :depth: 2 .. mc:: mc event list +.. mc:: mc event ls Syntax ------ .. start-mc-event-list-desc -The :mc:`mc event list` command lists all event notification triggers for a +The :mc:`mc event ls` command lists all event notification triggers for a bucket. .. end-mc-event-list-desc +The alias :mc:`mc event list` has equivalent functionality to :mc:`mc event ls`. + .. tab-set:: .. tab-item:: EXAMPLE @@ -33,7 +36,7 @@ bucket. .. code-block:: shell :class: copyable - mc event list myminio myminio/mydata arn:aws:sqs::primary:target + mc event ls myminio myminio/mydata arn:aws:sqs::primary:target .. tab-item:: SYNTAX @@ -100,14 +103,14 @@ List Event Notifications on a Bucket .. code-block:: shell :class: copyable - mc event list myminio/mydata + mc event ls myminio/mydata .. tab-item:: Syntax .. code-block:: shell :class: copyable - mc event list ALIAS ARN + mc event ls ALIAS ARN - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO deployment on which to add the bucket notification event. For example: diff --git a/source/reference/minio-mc/mc-event-remove.rst b/source/reference/minio-mc/mc-event-remove.rst index 1f903255..59827a5e 100644 --- a/source/reference/minio-mc/mc-event-remove.rst +++ b/source/reference/minio-mc/mc-event-remove.rst @@ -1,8 +1,8 @@ .. _minio-mc-event-remove: -=================== -``mc event remove`` -=================== +=============== +``mc event rm`` +=============== .. default-domain:: minio @@ -11,17 +11,20 @@ :depth: 2 .. mc:: mc event remove +.. mc:: mc event rm Syntax ------ .. start-mc-event-remove-desc -The :mc:`mc event remove` command removes event notification triggers on a +The :mc:`mc event rm` command removes event notification triggers on a bucket. .. end-mc-event-remove-desc +The :mc:`mc event remove` command has equivalent functionality to :mc:`mc event rm`. + .. tab-set:: .. tab-item:: EXAMPLE @@ -33,7 +36,7 @@ bucket. .. code-block:: shell :class: copyable - mc event remove myminio/mydata arn:aws:sqs::primary:target + mc event rm myminio/mydata arn:aws:sqs::primary:target .. tab-item:: SYNTAX @@ -87,14 +90,14 @@ Parameters *Optional* The event(s) to remove. Specify multiple events using a comma ``,`` delimiter. See :ref:`mc-event-supported-events` for supported events. - Defaults to removing all events on the :mc-cmd:`~mc event remove ALIAS` - bucket with the :mc-cmd:`~mc event remove ARN` notification target. + Defaults to removing all events on the :mc-cmd:`~mc event rm ALIAS` + bucket with the :mc-cmd:`~mc event rm ARN` notification target. .. mc-cmd:: --force - *Optional* Removes all events on the :mc-cmd:`~mc event remove ALIAS` bucket - with the :mc-cmd:`~mc event remove ARN` notification target. + *Optional* Removes all events on the :mc-cmd:`~mc event rm ALIAS` bucket + with the :mc-cmd:`~mc event rm ARN` notification target. .. mc-cmd:: --prefix @@ -102,8 +105,8 @@ Parameters *Optional* The bucket prefix in which the command removes bucket notifications. - For example, given a :mc-cmd:`~mc event remove ALIAS` of - ``play/mybucket`` and a :mc-cmd:`~mc event remove --prefix` of + For example, given a :mc-cmd:`~mc event rm ALIAS` of + ``play/mybucket`` and a :mc-cmd:`~mc event rm --prefix` of ``photos``, the command only removes bucket notifications in ``play/mybucket/photos``. @@ -113,8 +116,8 @@ Parameters *Optional* The bucket suffix in which the command removes bucket notifications. - For example, given a :mc-cmd:`~mc event remove ALIAS` of - ``play/mybucket`` and a :mc-cmd:`~mc event remove --suffix` of + For example, given a :mc-cmd:`~mc event rm ALIAS` of + ``play/mybucket`` and a :mc-cmd:`~mc event rm --suffix` of ``.jpg``, the command only removes bucket notifications in ``play/mybucket/*.jpg``. @@ -142,14 +145,14 @@ Remove Event Notifications from a Bucket .. code-block:: shell :class: copyable - mc event remove myminio/mydata arn:minio:sqs::primary:webhook + mc event rm myminio/mydata arn:minio:sqs::primary:webhook .. tab-item:: Syntax .. code-block:: shell :class: copyable - mc event remove ALIAS ARN + mc event rm ALIAS ARN - Replace ``ALIAS`` with the :ref:`alias ` of the MinIO deployment on which to add the bucket notification event. For example: diff --git a/source/reference/minio-mc/mc-event.rst b/source/reference/minio-mc/mc-event.rst index 48bb0238..be3e1e6a 100644 --- a/source/reference/minio-mc/mc-event.rst +++ b/source/reference/minio-mc/mc-event.rst @@ -43,12 +43,12 @@ Subcommands :start-after: start-mc-event-add-desc :end-before: end-mc-event-add-desc - * - :mc:`~mc event list` + * - :mc:`~mc event ls` - .. include:: /reference/minio-mc/mc-event-list.rst :start-after: start-mc-event-list-desc :end-before: end-mc-event-list-desc - * - :mc:`~mc event remove` + * - :mc:`~mc event rm` - .. include:: /reference/minio-mc/mc-event-remove.rst :start-after: start-mc-event-remove-desc :end-before: end-mc-event-remove-desc diff --git a/source/reference/minio-mc/mc-ilm-rule-ls.rst b/source/reference/minio-mc/mc-ilm-rule-ls.rst index c32d533f..7ddbf279 100644 --- a/source/reference/minio-mc/mc-ilm-rule-ls.rst +++ b/source/reference/minio-mc/mc-ilm-rule-ls.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc ilm rule list .. mc:: mc ilm rule ls .. versionchanged:: RELEASE.2022-12-24T15-21-38Z @@ -25,6 +26,8 @@ The :mc:`mc ilm rule ls` command summarizes all configured object lifecycle mana .. end-mc-ilm-rule-ls-desc +The :mc:`mc ilm rule list` command has equivalent functionality to :mc:`mc ilm rule ls`. + .. tab-set:: .. tab-item:: EXAMPLE diff --git a/source/reference/minio-mc/mc-ilm-tier-ls.rst b/source/reference/minio-mc/mc-ilm-tier-ls.rst index 4af68554..cd3adde7 100644 --- a/source/reference/minio-mc/mc-ilm-tier-ls.rst +++ b/source/reference/minio-mc/mc-ilm-tier-ls.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc ilm tier list .. mc:: mc ilm tier ls .. versionchanged:: RELEASE.2022-12-24T15-21-38Z @@ -25,6 +26,8 @@ The :mc:`mc ilm tier ls` command shows the remote tiers configured on a deployme .. end-mc-ilm-tier-ls-desc +The :mc:`mc ilm tier list` command has equivalent functionality to :mc:`mc ilm tier ls`. + Syntax ------ diff --git a/source/reference/minio-mc/mc-ilm-tier-rm.rst b/source/reference/minio-mc/mc-ilm-tier-rm.rst index d8cdfad3..ccc2c4bc 100644 --- a/source/reference/minio-mc/mc-ilm-tier-rm.rst +++ b/source/reference/minio-mc/mc-ilm-tier-rm.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc ilm tier remove .. mc:: mc ilm tier rm Description @@ -21,6 +22,8 @@ The :mc:`mc ilm tier rm` command removes an remote tier that has not been used t .. end-mc-ilm-tier-rm-desc +The :mc:`mc ilm tier remove` command has equivalent functionality to :mc:`mc ilm tier rm` + .. note:: Once a tier has transitioned objects, it cannot be removed. diff --git a/source/reference/minio-mc/mc-mirror.rst b/source/reference/minio-mc/mc-mirror.rst index 79acdd73..414aaefe 100644 --- a/source/reference/minio-mc/mc-mirror.rst +++ b/source/reference/minio-mc/mc-mirror.rst @@ -153,7 +153,7 @@ Parameters :start-after: start-mc-limit-flags-desc :end-before: end-mc-limit-flags-desc -.. mc-cmd:: md5 +.. mc-cmd:: --md5 Forces all uploads to calculate MD5 checksums. @@ -223,6 +223,12 @@ Parameters ``mc mirror --remove`` does not verify that the contents of object C are the same on both Source and Target, only that an object called `C` exists on both. To ensure objects on the Source and Target match both names `and` content, use :mc-cmd:`~mc mirror --overwrite` or :mc-cmd:`~mc mirror --watch`. + .. versionchanged:: RELEASE.2023-05-04T18-10-16Z + + ``mc mirror --remove`` returns an error if the target path is a local filesystem directory that does not exist. + + In prior versions, specifying ``/path/to/directory`` would result in the removal of the ``/path/to`` folder if ``directory`` did not exist. + .. mc-cmd:: storage-class, sc diff --git a/source/reference/minio-mc/mc-replicate-ls.rst b/source/reference/minio-mc/mc-replicate-ls.rst index 3323ca7e..b5ed7396 100644 --- a/source/reference/minio-mc/mc-replicate-ls.rst +++ b/source/reference/minio-mc/mc-replicate-ls.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc replicate list .. mc:: mc replicate ls .. versionchanged:: RELEASE.2022-12-24T15-21-38Z @@ -27,6 +28,8 @@ MinIO bucket. .. end-mc-replicate-ls-desc +The :mc:`mc replicate list` command has equivalent functionality to :mc:`mc replicate ls`. + .. tab-set:: .. tab-item:: EXAMPLE diff --git a/source/reference/minio-mc/mc-replicate-rm.rst b/source/reference/minio-mc/mc-replicate-rm.rst index 13c39d2f..6073b932 100644 --- a/source/reference/minio-mc/mc-replicate-rm.rst +++ b/source/reference/minio-mc/mc-replicate-rm.rst @@ -10,6 +10,7 @@ :local: :depth: 2 +.. mc:: mc replicate remove .. mc:: mc replicate rm .. versionchanged:: RELEASE.2022-12-24T15-21-38Z @@ -28,6 +29,8 @@ MinIO bucket. .. end-mc-replicate-rm-desc +The :mc:`mc replicate remove` command has equivalent functionality to :mc:`mc replicate rm`. + .. code-block:: shell mc [GLOBALFLAGS] replicate rm FLAGS [FLAGS] ALIAS diff --git a/source/reference/minio-mc/mc-share-list.rst b/source/reference/minio-mc/mc-share-list.rst index 33b6a222..9bda7a1e 100644 --- a/source/reference/minio-mc/mc-share-list.rst +++ b/source/reference/minio-mc/mc-share-list.rst @@ -1,5 +1,5 @@ =================== -``mc share list`` +``mc share ls`` =================== .. default-domain:: minio @@ -9,17 +9,20 @@ :depth: 2 .. mc:: mc share list +.. mc:: mc share ls Syntax ----------- .. start-mc-share-list-desc -The :mc:`mc share list` command displays any unexpired presigned URLs generated +The :mc:`mc share ls` command displays any unexpired presigned URLs generated by :mc:`mc share upload` or :mc:`mc share download` .. end-mc-share-list-desc +The :mc:`mc share list` command has equivalent functionality to :mc:`mc share ls`. + Applications can perform a ``PUT`` to retrieve the object from the URL. For more information on shareable object URLs, see the Amazon S3 @@ -37,8 +40,8 @@ documentation on :aws-docs:`Pre-Signed URLs .. code-block:: shell :class: copyable - mc share list upload myminio/mydata - mc share list download myminio/mydata + mc share ls upload myminio/mydata + mc share ls download myminio/mydata .. tab-item:: SYNTAX @@ -62,13 +65,13 @@ Parameters *Required* Lists all unexpired presigned download (``GET``) URLs. - Mutually exclusive with :mc:`mc share list upload` + Mutually exclusive with :mc:`mc share ls upload` .. mc-cmd:: upload *Required* Lists all unexpired presigned upload (``PUT``) URLs. - Mutually exclusive with :mc:`mc share list download` + Mutually exclusive with :mc:`mc share ls download` .. mc-cmd:: ALIAS @@ -94,28 +97,28 @@ List Generated Download and Upload URLs .. tab-item:: List Active Download Presigned URLs - Use :mc:`mc share list download` to generate a URL + Use :mc:`mc share ls download` to generate a URL that supports ``POST`` requests for uploading a file to a specific object location on an S3-compatible host: .. code-block:: shell :class: copyable - mc share list download ALIAS + mc share ls download ALIAS - - Replace :mc-cmd:`ALIAS ` with the + - Replace :mc-cmd:`ALIAS ` with the :ref:`alias ` of the MinIO deployment. .. tab-item:: List Active Upload Presigned URLs - Use :mc:`mc share list upload` to generate a URL that + Use :mc:`mc share ls upload` to generate a URL that supports ``POST`` requests for uploading a file to a specific object location on an S3-compatible host: .. code-block:: shell :class: copyable - mc share list upload ALIAS + mc share ls upload ALIAS - Replace :mc-cmd:`ALIAS ` with the :ref:`alias ` of the MinIO deployment. diff --git a/source/reference/minio-mc/mc-tag-list.rst b/source/reference/minio-mc/mc-tag-list.rst index 1cade5bd..e181f563 100644 --- a/source/reference/minio-mc/mc-tag-list.rst +++ b/source/reference/minio-mc/mc-tag-list.rst @@ -72,6 +72,13 @@ Parameters mc tag list myminio/mybucket/object.txt +.. mc-cmd:: --recursive, r + :optional: + + .. versionadded:: RELEASE.2023-05-04T18-10-16Z + + Recursively lists the tags for all objects at the path specified to :mc:`ALIAS `. + .. mc-cmd:: --rewind :optional: diff --git a/source/reference/minio-mc/mc-tag-remove.rst b/source/reference/minio-mc/mc-tag-remove.rst index 4a2dedba..5b564292 100644 --- a/source/reference/minio-mc/mc-tag-remove.rst +++ b/source/reference/minio-mc/mc-tag-remove.rst @@ -30,7 +30,7 @@ The :mc:`mc tag remove` command removes all tags from a bucket or object. .. tab-set:: .. tab-item:: EXAMPLE - + The following command removes tags for the ``mydata`` bucket on the ``myminio`` MinIO deployment: @@ -71,6 +71,13 @@ Parameters mc tag remove myminio/mybucket/object.txt +.. mc-cmd:: --recursive, r + :optional: + + .. versionadded:: RELEASE.2023-05-04T18-10-16Z + + Recursively removes all tags from all objects at the specified :mc:`ALIAS `. + .. mc-cmd:: --rewind :optional: diff --git a/source/reference/minio-mc/mc-tag-set.rst b/source/reference/minio-mc/mc-tag-set.rst index f427effe..995fa8b9 100644 --- a/source/reference/minio-mc/mc-tag-set.rst +++ b/source/reference/minio-mc/mc-tag-set.rst @@ -86,6 +86,13 @@ Parameters mc tag set myminio/mybucket/object.txt "key1=value1&key2=value2" +.. mc-cmd:: --recursive, r + :optional: + + .. versionadded:: RELEASE.2023-05-04T18-10-16Z + + Recursively applies the tag to all objects at the path specified to :mc:`ALIAS `. + .. mc-cmd:: --rewind :optional: