minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00
Code Activity

additional cleanups after merge

Browse Source
This commit is contained in:
Ravind Kumar
2022-03-03 15:39:18 -05:00
parent 74e55a6ded
commit 93c9b00cb0
41 changed files with 228 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
source/reference/minio-mc-admin/mc-admin-bucket-remote.rst
View File

@ -144,22 +144,19 @@ Syntax
- Replace ``DESTBUCKET`` with the bucket on the
destination.
.. mc-cmd:: service
.. mc-cmd:: --service
*Required*
Specify ``"replication"``.
.. mc-cmd:: region
.. mc-cmd:: --region
The region of the :mc-cmd:`~mc admin bucket remote add DESTINATION`.
Mutually exclusive with :mc-cmd:`~mc admin bucket remote add path`
Mutually exclusive with :mc-cmd:`~mc admin bucket remote add`
.. mc-cmd:: path
.. mc-cmd:: --path
The bucket path lookup supported by the destination server. Specify
one of the following:
@ -169,10 +166,9 @@ Syntax
- ``auto`` (Default)
Mutually exclusive with
:mc-cmd:`~mc admin bucket remote add region`
:mc-cmd:`~mc admin bucket remote add`
.. mc-cmd:: sync
.. mc-cmd:: --sync
Enables synchronous replication, where MinIO attempts to replicate
the object *prior* to returning the PUT object response. Synchronous
@ -207,7 +203,7 @@ Syntax
mc admin bucket ls play/mybucket
.. mc-cmd:: service
.. mc-cmd:: --service
*Required*

4
source/reference/minio-mc-admin/mc-admin-heal.rst
View File

@ -80,12 +80,12 @@ Syntax
Inspects the :mc-cmd:`~mc admin heal TARGET` bucket or bucket prefix,
but does *not* perform any object healing.
.. mc-cmd:: force-start, f
.. mc-cmd:: --force-start, f
Force starts the healing process.
.. mc-cmd:: force-stop, s
.. mc-cmd:: --force-stop, s
Force stops the healing sequence.

20
source/reference/minio-mc-admin/mc-admin-policy.rst
View File

@ -152,7 +152,7 @@ Replace the ``<USER>`` with the name of a user that exists on the deployment.
.. code-block:: shell
:class: copyable
mc admin policy set myminio listbucketsonly user=<USER>
mc admin policy set --myminio listbucketsonly user=<USER>
The following :mc-cmd:`mc admin policy set` command associates the
``listbucketsonly`` policy to a group on the ``myminio`` MinIO deployment.
@ -161,7 +161,7 @@ Replace the ``<GROUP>`` with the name of a user that exists on the deployment.
.. code-block:: shell
:class: copyable
mc admin policy set myminio listbucketsonly group=<GROUP>
mc admin policy set --myminio listbucketsonly group=<GROUP>
Syntax
------
@ -264,14 +264,14 @@ Syntax
The :mc:`alias <mc alias>` of a configured MinIO deployment on which
the command associates the :mc-cmd:`~mc admin policy set POLICYNAME`
to the :mc-cmd:`~mc admin policy set user` or
:mc-cmd:`~mc admin policy set group`.
to the :mc-cmd:`~mc admin policy set --user` or
:mc-cmd:`~mc admin policy set --group`.
.. mc-cmd:: POLICYNAME
The name of the policy which the command associates to the specified
:mc-cmd:`~mc admin policy set user` or
:mc-cmd:`~mc admin policy set group`. Specify multiple policies
:mc-cmd:`~mc admin policy set --user` or
:mc-cmd:`~mc admin policy set --group`. Specify multiple policies
as a comma-separated list.
MinIO deployments include the following :ref:`built-in policies
@ -282,20 +282,20 @@ Syntax
- :userpolicy:`diagnostics`
- :userpolicy:`writeonly`
.. mc-cmd:: user
.. mc-cmd:: --user
The name of the user to which the command associates the
:mc-cmd:`~mc admin policy set POLICYNAME`.
Mutually exclusive with :mc-cmd:`~mc admin policy set group`
Mutually exclusive with :mc-cmd:`~mc admin policy set --group`
.. mc-cmd:: group
.. mc-cmd:: --group
The name of the group to which the command associates the
:mc-cmd:`~mc admin policy set POLICYNAME`. All users with membership in
the group inherit the policies associated to the group.
Mutually exclusive with :mc-cmd:`~mc admin policy set user`
Mutually exclusive with :mc-cmd:`~mc admin policy set --user`
.. mc-cmd:: remove
:fullpath:

44
source/reference/minio-mc-admin/mc-admin-tier.rst
View File

@ -129,8 +129,8 @@ Syntax
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add access-key`
- :mc-cmd:`~mc admin tier add secret-key`
- :mc-cmd:`~mc admin tier add --access-key`
- :mc-cmd:`~mc admin tier add --secret-key`
* - ``azure``
- Use :abbr:`Azure (Microsoft Azure)` Blob Storage as the storage
@ -138,8 +138,8 @@ Syntax
Requires specifying the following additional options:
- :mc-cmd:`~mc admin tier add account-name`
- :mc-cmd:`~mc admin tier add account-key`
- :mc-cmd:`~mc admin tier add --account-name`
- :mc-cmd:`~mc admin tier add --account-key`
* - ``gcs``
- Use :abbr:`GCP (Google Cloud Platform)` Cloud Storage as the
@ -147,7 +147,7 @@ Syntax
Requires specifying the following additional option:
- :mc-cmd:`~mc admin tier add credentials-file`
- :mc-cmd:`~mc admin tier add --credentials-file`
.. mc-cmd:: TARGET
@ -165,7 +165,7 @@ Syntax
You **must** specify the tier in all-caps, e.g. ``WARM_TIER``.
.. mc-cmd:: endpoint
.. mc-cmd:: --endpoint
*Required*
@ -174,7 +174,7 @@ Syntax
*must* resolve to the provider specified to
:mc-cmd:`~mc admin tier add TIER_TYPE`.
.. mc-cmd:: access-key
.. mc-cmd:: --access-key
*Required*
@ -186,7 +186,7 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: secret-key
.. mc-cmd:: --secret-key
*Required*
@ -196,7 +196,7 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: account-name
.. mc-cmd:: --account-name
*Required*
@ -213,18 +213,18 @@ Syntax
changing the account would change the storage backend and prevent access
to any objects transitioned to the original account/backend.
.. mc-cmd:: account-key
.. mc-cmd:: --account-key
*Required*
The account key for the :mc-cmd:`~mc admin tier add account-name`
The account key for the :mc-cmd:`~mc admin tier add --account-name`
associated to the remote Azure tier.
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: credentials-file
.. mc-cmd:: --credentials-file
*Required*
@ -237,24 +237,24 @@ Syntax
Required if :mc-cmd:`~mc admin tier add TIER_TYPE` is ``gcs``.
This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: bucket
.. mc-cmd:: --bucket
*Required*
The bucket on the remote tier to which MinIO transitions objects.
.. mc-cmd:: prefix
.. mc-cmd:: --prefix
*Optional*
The prefix path for the specified :mc-cmd:`~mc admin tier add bucket`
The prefix path for the specified :mc-cmd:`~mc admin tier add --bucket`
to which MinIO transitions objects.
Omit this field to transition objects into the bucket root.
.. mc-cmd:: storage-class
.. mc-cmd:: --storage-class
*Optional*
@ -270,7 +270,7 @@ Syntax
This option only applies if :mc-cmd:`~mc admin tier add TIER_TYPE` is
``s3``. This option has no effect for any other value of ``TIER_TYPE``.
.. mc-cmd:: region
.. mc-cmd:: --region
*Optional*
@ -311,7 +311,7 @@ Syntax
corresponds to the :mc-cmd:`mc admin tier add TIER_NAME` specified
when creating the remote tier.
.. mc-cmd:: access-key
.. mc-cmd:: --access-key
*Optional*
@ -324,7 +324,7 @@ Syntax
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: secret-key
.. mc-cmd:: --secret-key
*Optional*
@ -335,21 +335,21 @@ Syntax
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``s3``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: account-key
.. mc-cmd:: --account-key
*Required*
The account key for a user on the remote Azure tier.
Use this option to rotate the credentials for the
:mc-cmd:`~mc admin tier add account-name`
:mc-cmd:`~mc admin tier add --account-name`
associated to the remote tier.
This option only applies to remote storage tiers with
:mc-cmd:`~mc admin tier add TIER_TYPE` is ``azure``.
This option has no effect for any other ``TIER_TYPE``.
.. mc-cmd:: credentials-file
.. mc-cmd:: --credentials-file
*Required*