mirror of
https://github.com/minio/docs.git
synced 2025-08-06 14:42:56 +03:00
Cleaning up mc admin commands
This commit is contained in:
@@ -232,6 +232,10 @@ body div.center dl dd {
|
|||||||
margin-left: 15px;
|
margin-left: 15px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
body div.center table.docutils td {
|
||||||
|
padding: 20px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
body div.center div.footer {
|
body div.center div.footer {
|
||||||
text-align: center;
|
text-align: center;
|
||||||
width: auto;
|
width: auto;
|
||||||
|
@@ -29,17 +29,86 @@ The following table lists :mc-cmd:`mc admin` commands:
|
|||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
:widths: 25 75
|
:widths: 40 60
|
||||||
:width: 100%
|
:width: 100%
|
||||||
|
|
||||||
* - Command
|
* - Command
|
||||||
- Description
|
- Description
|
||||||
|
|
||||||
|
* - :mc:`mc admin bucket remote`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-bucket-remote.rst
|
||||||
|
:start-after: start-mc-admin-bucket-remote-desc
|
||||||
|
:end-before: end-mc-admin-bucket-remote-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin bucket quota`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-bucket-quota.rst
|
||||||
|
:start-after: start-mc-admin-bucket-quota-desc
|
||||||
|
:end-before: end-mc-admin-bucket-quota-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin group`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-group.rst
|
||||||
|
:start-after: start-mc-admin-group-desc
|
||||||
|
:end-before: end-mc-admin-group-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin heal`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-heal.rst
|
||||||
|
:start-after: start-mc-admin-heal-desc
|
||||||
|
:end-before: end-mc-admin-heal-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin info`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-info.rst
|
||||||
|
:start-after: start-mc-admin-info-desc
|
||||||
|
:end-before: end-mc-admin-info-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin kms key`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-kms-key.rst
|
||||||
|
:start-after: start-mc-admin-kms-key-desc
|
||||||
|
:end-before: end-mc-admin-kms-key-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin obd`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-obd.rst
|
||||||
|
:start-after: start-mc-admin-obd-desc
|
||||||
|
:end-before: end-mc-admin-obd-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin policy`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-policy.rst
|
||||||
|
:start-after: start-mc-admin-policy-desc
|
||||||
|
:end-before: end-mc-admin-policy-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin profile`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-profile.rst
|
||||||
|
:start-after: start-mc-admin-profile-desc
|
||||||
|
:end-before: end-mc-admin-profile-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin prometheus`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-prometheus.rst
|
||||||
|
:start-after: start-mc-admin-prometheus-desc
|
||||||
|
:end-before: end-mc-admin-prometheus-desc
|
||||||
|
|
||||||
* - :mc:`mc admin service`
|
* - :mc:`mc admin service`
|
||||||
- .. include:: /minio-cli/minio-mc-admin/mc-admin-service.rst
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-service.rst
|
||||||
:start-after: start-mc-admin-service-desc
|
:start-after: start-mc-admin-service-desc
|
||||||
:end-before: end-mc-admin-service-desc
|
:end-before: end-mc-admin-service-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin top`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-top.rst
|
||||||
|
:start-after: start-mc-admin-top-desc
|
||||||
|
:end-before: end-mc-admin-top-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin trace`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-trace.rst
|
||||||
|
:start-after: start-mc-admin-trace-desc
|
||||||
|
:end-before: end-mc-admin-trace-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin update`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-update.rst
|
||||||
|
:start-after: start-mc-admin-update-desc
|
||||||
|
:end-before: end-mc-admin-update-desc
|
||||||
|
|
||||||
|
* - :mc:`mc admin user`
|
||||||
|
- .. include:: /minio-cli/minio-mc-admin/mc-admin-user.rst
|
||||||
|
:start-after: start-mc-admin-user-desc
|
||||||
|
:end-before: end-mc-admin-user-desc
|
||||||
|
|
||||||
.. _mc-admin-install:
|
.. _mc-admin-install:
|
||||||
|
|
||||||
@@ -76,7 +145,7 @@ Replace each argument with the required values. Specifying only the
|
|||||||
``mc config host add`` command starts an input prompt for entering the
|
``mc config host add`` command starts an input prompt for entering the
|
||||||
required values.
|
required values.
|
||||||
|
|
||||||
Use the :ref:`mc admin info <mc-admin-info>` command to test the connection to
|
Use the :mc-cmd:`mc admin info` command to test the connection to
|
||||||
the newly added MinIO deployment:
|
the newly added MinIO deployment:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
@@ -90,153 +159,6 @@ Global Options
|
|||||||
:mc-cmd:`mc admin` supports the same global options as
|
:mc-cmd:`mc admin` supports the same global options as
|
||||||
:mc-cmd:`mc`. See :ref:`minio-mc-global-options`.
|
:mc-cmd:`mc`. See :ref:`minio-mc-global-options`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. _mc-admin-info:
|
|
||||||
|
|
||||||
``mc admin info``
|
|
||||||
~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
The ``mc admin info`` command returns diagnostic information of a MinIO server.
|
|
||||||
|
|
||||||
The command has the following syntax:
|
|
||||||
|
|
||||||
.. code-block:: none
|
|
||||||
|
|
||||||
NAME:
|
|
||||||
mc admin info COMMAND <ALIAS>
|
|
||||||
|
|
||||||
FLAGS
|
|
||||||
--debug Returns verbose information for debugging
|
|
||||||
|
|
||||||
If the specified ``<ALIAS>`` corresponds to a distributed MinIO deployment, the
|
|
||||||
command returns information for each MinIO server in the deployment. Use
|
|
||||||
:subcommand:`mc alias set` to list the currently configured aliases and their
|
|
||||||
corresponding endpoints.
|
|
||||||
|
|
||||||
*Display MinIO Server Information*
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin info myminio
|
|
||||||
|
|
||||||
.. _mc-admin-policy:
|
|
||||||
|
|
||||||
``mc admin policy``
|
|
||||||
~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
The ``mc admin policy`` command can add, remove, list, get info, and set
|
|
||||||
policies for a user on the MinIO server. MinIO policies are fully compatible
|
|
||||||
with AWS IAM S3 policies. See
|
|
||||||
:aws-docs:`AWS Policies and Permissions in Amazon S3
|
|
||||||
<AmazonS3/latest/dev/access-policy-language-overview.html>`.
|
|
||||||
|
|
||||||
The command has the following syntax:
|
|
||||||
|
|
||||||
.. code-block:: none
|
|
||||||
|
|
||||||
NAME:
|
|
||||||
mc admin policy COMMAND <ALIAS>
|
|
||||||
|
|
||||||
COMMANDS:
|
|
||||||
add add new policy
|
|
||||||
remove remove policy
|
|
||||||
list list all policies
|
|
||||||
info show info on a policy
|
|
||||||
set set IAM policy on a user or group
|
|
||||||
|
|
||||||
If the specified ``<ALIAS>`` corresponds to a distributed MinIO deployment, the
|
|
||||||
command adds the policy to each MinIO server in the deployment. Use
|
|
||||||
:subcommand:`mc alias set` to list the currently configured aliases and their
|
|
||||||
corresponding endpoints.
|
|
||||||
|
|
||||||
MinIO servers include the following canned policies:
|
|
||||||
|
|
||||||
.. code-block:: none
|
|
||||||
|
|
||||||
diagnostics
|
|
||||||
readonly
|
|
||||||
readwrite
|
|
||||||
writeonly
|
|
||||||
|
|
||||||
Example: Add a new policy to a MinIO server
|
|
||||||
```````````````````````````````````````````
|
|
||||||
|
|
||||||
Applying the following example policy ``listbucketsonly.json`` to a user
|
|
||||||
restricts that user to only listing the top layer buckets in the MinIO server.
|
|
||||||
The user cannot list any other resources, including any objects in the top layer
|
|
||||||
buckets.
|
|
||||||
|
|
||||||
The following operation creates the policy on the ``/tmp`` folder
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
cat <<EOF >> /tmp/listbucketsonly.json
|
|
||||||
{
|
|
||||||
"Version": "2012-10-17",
|
|
||||||
"Statement": [
|
|
||||||
{
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Action": [
|
|
||||||
"s3:ListAllMyBuckets"
|
|
||||||
],
|
|
||||||
"Resource": [
|
|
||||||
"arn:aws:s3:::*"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
Use the ``mc admin policy add`` command to add the policy to the MinIO server.
|
|
||||||
Replace ``<ALIAS>`` with the alias for the desired MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
mc admin policy add <ALIAS> listbucketsonly /tmp/listbucketsonly.json
|
|
||||||
|
|
||||||
Example: Remove a policy from a MinIO Server
|
|
||||||
````````````````````````````````````````````
|
|
||||||
|
|
||||||
Use the ``mc admin policy <ALIAS> remove`` command to remove a policy from the
|
|
||||||
MinIO server.
|
|
||||||
|
|
||||||
.. todo : what happens to current users who have that policy?
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
mc admin policy remove <ALIAS> listbucketsonly
|
|
||||||
|
|
||||||
Example: Display an existing policy
|
|
||||||
```````````````````````````````````
|
|
||||||
|
|
||||||
Use the ``mc admin policy <ALIAS> info`` command to retrieve policy's JSON
|
|
||||||
structure. Replace ``<ALIAS>`` with the alias for the desired MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
mc admin policy info <ALIAS> writeonly
|
|
||||||
|
|
||||||
Example: Associate a policy to a user or group
|
|
||||||
``````````````````````````````````````````````
|
|
||||||
|
|
||||||
Use the ``mc admin policy <ALIAS> set`` command to set a policy to a user or
|
|
||||||
group:
|
|
||||||
|
|
||||||
**Set policy for a user**
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
mc admin policy set <ALIAS> <POLICY> user=<USERNAME>
|
|
||||||
|
|
||||||
**Set policy for a group**
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
|
|
||||||
mc admin policy set <ALIAS> <POLICY> group=<GROUP>
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:titlesonly:
|
:titlesonly:
|
||||||
:hidden:
|
:hidden:
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
==================================
|
=========================
|
||||||
``mc admin bucket quota``
|
``mc admin bucket quota``
|
||||||
==================================
|
=========================
|
||||||
|
|
||||||
.. default-domain:: minio
|
.. default-domain:: minio
|
||||||
|
|
||||||
@@ -71,25 +71,82 @@ specified size value:
|
|||||||
|
|
||||||
Omitting the suffix defaults to ``bytes``.
|
Omitting the suffix defaults to ``bytes``.
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
Quick Reference
|
Configure a Hard Quota on a Bucket
|
||||||
---------------
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket quota play/mybucket --hard 10GB <mc admin bucket quota hard>`
|
Use :mc:`mc admin bucket quota` with the
|
||||||
Adds a hard quota of ``10GB`` to the ``mybucket`` bucket on the
|
:mc-cmd-option:`~mc admin bucket quota hard` flag to specify a hard quota
|
||||||
MinIO deployment with the ``play`` :mc-cmd:`alias <mc alias>`. MinIO
|
on a bucket. Hard quotas prevent the bucket size from growing past the specified
|
||||||
rejects any ``PUT`` request that would result in the bucket exceeding
|
limit.
|
||||||
the configured quota.
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket quota play/mybucket --fifo 10GB <mc admin bucket quota fifo>`
|
.. code-block:: shell
|
||||||
Adds a hard quota of ``10GB`` to the ``mybucket`` bucket on the
|
:class: copyable
|
||||||
MinIO deployment with the ``play`` :mc-cmd:`alias <mc alias>`. MinIO
|
|
||||||
removes the oldest objects on the bucket until it can satisfy the size
|
|
||||||
of an incoming ``PUT`` request.
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket quota play/mybucket --clear <mc admin bucket quota clear>`
|
mc admin bucket quota TARGET/BUCKET --hard LIMIT
|
||||||
Removes all quotas from the ``mybucket`` bucket on the MinIO deployment
|
|
||||||
with the ``play`` :mc-cmd:`alias <mc alias>`.
|
- Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
|
||||||
|
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
|
||||||
|
set the hard quota.
|
||||||
|
|
||||||
|
- Replace ``LIMIT`` with the maximum size to which the bucket can grow.
|
||||||
|
For example, to set a hard limit of 10 Terrabytes, specify ``10t``.
|
||||||
|
See :ref:`mc-admin-bucket-quota-units` for supported units.
|
||||||
|
|
||||||
|
Configure a First-In First-Out (FIFO) Quota on a Bucket
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc:`mc admin bucket quota` with the
|
||||||
|
:mc-cmd-option:`~mc admin bucket quota fifo` flag to specify a quota with
|
||||||
|
First-In First-Out deletion of content. FIFO quotas prevent the bucket size
|
||||||
|
from growing past the specified limit by deleting the oldest content on the
|
||||||
|
bucket to make room for newer content.
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin bucket quota TARGET/BUCKET --fifo LIMIT
|
||||||
|
|
||||||
|
- Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
|
||||||
|
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
|
||||||
|
set the quota.
|
||||||
|
|
||||||
|
- Replace ``LIMIT`` with the maximum size to which the bucket can grow.
|
||||||
|
For example, to set a limit of 10 Terrabytes, specify ``10t``.
|
||||||
|
See :ref:`mc-admin-bucket-quota-units` for supported units.
|
||||||
|
|
||||||
|
Retrieve Bucket Quota Configuration
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc:`mc admin bucket quota` to retrieve the current quota configuration
|
||||||
|
for a bucket:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin bucket quota TARGET/BUCKET
|
||||||
|
|
||||||
|
Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
|
||||||
|
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
|
||||||
|
retreive the quota.
|
||||||
|
|
||||||
|
Clear Configured Bucket Quota
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc:`mc admin bucket quota` with the
|
||||||
|
:mc-cmd-option:`~mc admin bucket quota clear` flag to clear all quotas from
|
||||||
|
a bucket.
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin bucket quota TARGET/BUCKET --clear
|
||||||
|
|
||||||
|
- Replace ``TARGET`` with the :mc-cmd:`alias <mc alias>` of a configured
|
||||||
|
MinIO deployment. Replace ``BUCKET`` with the name of the bucket on which to
|
||||||
|
clear the quota.
|
||||||
|
|
||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
@@ -99,7 +156,7 @@ Syntax
|
|||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin bucket quota TARGET [FLAGS] [ARGUMENTS]
|
mc admin bucket quota TARGET [ARGUMENTS]
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket quota` supports the following arguments:
|
:mc-cmd:`mc admin bucket quota` supports the following arguments:
|
||||||
|
|
||||||
@@ -114,6 +171,9 @@ Syntax
|
|||||||
|
|
||||||
mc admin bucket quota play/mybucket
|
mc admin bucket quota play/mybucket
|
||||||
|
|
||||||
|
Omit all other arguments to return the current quota settings for the
|
||||||
|
specified bucket.
|
||||||
|
|
||||||
.. mc-cmd:: hard
|
.. mc-cmd:: hard
|
||||||
:option:
|
:option:
|
||||||
|
|
||||||
@@ -129,8 +189,9 @@ Syntax
|
|||||||
.. mc-cmd:: fifo
|
.. mc-cmd:: fifo
|
||||||
:option:
|
:option:
|
||||||
|
|
||||||
Sets a limit to the bucket storage size after which MinIO removes the oldest
|
Sets a maximum limit to the bucket storage size. The MinIO server removes
|
||||||
objects in the bucket until the bucket size drops below the specified limit.
|
the oldest objects in the bucket to make space for newer objects such that
|
||||||
|
the bucket size remains below the specified limit.
|
||||||
|
|
||||||
For example, a ``fifo`` limit of ``10GB`` would result in removal of the
|
For example, a ``fifo`` limit of ``10GB`` would result in removal of the
|
||||||
oldest objects in the bucket once it reaches ``10GB`` in size.
|
oldest objects in the bucket once it reaches ``10GB`` in size.
|
||||||
|
@@ -13,15 +13,12 @@
|
|||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. start-mc-admin-bucket remote-desc
|
.. start-mc-admin-bucket-remote-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin bucket remote` command manages remote targets for
|
The :mc-cmd:`mc admin bucket remote` command manages the ``ARN`` resources
|
||||||
supporting bucket replication.
|
for use with :mc-cmd:`bucket replication <mc replicate>`.
|
||||||
|
|
||||||
.. end-mc-admin-bucket remote-desc
|
.. end-mc-admin-bucket-remote-desc
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote` creates the required ``ARN`` resource for
|
|
||||||
use with :mc-cmd:`mc replicate`.
|
|
||||||
|
|
||||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||||
:class: note
|
:class: note
|
||||||
@@ -30,68 +27,88 @@ use with :mc-cmd:`mc replicate`.
|
|||||||
:start-after: start-minio-only
|
:start-after: start-minio-only
|
||||||
:end-before: end-minio-only
|
:end-before: end-minio-only
|
||||||
|
|
||||||
MinIO Deployments Only
|
Examples
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
--------
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote` only supports MinIO deployments for the source
|
Add a New Replication Target
|
||||||
and target. MinIO provides no support or guarantees for other S3-compatible
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
services.
|
|
||||||
|
|
||||||
Quick Reference
|
Use :mc-cmd:`mc admin bucket remote add` to create a new replication target
|
||||||
---------------
|
ARN for use with :mc-cmd:`mc replicate`:
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote add play/mybucket target/mybucket <mc admin bucket remote add>`
|
|
||||||
Adds a new remote target ``target/mybucket`` to ``play/mybucket``,
|
|
||||||
where ``target`` and ``play`` are :mc-cmd:`aliases <mc alias>` for
|
|
||||||
configured MinIO deployments.
|
|
||||||
|
|
||||||
The command returns an ``ARN`` associated to the configured target.
|
|
||||||
:mc-cmd:`mc replicate` requires the ``ARN`` to enable replication
|
|
||||||
from a source bucket to a destination deployment and bucket.
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote ls play/mybucket <mc admin bucket remote ls>`
|
|
||||||
Lists all remote targets for ``play/mybucket``, where
|
|
||||||
``play`` is a :mc-cmd:`alias <mc alias>` for a configured MinIO deployment.
|
|
||||||
|
|
||||||
The command returns an ``ARN`` associated to each configured remote target.
|
|
||||||
:mc-cmd:`mc replicate` requires the ``ARN`` to enable replication
|
|
||||||
from a source bucket to a destination deployment and bucket.
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote rm play/mybucket target/mybucket <mc admin bucket remote rm>`
|
|
||||||
Removes the remote target ``target/mybucket`` from ``play/mybucket``,
|
|
||||||
where ``target`` and ``play`` are :mc-cmd:`aliases <mc alias>` for
|
|
||||||
configured MinIO deployments.
|
|
||||||
|
|
||||||
Removing a remote target halts any in-progress bucket replication
|
|
||||||
relying on that remote target's ARN.
|
|
||||||
|
|
||||||
Syntax
|
|
||||||
------
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote` has the following syntax:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin bucket remote SUBCOMMAND [ARGUMENTS]
|
mc admin bucket remote add TARGET/BUCKET SOURCE/BUCKET
|
||||||
|
|
||||||
:mc-cmd:`mc admin bucket remote` supports the following subcommands:
|
- Replace :mc-cmd:`TARGET <mc admin bucket remote add TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment to use as the replication
|
||||||
|
target. Replace ``BUCKET`` with the full path of the bucket into which MinIO
|
||||||
|
replicates objects from the ``SOURCE``.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`SOURCE <mc admin bucket remote add SOURCE>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment to use as the
|
||||||
|
replication source. Replace ``BUCKET`` with the full path of the bucket from
|
||||||
|
which MinIO replicates objects into the ``TARGET``.
|
||||||
|
|
||||||
|
Remove an Existing Replication Target
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin bucket remote rm` to remove a replication target from a
|
||||||
|
bucket:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin bucket remote rm SOURCE/BUCKET --arn ARN
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`SOURCE <mc admin bucket remote rm SOURCE>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment being used as the
|
||||||
|
replication source. Replace ``BUCKET`` with the full path of the bucket from
|
||||||
|
which MinIO replicates objects.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ARN <mc admin bucket remote rm ARN>` with the
|
||||||
|
ARN of the remote target.
|
||||||
|
|
||||||
|
Removing the target halts all in-progress
|
||||||
|
:mc-cmd:`bucket replication <mc replicate>` to the target.
|
||||||
|
|
||||||
|
Retrieve Configured Replication Targets
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin bucket remote ls` to list a bucket's configured
|
||||||
|
replication targets:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin bucket remote ls SOURCE/BUCKET
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`SOURCE <mc admin bucket remote ls SOURCE>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment being used as the
|
||||||
|
replication source. Replace ``BUCKET`` with the full path of the bucket from
|
||||||
|
which MinIO replicates objects.
|
||||||
|
|
||||||
|
Syntax
|
||||||
|
------
|
||||||
|
|
||||||
.. mc-cmd:: add
|
.. mc-cmd:: add
|
||||||
:fullpath:
|
:fullpath:
|
||||||
|
|
||||||
Adds a remote target to a bucket on the MinIO deployment. The
|
Adds a remote target to a bucket on a MinIO deployment. The
|
||||||
command has the following syntax:
|
command has the following syntax:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin bucket add TARGET DESTINATION --service "replication" [ARGUMENTS]
|
mc admin bucket add TARGET DESTINATION --service "replication" [FLAGS]
|
||||||
|
|
||||||
The command accepts the following arguments:
|
The command accepts the following arguments:
|
||||||
|
|
||||||
.. mc-cmd:: TARGET
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
The full path to the bucket to which the command adds the remote target.
|
The full path to the bucket to which the command adds the remote target.
|
||||||
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment as
|
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment as
|
||||||
the prefix to the bucket path. For example:
|
the prefix to the bucket path. For example:
|
||||||
@@ -103,23 +120,9 @@ Syntax
|
|||||||
|
|
||||||
.. mc-cmd:: DESTINATION
|
.. mc-cmd:: DESTINATION
|
||||||
|
|
||||||
The target MinIO deployment and bucket. Specify one of the two
|
*Required*
|
||||||
following formats:
|
|
||||||
|
|
||||||
.. tabs::
|
The target MinIO deployment and bucket.
|
||||||
|
|
||||||
.. tab:: ``alias/bucket``
|
|
||||||
|
|
||||||
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO
|
|
||||||
deployment as the prefix and destination bucket name as the suffix
|
|
||||||
using a forward slash ``/`` as a delimiter:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
<alias>/<bucket>
|
|
||||||
|
|
||||||
.. tab:: URL
|
|
||||||
|
|
||||||
Specify the full URL to the destination MinIO deployment and bucket
|
Specify the full URL to the destination MinIO deployment and bucket
|
||||||
using the following format:
|
using the following format:
|
||||||
@@ -141,14 +144,22 @@ Syntax
|
|||||||
- Replace ``DESTBUCKET`` with the bucket on the
|
- Replace ``DESTBUCKET`` with the bucket on the
|
||||||
destination.
|
destination.
|
||||||
|
|
||||||
|
.. mc-cmd:: service
|
||||||
|
:option:
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
|
Specify ``"replication"``.
|
||||||
|
|
||||||
.. mc-cmd:: region
|
.. mc-cmd:: region
|
||||||
:option:
|
:option:
|
||||||
|
|
||||||
The region of the :mc-cmd:`~mc admin bucket remote DESTINATION`.
|
The region of the :mc-cmd:`~mc admin bucket remote DESTINATION`.
|
||||||
|
|
||||||
Mutually exclusive with :mc-cmd-option:`~mc admin bucket remote path`
|
Mutually exclusive with :mc-cmd-option:`~mc admin bucket remote add path`
|
||||||
|
|
||||||
.. mc-cmd:: path
|
.. mc-cmd:: path
|
||||||
|
:option:
|
||||||
|
|
||||||
The bucket path lookup supported by the destination server. Specify
|
The bucket path lookup supported by the destination server. Specify
|
||||||
one of the following:
|
one of the following:
|
||||||
@@ -157,7 +168,8 @@ Syntax
|
|||||||
- ``off``
|
- ``off``
|
||||||
- ``auto`` (Default)
|
- ``auto`` (Default)
|
||||||
|
|
||||||
Mutually exclusive with :mc-cmd-option:`~mc admin bucket remote region`
|
Mutually exclusive with
|
||||||
|
:mc-cmd-option:`~mc admin bucket remote add region`
|
||||||
|
|
||||||
.. mc-cmd:: ls
|
.. mc-cmd:: ls
|
||||||
:fullpath:
|
:fullpath:
|
||||||
@@ -183,6 +195,13 @@ Syntax
|
|||||||
|
|
||||||
mc admin bucket ls play/mybucket
|
mc admin bucket ls play/mybucket
|
||||||
|
|
||||||
|
.. mc-cmd:: service
|
||||||
|
:option:
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
|
Specify ``"replication"``.
|
||||||
|
|
||||||
|
|
||||||
.. mc-cmd:: rm
|
.. mc-cmd:: rm
|
||||||
:fullpath:
|
:fullpath:
|
||||||
@@ -193,12 +212,14 @@ Syntax
|
|||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin bucket rm TARGET --arn
|
mc admin bucket rm TARGET --arn ARN
|
||||||
|
|
||||||
The command accepts the following arguments:
|
The command accepts the following arguments:
|
||||||
|
|
||||||
.. mc-cmd:: TARGET
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
The full path to the bucket for which the command <ACTION>. Specify the
|
The full path to the bucket for which the command <ACTION>. Specify the
|
||||||
:mc-cmd:`alias <mc alias>` of a configured MinIO deployment as the
|
:mc-cmd:`alias <mc alias>` of a configured MinIO deployment as the
|
||||||
prefix to the bucket path. For example:
|
prefix to the bucket path. For example:
|
||||||
@@ -211,6 +232,8 @@ Syntax
|
|||||||
.. mc-cmd:: ARN
|
.. mc-cmd:: ARN
|
||||||
:option:
|
:option:
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
The ``ARN`` of the remote target for which the command removes from the
|
The ``ARN`` of the remote target for which the command removes from the
|
||||||
target bucket. Use :mc-cmd:`mc admin bucket ls` to list all remote
|
target bucket. Use :mc-cmd:`mc admin bucket ls` to list all remote
|
||||||
targets and their associated ARNs for a specific bucket.
|
targets and their associated ARNs for a specific bucket.
|
||||||
|
@@ -13,11 +13,11 @@
|
|||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. start-mc-admin-groups-desc
|
.. start-mc-admin-group-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin group` command manages groups on a MinIO deployment.
|
The :mc-cmd:`mc admin group` command manages groups on a MinIO deployment.
|
||||||
|
|
||||||
.. end-mc-admin-groups-desc
|
.. end-mc-admin-group-desc
|
||||||
|
|
||||||
A :ref:`group <minio-groups>` is a collection of :ref:`users
|
A :ref:`group <minio-groups>` is a collection of :ref:`users
|
||||||
<minio-users>`. Each group can have one or more assigned
|
<minio-users>`. Each group can have one or more assigned
|
||||||
@@ -66,6 +66,113 @@ more information on MinIO policies, see :ref:`minio-policy`.
|
|||||||
:iam-docs:`Determining Whether a Request is Allowed or Denied Within an Account
|
:iam-docs:`Determining Whether a Request is Allowed or Denied Within an Account
|
||||||
<reference_policies_evaluation-logic.html#policy-eval-denyallow>`.
|
<reference_policies_evaluation-logic.html#policy-eval-denyallow>`.
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
Create a New Group
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group add` to create a new group to an S3-compatible host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group add ALIAS GROUPNAME MEMBER [MEMBER...]
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group add ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`GROUPNAME <mc admin group add GROUPNAME>` with the name
|
||||||
|
of the group to create.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`MEMBER <mc admin group add MEMBERS>` with *at least* one
|
||||||
|
:mc-cmd:`user <mc admin user>` on the S3 host. Specify multiple members
|
||||||
|
as a list: ``MEMBER1 MEMBER2 MEMBER3``
|
||||||
|
|
||||||
|
List Available Groups
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group list` to list list all groups on an S3-compatible
|
||||||
|
host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group list ALIAS
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group info ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
|
||||||
|
View Group Details
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group info` to view detailed group information on an
|
||||||
|
S3-compatible host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group info ALIAS GROUPNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group info ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`GROUPNAME <mc admin group info GROUPNAME>` with the name of
|
||||||
|
the group.
|
||||||
|
|
||||||
|
Remove a Group
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group remove` to remove a group from an S3-compatible
|
||||||
|
host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group remove ALIAS GROUPNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group remove ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`GROUPNAME <mc admin group remove GROUPNAME>` with the
|
||||||
|
name of the group.
|
||||||
|
|
||||||
|
Disable a Group
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group disable` to disable a group on an S3-compatible
|
||||||
|
host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group disable ALIAS GROUPNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group disable ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`GROUPNAME <mc admin group disable GROUPNAME>` with the name
|
||||||
|
of the group.
|
||||||
|
|
||||||
|
Enable a Group
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin group enable` to enable a group on an S3-compatible
|
||||||
|
host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin group enable ALIAS GROUPNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin group enable ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`GROUPNAME <mc admin group enable GROUPNAME>` with the name
|
||||||
|
of the group.
|
||||||
|
|
||||||
|
|
||||||
Quick Reference
|
Quick Reference
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
@@ -192,7 +299,7 @@ Syntax
|
|||||||
|
|
||||||
The name of the group to remove.
|
The name of the group to remove.
|
||||||
|
|
||||||
.. mc-cmd:: mc admin group enable
|
.. mc-cmd:: enable
|
||||||
:fullpath:
|
:fullpath:
|
||||||
|
|
||||||
Enables the group on the target MinIO deployment. Users can only inherit
|
Enables the group on the target MinIO deployment. Users can only inherit
|
||||||
@@ -216,7 +323,7 @@ Syntax
|
|||||||
|
|
||||||
The name of the group to enable.
|
The name of the group to enable.
|
||||||
|
|
||||||
.. mc-cmd:: mc admin group disable
|
.. mc-cmd:: disable
|
||||||
:fullpath:
|
:fullpath:
|
||||||
|
|
||||||
Disables the group on the target MinIO deployment. Users cannot inherit
|
Disables the group on the target MinIO deployment. Users cannot inherit
|
@@ -15,16 +15,16 @@ Description
|
|||||||
|
|
||||||
.. start-mc-admin-heal-desc
|
.. start-mc-admin-heal-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin heal` command scans for objects that are damaged or
|
The :mc:`mc admin heal` command scans for objects that are damaged or
|
||||||
corrupted and heals those objects.
|
corrupted and heals those objects.
|
||||||
|
|
||||||
:mc-cmd:`mc admin heal` is resource intensive and typically not required even
|
.. end-mc-admin-heal-desc
|
||||||
|
|
||||||
|
:mc:`mc admin heal` is resource intensive and typically not required even
|
||||||
after disk failures or corruption events. Instead, MinIO automatically heals
|
after disk failures or corruption events. Instead, MinIO automatically heals
|
||||||
objects damaged by silent bitrot corruption, disk failure, or other issues on
|
objects damaged by silent bitrot corruption, disk failure, or other issues on
|
||||||
POST/GET. MinIO also performs periodic background object healing.
|
POST/GET. MinIO also performs periodic background object healing.
|
||||||
|
|
||||||
.. end-mc-admin-heal-desc
|
|
||||||
|
|
||||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||||
:class: note
|
:class: note
|
||||||
|
|
||||||
@@ -35,17 +35,19 @@ POST/GET. MinIO also performs periodic background object healing.
|
|||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
|
|
||||||
:mc-cmd:`mc admin heal` has the following syntax:
|
:mc:`mc admin heal` has the following syntax:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin heal [FLAGS] TARGET
|
mc admin heal [FLAGS] TARGET
|
||||||
|
|
||||||
:mc-cmd:`mc admin heal` supports the following arguments:
|
:mc:`mc admin heal` supports the following arguments:
|
||||||
|
|
||||||
.. mc-cmd:: TARGET
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
The full path to the bucket or bucket prefix on which the command should
|
The full path to the bucket or bucket prefix on which the command should
|
||||||
perform object healing. Specify the :mc-cmd:`alias <mc alias>` of a
|
perform object healing. Specify the :mc-cmd:`alias <mc alias>` of a
|
||||||
configured MinIO deployment as the prefix for the path. For example:
|
configured MinIO deployment as the prefix for the path. For example:
|
||||||
|
@@ -15,7 +15,7 @@ Description
|
|||||||
|
|
||||||
.. start-mc-admin-info-desc
|
.. start-mc-admin-info-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin info` command displays information on a MinIO server.
|
The :mc:`mc admin info` command displays information on a MinIO server.
|
||||||
For distributed MinIO deployments, :mc:`mc admin info` displays information
|
For distributed MinIO deployments, :mc:`mc admin info` displays information
|
||||||
for each MinIO server in the deployment.
|
for each MinIO server in the deployment.
|
||||||
|
|
||||||
@@ -44,5 +44,4 @@ Syntax
|
|||||||
mc admin info TARGET
|
mc admin info TARGET
|
||||||
|
|
||||||
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment as the
|
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment as the
|
||||||
``TARGET``. :mc-cmd:`~mc admin service restart` restarts *all* MinIO servers in
|
``TARGET``.
|
||||||
the deployment.
|
|
90
source/minio-cli/minio-mc-admin/mc-admin-kms-key.rst
Normal file
90
source/minio-cli/minio-mc-admin/mc-admin-kms-key.rst
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
====================
|
||||||
|
``mc admin kms key``
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. default-domain:: minio
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
:local:
|
||||||
|
:depth: 2
|
||||||
|
|
||||||
|
.. mc:: mc admin kms key
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. start-mc-admin-kms-key-desc
|
||||||
|
|
||||||
|
The :mc-cmd:`mc admin kms key` command performs cryptographic key management
|
||||||
|
operations through the MinIO Key Encryption Service (KES).
|
||||||
|
|
||||||
|
.. end-mc-admin-kms-key-desc
|
||||||
|
|
||||||
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||||
|
:class: note
|
||||||
|
|
||||||
|
.. include:: /includes/facts-mc-admin.rst
|
||||||
|
:start-after: start-minio-only
|
||||||
|
:end-before: end-minio-only
|
||||||
|
|
||||||
|
.. TODO
|
||||||
|
|
||||||
|
Return to this section as part of the KES documentation. There's a lot here
|
||||||
|
that only makes sense once we can link to KES overview + config.
|
||||||
|
|
||||||
|
Syntax
|
||||||
|
------
|
||||||
|
|
||||||
|
.. mc-cmd:: create
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
|
|
||||||
|
Creates a new master key on a Key Management System (KMS).
|
||||||
|
|
||||||
|
The command has the following syntax:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin kms key create TARGET [KEY_NAME]
|
||||||
|
|
||||||
|
The command accepts the following arguments:
|
||||||
|
|
||||||
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment.
|
||||||
|
|
||||||
|
The ``TARGET`` deployment **must** include a configured
|
||||||
|
MinIO Key Encryption Service (KES) server.
|
||||||
|
|
||||||
|
.. mc-cmd:: KEY_NAME
|
||||||
|
|
||||||
|
Specify the name of the new master key.
|
||||||
|
|
||||||
|
.. mc-cmd:: status
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
|
Requests information on a Key Management System (KMS) master key.
|
||||||
|
|
||||||
|
The command has the following syntax:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin kms key status TARGET [KEY_NAME]
|
||||||
|
|
||||||
|
The command accepts the following arguments:
|
||||||
|
|
||||||
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
Specify the :mc-cmd:`alias <mc alias>` of a configured MinIO deployment.
|
||||||
|
|
||||||
|
The ``TARGET`` deployment **must** include a configured MinIO Key
|
||||||
|
Encryption Service (KES) server.
|
||||||
|
|
||||||
|
.. mc-cmd:: KEY_NAME
|
||||||
|
|
||||||
|
Specify the name of a master key on the KMS.
|
||||||
|
|
||||||
|
Omit this argument to return the default master key on the
|
||||||
|
:mc-cmd:`~mc admin kms key status TARGET` deployment.
|
@@ -1,51 +0,0 @@
|
|||||||
================
|
|
||||||
``mc admin kms``
|
|
||||||
================
|
|
||||||
|
|
||||||
.. default-domain:: minio
|
|
||||||
|
|
||||||
.. contents:: Table of Contents
|
|
||||||
:local:
|
|
||||||
:depth: 2
|
|
||||||
|
|
||||||
.. mc:: mc admin kms
|
|
||||||
|
|
||||||
Description
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. start-mc-admin-kms-desc
|
|
||||||
|
|
||||||
The :mc-cmd:`mc admin kms` command performs management operations on
|
|
||||||
a supported Key Management Service (KMS).
|
|
||||||
|
|
||||||
.. end-mc-admin-kms-desc
|
|
||||||
|
|
||||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
|
||||||
:class: note
|
|
||||||
|
|
||||||
.. include:: /includes/facts-mc-admin.rst
|
|
||||||
:start-after: start-minio-only
|
|
||||||
:end-before: end-minio-only
|
|
||||||
|
|
||||||
|
|
||||||
Syntax
|
|
||||||
------
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin kms` has the following syntax:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin kms key status TARGET KEYNAME
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin kms` supports the following:
|
|
||||||
|
|
||||||
.. mc-cmd:: TARGET
|
|
||||||
|
|
||||||
The :mc-cmd:`alias <mc alias>` of a configured MinIO server from which
|
|
||||||
the command returns the KMS status.
|
|
||||||
|
|
||||||
.. mc-cmd:: KEYNAME
|
|
||||||
|
|
||||||
The name of the speciific key to return.
|
|
||||||
|
|
@@ -15,14 +15,23 @@ Description
|
|||||||
|
|
||||||
.. start-mc-admin-obd-desc
|
.. start-mc-admin-obd-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin obd` command generates detailed diagnostics for the
|
The :mc:`mc admin obd` command generates detailed diagnostics for the
|
||||||
target MinIO deployment as a ``GZIP`` compressed ``JSON`` file. MinIO Support
|
target MinIO deployment as a ``GZIP`` compressed ``JSON`` file. MinIO Support
|
||||||
may request the output of :mc-cmd:`mc admin obd` as part of troubleshooting
|
may request the output of :mc:`mc admin obd` as part of troubleshooting
|
||||||
and diagnostics.
|
and diagnostics.
|
||||||
|
|
||||||
.. end-mc-admin-obd-desc
|
.. end-mc-admin-obd-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin odb` output may contain sensitive information about your
|
:mc:`mc admin odb` names the file using the following pattern:
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
alias-health_YYYYMMDDHHMMSS.json.gzip
|
||||||
|
|
||||||
|
The ``alias`` is the :mc-cmd:`~mc admin obd TARGET` MinIO deployment from which
|
||||||
|
:mc:`mc admin odb` returned the diagnostics.
|
||||||
|
|
||||||
|
The :mc:`mc admin odb` output may contain sensitive information about your
|
||||||
environment. Exercise all possible precautions, such as redacting sensitive
|
environment. Exercise all possible precautions, such as redacting sensitive
|
||||||
fields, prior to sharing the data on any public forum.
|
fields, prior to sharing the data on any public forum.
|
||||||
|
|
||||||
@@ -47,6 +56,8 @@ Syntax
|
|||||||
|
|
||||||
.. mc-cmd:: TARGET
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
|
*Required*
|
||||||
|
|
||||||
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
|
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
|
||||||
the command retrieves the diagnostic data.
|
the command retrieves the diagnostic data.
|
||||||
|
|
||||||
|
@@ -20,11 +20,6 @@ purposes.
|
|||||||
|
|
||||||
.. end-mc-admin-profile-desc
|
.. end-mc-admin-profile-desc
|
||||||
|
|
||||||
:mc-cmd:`mc admin profile` produces a ``ZIP`` archive ``profile.zip`` that
|
|
||||||
contains one or more ``.pprof`` files. Use the
|
|
||||||
`pprof <https://github.com/google/pprof>`__ ``go`` utility to read the
|
|
||||||
profile data.
|
|
||||||
|
|
||||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||||
:class: note
|
:class: note
|
||||||
|
|
||||||
@@ -32,20 +27,72 @@ profile data.
|
|||||||
:start-after: start-minio-only
|
:start-after: start-minio-only
|
||||||
:end-before: end-minio-only
|
:end-before: end-minio-only
|
||||||
|
|
||||||
Quick Reference
|
Profile Data Format
|
||||||
---------------
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
:mc-cmd:`mc admin profile start --type cpu myminio/ <mc admin profile start>`
|
:mc-cmd:`mc admin profile` produces a ``ZIP`` archive ``profile.zip`` that
|
||||||
Starts profiling data related to ``cpu`` statistics
|
contains one or more ``.pprof`` files. Use the
|
||||||
on the ``myminio`` :mc-cmd:`alias <mc alias>`.
|
`pprof <https://github.com/google/pprof>`__ ``go`` utility to read the
|
||||||
|
profile data.
|
||||||
|
|
||||||
:mc-cmd:`mc admin profile start --type "cpu,mem,block" myminio/ <mc admin profile start>`
|
Examples
|
||||||
Starts profiling data related to ``cpu``, ``mem``, and ``block`` statistics
|
--------
|
||||||
on the ``myminio`` :mc-cmd:`alias <mc alias>`.
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin profile stop myminio/ <mc admin profile stop>`
|
Profile Data for Single Resource
|
||||||
Stops profiling data on the ``myminio`` :mc-cmd:`alias <mc alias>` and
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
dumps the recorded data to ``profile.zip``.
|
|
||||||
|
Use :mc-cmd:`mc admin profile start` with the
|
||||||
|
:mc-cmd-option:`~mc admin profile start type` flag to start profiling the
|
||||||
|
resource:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin profile start --type "TYPE" ALIAS
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin profile start ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`TYPE <mc admin profile start type>` with the resource to
|
||||||
|
profile.
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin profile stop` to stop profiling data from the specified
|
||||||
|
resource and output the results:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin profile stop
|
||||||
|
|
||||||
|
The command outputs the profiled data as ``profile.zip``.
|
||||||
|
|
||||||
|
Profile Data for Multiple Resources
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin profile start` with the
|
||||||
|
:mc-cmd-option:`~mc admin profile start type` flag to start profiling the
|
||||||
|
resources:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin profile start --type "TYPE,[TYPE...]" ALIAS
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin profile start ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`TYPE <mc admin profile start type>` with the resources to
|
||||||
|
profile. Specify multiple resources as a comma-separated list.
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin profile stop` to stop profiling data from the specified
|
||||||
|
resources and output the results:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin profile stop
|
||||||
|
|
||||||
|
The command outputs the profiled data as ``profile.zip``.
|
||||||
|
|
||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
|
@@ -33,16 +33,21 @@ or MinIO Gateway deployments.
|
|||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
|
|
||||||
:mc-cmd:`mc admin top` has the following syntax:
|
.. mc-cmd:: locks
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
.. code-block:: shell
|
Returns the 10 oldest locks on the MinIO deployment.
|
||||||
|
|
||||||
|
The command has the following syntax:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin top lock TARGET
|
mc admin top locks TARGET
|
||||||
|
|
||||||
The command supports the following arguments:
|
The command supports the following arguments:
|
||||||
|
|
||||||
.. mc-cmd:: TARGET
|
.. mc-cmd:: TARGET
|
||||||
|
|
||||||
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
|
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
|
||||||
the command retrieves statistics.
|
the command retrieves statistics.
|
||||||
|
@@ -28,6 +28,20 @@ request against each MinIO server in a deployment.
|
|||||||
:start-after: start-minio-only
|
:start-after: start-minio-only
|
||||||
:end-before: end-minio-only
|
:end-before: end-minio-only
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
Use :mc:`mc admin trace` to perform an HTTP trace of each MinIO server in
|
||||||
|
the deployment:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin trace ALIAS
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin trace TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment.
|
||||||
|
|
||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
|
|
||||||
|
@@ -36,14 +36,16 @@ production environments.
|
|||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
|
|
||||||
.. include:: /includes/play-alias-available.rst
|
Use :mc:`mc admin update` to update each :mc:`minio` server process in the
|
||||||
:start-after: myminio-alias
|
MinIO deployment:
|
||||||
:end-before: end-myminio-alias
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin update myminio
|
mc admin update ALIAS
|
||||||
|
|
||||||
|
Replace :mc-cmd:`ALIAS <mc admin update ALIAS>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the MinIO deployment.
|
||||||
|
|
||||||
Syntax
|
Syntax
|
||||||
------
|
------
|
||||||
|
@@ -15,13 +15,13 @@ Description
|
|||||||
|
|
||||||
.. start-mc-admin-user-desc
|
.. start-mc-admin-user-desc
|
||||||
|
|
||||||
The :mc-cmd:`mc admin user` command manages users on a MinIO deployment.
|
The :mc-cmd:`mc admin user` command manages users on a MinIO deployment. Clients
|
||||||
|
*must* authenticate to the MinIO deployment with the access key and secret key
|
||||||
|
associated to a user on the deployment. MinIO users constitue a key component in
|
||||||
|
MinIO Identity and Access Management.
|
||||||
|
|
||||||
.. end-mc-admin-user-desc
|
.. end-mc-admin-user-desc
|
||||||
|
|
||||||
Clients authenticate to the MinIO deployment with the access key and secret key
|
|
||||||
associated to a user on the deployment.
|
|
||||||
|
|
||||||
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
|
||||||
:class: note
|
:class: note
|
||||||
|
|
||||||
@@ -72,68 +72,124 @@ more information on MinIO policies, see :ref:`minio-policy`.
|
|||||||
:iam-docs:`Determining Whether a Request is Allowed or Denied Within an Account
|
:iam-docs:`Determining Whether a Request is Allowed or Denied Within an Account
|
||||||
<reference_policies_evaluation-logic.html#policy-eval-denyallow>`.
|
<reference_policies_evaluation-logic.html#policy-eval-denyallow>`.
|
||||||
|
|
||||||
Quick Reference
|
Examples
|
||||||
---------------
|
--------
|
||||||
|
|
||||||
:mc-cmd:`mc admin user add TARGET ACCESSKEY SECRETKEY <mc admin user add>`
|
Create a New User
|
||||||
Adds a new user to a MinIO deployment.
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. code-block:: shell
|
Use :mc-cmd:`mc admin user add` to create a user on an S3-compatible host:
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user add play myNewUser myNewUserSecretKey
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user list TARGET <mc admin user list>`
|
|
||||||
Lists all users on a MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user list play
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user info TARGET USERNAME <mc admin user info>`
|
|
||||||
Returns detailed information for a user on a MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user info play myNewUser
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user remove TARGET USERNAME <mc admin user remove>`
|
|
||||||
Removes a user from a MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user remove play myNewUser
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user enable TARGET USERNAME <mc admin user enable>`
|
|
||||||
Enables a user on a MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user enable play myNewUser
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user disable TARGET USERNAME <mc admin user disable>`
|
|
||||||
Disables a user on a MinIO deployment.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
|
||||||
:class: copyable
|
|
||||||
|
|
||||||
mc admin user disable play myNewUser
|
|
||||||
|
|
||||||
Syntax
|
|
||||||
------
|
|
||||||
|
|
||||||
:mc-cmd:`mc admin user` has the following syntax:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc admin user SUBCOMMAND
|
mc admin user add ALIAS ACCESSKEY SECRETKEY
|
||||||
|
|
||||||
:mc-cmd:`mc admin user` supports the following subcommands:
|
- Replace :mc-cmd:`ALIAS <mc admin user add TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ACCESSKEY <mc admin user add ACCESSKEY>` with the
|
||||||
|
access key for the user. MinIO allows retrieving the access key after
|
||||||
|
user creation through the :mc-cmd:`mc admin user info` command.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`SECRETKEY <mc admin user add SECRETKEY>` with the
|
||||||
|
secret key for the user. MinIO *does not* provide any method for retrieving
|
||||||
|
the secret key once set.
|
||||||
|
|
||||||
|
Specify a unique, random, and long string for both the ``ACCESSKEY`` and
|
||||||
|
``SECRETKEY``. Your organization may have specific internal or regulatory
|
||||||
|
requirements around generating values for use with access or secret keys.
|
||||||
|
|
||||||
|
List Available Users
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user list` to list all users on an S3-compatible host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin user list ALIAS
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin user list TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
:mc-cmd:`mc admin user list` 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.
|
||||||
|
|
||||||
|
View User Details
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user info` to view detailed user information on an
|
||||||
|
S3-compatible host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin user info ALIAS USERNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin user info TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`USERNAME <mc admin user info USERNAME>` with the name of
|
||||||
|
the user.
|
||||||
|
|
||||||
|
Remove a User
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user remove` to remove a user from an S3-compatible host:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin user remove ALIAS USERNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin user remove TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`USERNAME <mc admin user remove USERNAME>` with the name of
|
||||||
|
the user to remove.
|
||||||
|
|
||||||
|
Disable a User
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user disable` to disable a user on an S3-compatible host.
|
||||||
|
Disabling a user prevents clients from authenticating to the S3 host with that
|
||||||
|
user's credentials, but does *not* remove that user from the S3 host.
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user enable` to enable a disabled user on an S3-compatible
|
||||||
|
host.
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin user disable ALIAS USERNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin user disable TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`USERNAME <mc admin user disable USERNAME>` with the name of
|
||||||
|
the user to disable.
|
||||||
|
|
||||||
|
Enable a User
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Use :mc-cmd:`mc admin user enable` to enable a user on an S3-compatible
|
||||||
|
host.
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
:class: copyable
|
||||||
|
|
||||||
|
mc admin user enable ALIAS USERNAME
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`ALIAS <mc admin user enable TARGET>` with the
|
||||||
|
:mc-cmd:`alias <mc alias>` of the S3-compatible host.
|
||||||
|
|
||||||
|
- Replace :mc-cmd:`USERNAME <mc admin user enable USERNAME>` with the name of
|
||||||
|
the user to enable.
|
||||||
|
|
||||||
|
Syntax
|
||||||
|
------
|
||||||
|
|
||||||
.. mc-cmd:: add
|
.. mc-cmd:: add
|
||||||
:fullpath:
|
:fullpath:
|
||||||
@@ -187,6 +243,7 @@ Syntax
|
|||||||
the command lists users.
|
the command lists users.
|
||||||
|
|
||||||
.. mc-cmd:: info
|
.. mc-cmd:: info
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
Returns detailed information of a user on the target MinIO deployment. The
|
Returns detailed information of a user on the target MinIO deployment. The
|
||||||
command has the following syntax:
|
command has the following syntax:
|
||||||
@@ -231,6 +288,7 @@ Syntax
|
|||||||
the user to remove.
|
the user to remove.
|
||||||
|
|
||||||
.. mc-cmd:: disable
|
.. mc-cmd:: disable
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
Disables a user on the target MinIO deployment. Clients cannot use the
|
Disables a user on the target MinIO deployment. Clients cannot use the
|
||||||
user credentials to authenticate to the MinIO deployment. Disabling
|
user credentials to authenticate to the MinIO deployment. Disabling
|
||||||
@@ -256,6 +314,7 @@ Syntax
|
|||||||
the user to disable.
|
the user to disable.
|
||||||
|
|
||||||
.. mc-cmd:: enable
|
.. mc-cmd:: enable
|
||||||
|
:fullpath:
|
||||||
|
|
||||||
Enables a user on the target deployment. Clients can only use enabled
|
Enables a user on the target deployment. Clients can only use enabled
|
||||||
users to authenticate to the MinIO deployment. Users created using
|
users to authenticate to the MinIO deployment. Users created using
|
||||||
|
Reference in New Issue
Block a user