1
0
mirror of https://github.com/minio/docs.git synced 2025-06-17 13:02:10 +03:00

additional cleanups after merge

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

View File

@ -38,6 +38,7 @@ release = '0.1'
extensions = [ extensions = [
'sphinx.ext.extlinks', 'sphinx.ext.extlinks',
'minio', 'minio',
'cond',
'sphinx_copybutton', 'sphinx_copybutton',
'sphinx_markdown_tables', 'sphinx_markdown_tables',
'sphinx-prompt', 'sphinx-prompt',

View File

@ -70,7 +70,7 @@ for creating this user with a home directory ``/home/minio-user``.
If the ``minio.service`` file specifies a different user account, use the If the ``minio.service`` file specifies a different user account, use the
``$HOME`` directory for that account. Alternatively, specify a custom ``$HOME`` directory for that account. Alternatively, specify a custom
certificate directory using the :mc-cmd:`minio server certs-dir` certificate directory using the :mc-cmd:`minio server --certs-dir`
commandline argument. Modify the ``MINIO_OPTS`` variable in commandline argument. Modify the ``MINIO_OPTS`` variable in
``/etc/defaults/minio`` to set this option. The ``systemd`` user which runs the ``/etc/defaults/minio`` to set this option. The ``systemd`` user which runs the
MinIO server process *must* have read and listing permissions for the specified MinIO server process *must* have read and listing permissions for the specified

View File

@ -37,14 +37,14 @@ The example above specifies the following arguments:
If you want to transition noncurrent object versions to a distinct If you want to transition noncurrent object versions to a distinct
remote tier, specify a different tier name for remote tier, specify a different tier name for
:mc-cmd:`~mc ilm add noncurrentversion-transition-storage-class`. :mc-cmd:`~mc ilm add --noncurrentversion-transition-storage-class`.
* - :mc-cmd:`DAYS <mc ilm add --transition-days>` * - :mc-cmd:`DAYS <mc ilm add --transition-days>`
- The number of calendar days after which MinIO marks an object as - The number of calendar days after which MinIO marks an object as
eligible for transition. Specify the number of days as an integer, eligible for transition. Specify the number of days as an integer,
e.g. ``30`` for 30 days. e.g. ``30`` for 30 days.
* - :mc-cmd:`NONCURRENT_DAYS <mc ilm add noncurrentversion-transition-days>` * - :mc-cmd:`NONCURRENT_DAYS <mc ilm add --noncurrentversion-transition-days>`
- The number of calendar days after which MinIO marks a noncurrent - The number of calendar days after which MinIO marks a noncurrent
object version as eligible for transition. MinIO specifically measures object version as eligible for transition. MinIO specifically measures
the time since an object *became* non-current instead of the object the time since an object *became* non-current instead of the object

View File

@ -93,7 +93,7 @@ certificate (``public.crt``) in the MinIO ``certs`` directory:
- For Windows: ``%%USERPROFILE%%\.minio\certs`` - For Windows: ``%%USERPROFILE%%\.minio\certs``
You can override the certificate directory using the You can override the certificate directory using the
:mc-cmd:`minio server certs-dir` commandline argument. :mc-cmd:`minio server --certs-dir` commandline argument.
3) Run the MinIO Server with Non-Default Credentials 3) Run the MinIO Server with Non-Default Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -87,10 +87,10 @@ Use :mc-cmd:`mc ilm add` to expiring noncurrent object versions and object
delete markers: delete markers:
- To expire noncurrent object versions after a specific duration in days, - To expire noncurrent object versions after a specific duration in days,
include :mc-cmd:`~mc ilm add noncurrentversion-expiration-days`. include :mc-cmd:`~mc ilm add --noncurrentversion-expiration-days`.
- To expire delete markers for objects with no remaining versions, - To expire delete markers for objects with no remaining versions,
include :mc-cmd:`~mc ilm add expired-object-delete-marker`. include :mc-cmd:`~mc ilm add --expired-object-delete-marker`.
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
@ -106,7 +106,7 @@ delete markers:
S3-compatible host. S3-compatible host.
- Replace :mc-cmd:`NONCURRENT_DAYS - Replace :mc-cmd:`NONCURRENT_DAYS
<mc ilm add noncurrentversion-expiration-days>` with the number of days after <mc ilm add --noncurrentversion-expiration-days>` with the number of days after
which to expire noncurrent object versions. For example, specify ``30d`` to which to expire noncurrent object versions. For example, specify ``30d`` to
expire a version after it has been noncurrent for at least 30 days. expire a version after it has been noncurrent for at least 30 days.

View File

@ -69,8 +69,8 @@ on :ref:`versioned buckets <minio-bucket-versioning>`. Specifically, MinIO by
default applies the transition operation to the *current* object version. default applies the transition operation to the *current* object version.
To transition noncurrent object versions, specify the To transition noncurrent object versions, specify the
:mc-cmd:`~mc ilm add noncurrentversion-transition-days` and :mc-cmd:`~mc ilm add --noncurrentversion-transition-days` and
:mc-cmd:`~mc ilm add noncurrentversion-transition-storage-class` options :mc-cmd:`~mc ilm add --noncurrentversion-transition-storage-class` options
when creating the transition rule. when creating the transition rule.
.. _minio-lifecycle-management-expiration: .. _minio-lifecycle-management-expiration:
@ -104,14 +104,14 @@ specific default behaviors for versioned buckets:
creating a ``DeleteMarker`` as is normal with versioned delete. creating a ``DeleteMarker`` as is normal with versioned delete.
To expire noncurrent object versions, specify the To expire noncurrent object versions, specify the
:mc-cmd:`~mc ilm add noncurrentversion-expiration-days` option :mc-cmd:`~mc ilm add --noncurrentversion-expiration-days` option
when creating the expiration rule. when creating the expiration rule.
- MinIO does not expire ``DeleteMarkers`` *even if* no other versions of - MinIO does not expire ``DeleteMarkers`` *even if* no other versions of
that object exist. that object exist.
To expire delete markers when there are no remaining versions for that To expire delete markers when there are no remaining versions for that
object, specify the :mc-cmd:`~mc ilm add expired-object-delete-marker` object, specify the :mc-cmd:`~mc ilm add --expired-object-delete-marker`
option when creating the expiration rule. option when creating the expiration rule.
.. _minio-lifecycle-management-scanner: .. _minio-lifecycle-management-scanner:

View File

@ -122,7 +122,7 @@ Use the :mc-cmd:`mc admin tier add` command to add a new remote storage tier:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin tier add azure TARGET TIER_NAME \ mc admin tier add --azure TARGET TIER_NAME \
--endpoint https://HOSTNAME --endpoint https://HOSTNAME
--bucket BUCKET \ --bucket BUCKET \
--prefix PREFIX --prefix PREFIX
@ -150,15 +150,15 @@ The example above uses the following arguments:
remote storage tier. Specify the name in all-caps, e.g. ``AZURE_TIER``. remote storage tier. Specify the name in all-caps, e.g. ``AZURE_TIER``.
This value is required in the next step. This value is required in the next step.
* - :mc-cmd:`HOSTNAME <mc admin tier add endpoint>` * - :mc-cmd:`HOSTNAME <mc admin tier add --endpoint>`
- The URL endpoint for the :abbr:`Azure (Microsoft Azure)` storage - The URL endpoint for the :abbr:`Azure (Microsoft Azure)` storage
backend. backend.
* - :mc-cmd:`BUCKET <mc admin tier add bucket>` * - :mc-cmd:`BUCKET <mc admin tier add --bucket>`
- The name of the bucket on the :abbr:`Azure (Microsoft Azure)` storage - The name of the bucket on the :abbr:`Azure (Microsoft Azure)` storage
backend to which MinIO transitions objects. backend to which MinIO transitions objects.
* - :mc-cmd:`PREFIX <mc admin tier add prefix>` * - :mc-cmd:`PREFIX <mc admin tier add --prefix>`
- The optional bucket prefix within which MinIO transitions objects. - The optional bucket prefix within which MinIO transitions objects.
MinIO stores all transitioned objects in the specified ``BUCKET`` under a MinIO stores all transitioned objects in the specified ``BUCKET`` under a
@ -171,7 +171,7 @@ The example above uses the following arguments:
source MinIO deployment to faciliate ease of operations related to source MinIO deployment to faciliate ease of operations related to
diagnostics, maintenance, or disaster recovery. diagnostics, maintenance, or disaster recovery.
* - :mc-cmd:`ACCOUNT <mc admin tier add account-name>` * - :mc-cmd:`ACCOUNT <mc admin tier add --account-name>`
- The account name MinIO uses to access the bucket. The account name - The account name MinIO uses to access the bucket. The account name
*must* correspond to an :abbr:`Azure (Microsoft Azure)` user with the *must* correspond to an :abbr:`Azure (Microsoft Azure)` user with the
required :ref:`permissions required :ref:`permissions
@ -179,10 +179,10 @@ The example above uses the following arguments:
You cannot change this account name after creating the tier. You cannot change this account name after creating the tier.
* - :mc-cmd:`KEY <mc admin tier add account-key>` * - :mc-cmd:`KEY <mc admin tier add --account-key>`
- The corresponding key for the specified ``ACCOUNT``. - The corresponding key for the specified ``ACCOUNT``.
* - :mc-cmd:`REGION <mc admin tier add region>` * - :mc-cmd:`REGION <mc admin tier add --region>`
- The :abbr:`Azure (Microsoft Azure)` blob storage region of the specified - The :abbr:`Azure (Microsoft Azure)` blob storage region of the specified
``BUCKET``. You can safely omit this option if the ``HOSTNAME`` includes ``BUCKET``. You can safely omit this option if the ``HOSTNAME`` includes
the region. the region.

View File

@ -121,7 +121,7 @@ service as the remote storage tier:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin tier add gcs TARGET TIER_NAME \ mc admin tier add --gcs TARGET TIER_NAME \
--endpoint https://HOSTNAME \ --endpoint https://HOSTNAME \
--bucket BUCKET \ --bucket BUCKET \
--prefix PREFIX \ --prefix PREFIX \
@ -147,15 +147,15 @@ The example above uses the following arguments:
remote storage tier. Specify the name in all-caps, e.g. ``GCS_TIER``. remote storage tier. Specify the name in all-caps, e.g. ``GCS_TIER``.
This value is required in the next step. This value is required in the next step.
* - :mc-cmd:`HOSTNAME <mc admin tier add endpoint>` * - :mc-cmd:`HOSTNAME <mc admin tier add --endpoint>`
- The URL endpoint for the :abbr:`GCS (Google Cloud Storage)` storage - The URL endpoint for the :abbr:`GCS (Google Cloud Storage)` storage
backend. backend.
* - :mc-cmd:`BUCKET <mc admin tier add bucket>` * - :mc-cmd:`BUCKET <mc admin tier add --bucket>`
- The name of the bucket on the :abbr:`GCS (Google Cloud Storage)` storage - The name of the bucket on the :abbr:`GCS (Google Cloud Storage)` storage
backend to which MinIO transitions objects. backend to which MinIO transitions objects.
* - :mc-cmd:`PREFIX <mc admin tier add prefix>` * - :mc-cmd:`PREFIX <mc admin tier add --prefix>`
- The optional bucket prefix within which MinIO transitions objects. - The optional bucket prefix within which MinIO transitions objects.
MinIO stores all transitioned objects in the specified ``BUCKET`` under a MinIO stores all transitioned objects in the specified ``BUCKET`` under a
@ -168,7 +168,7 @@ The example above uses the following arguments:
source MinIO deployment to faciliate ease of operations related to source MinIO deployment to faciliate ease of operations related to
diagnostics, maintenance, or disaster recovery. diagnostics, maintenance, or disaster recovery.
* - :mc-cmd:`CREDENTIALS <mc admin tier add credentials-file>` * - :mc-cmd:`CREDENTIALS <mc admin tier add --credentials-file>`
- The `credential file - The `credential file
<https://cloud.google.com/docs/authentication/getting-started>`__ for a <https://cloud.google.com/docs/authentication/getting-started>`__ for a
user on the remote GCS tier. The specified user credentials *must* user on the remote GCS tier. The specified user credentials *must*
@ -176,7 +176,7 @@ The example above uses the following arguments:
:ref:`permissions :ref:`permissions
<minio-lifecycle-management-transition-to-gcs-permissions-remote>`. <minio-lifecycle-management-transition-to-gcs-permissions-remote>`.
* - :mc-cmd:`REGION <mc admin tier add region>` * - :mc-cmd:`REGION <mc admin tier add --region>`
- The :abbr:`GCS (Google Cloud Storage)` region of the specified - The :abbr:`GCS (Google Cloud Storage)` region of the specified
``BUCKET``. You can safely omit this ``BUCKET``. You can safely omit this
option if the ``HOSTNAME`` includes the region. option if the ``HOSTNAME`` includes the region.

View File

@ -130,7 +130,7 @@ new remote storage tier:
.. code-block:: shell .. code-block:: shell
:class: copyable :class: copyable
mc admin tier add s3 TARGET TIER_NAME \ mc admin tier add --s3 TARGET TIER_NAME \
--endpoint https://HOSTNAME \ --endpoint https://HOSTNAME \
--bucket BUCKET \ --bucket BUCKET \
--prefix PREFIX --prefix PREFIX
@ -158,14 +158,14 @@ The example above uses the following arguments:
name in all-caps, e.g. ``S3_TIER``. This value is required in the next name in all-caps, e.g. ``S3_TIER``. This value is required in the next
step. step.
* - :mc-cmd:`HOSTNAME <mc admin tier add endpoint>` * - :mc-cmd:`HOSTNAME <mc admin tier add --endpoint>`
- The URL endpoint for the S3 storage backend. - The URL endpoint for the S3 storage backend.
* - :mc-cmd:`BUCKET <mc admin tier add bucket>` * - :mc-cmd:`BUCKET <mc admin tier add --bucket>`
- The name of the bucket on the S3 storage backend to which MinIO - The name of the bucket on the S3 storage backend to which MinIO
transitions objects. transitions objects.
* - :mc-cmd:`PREFIX <mc admin tier add prefix>` * - :mc-cmd:`PREFIX <mc admin tier add --prefix>`
- The optional bucket prefix within which MinIO transitions objects. - The optional bucket prefix within which MinIO transitions objects.
MinIO stores all transitioned objects in the specified ``BUCKET`` under a MinIO stores all transitioned objects in the specified ``BUCKET`` under a
@ -178,21 +178,21 @@ The example above uses the following arguments:
source MinIO deployment to faciliate ease of operations related to source MinIO deployment to faciliate ease of operations related to
diagnostics, maintenance, or disaster recovery. diagnostics, maintenance, or disaster recovery.
* - :mc-cmd:`ACCESS_KEY <mc admin tier add access-key>` * - :mc-cmd:`ACCESS_KEY <mc admin tier add --access-key>`
- The S3 access key MinIO uses to access the bucket. The - The S3 access key MinIO uses to access the bucket. The
access key *must* correspond to an IAM user with the access key *must* correspond to an IAM user with the
required required
:ref:`permissions :ref:`permissions
<minio-lifecycle-management-transition-to-s3-permissions-remote>`. <minio-lifecycle-management-transition-to-s3-permissions-remote>`.
* - :mc-cmd:`SECRET_KEY <mc admin tier add secret-key>` * - :mc-cmd:`SECRET_KEY <mc admin tier add --secret-key>`
- The corresponding secret key for the specified ``ACCESS_KEY``. - The corresponding secret key for the specified ``ACCESS_KEY``.
* - :mc-cmd:`REGION <mc admin tier add region>` * - :mc-cmd:`REGION <mc admin tier add --region>`
- The AWS S3 region of the specified ``BUCKET``. You can safely omit this - The AWS S3 region of the specified ``BUCKET``. You can safely omit this
option if the ``HOSTNAME`` includes the region. option if the ``HOSTNAME`` includes the region.
* - :mc-cmd:`STORAGE_CLASS <mc admin tier add storage-class>` * - :mc-cmd:`STORAGE_CLASS <mc admin tier add --storage-class>`
- The S3 storage class to which MinIO transitions objects. Specify - The S3 storage class to which MinIO transitions objects. Specify
one of the following supported storage classes: one of the following supported storage classes:

View File

@ -192,10 +192,10 @@ objects:
- Use :mc-cmd:`mc ls --versions` to view all versions of an object, - Use :mc-cmd:`mc ls --versions` to view all versions of an object,
including delete markers. including delete markers.
- Use :mc-cmd:`mc cp --version-id=UUID ... <mc cp version-id>` to - Use :mc-cmd:`mc cp --version-id=UUID ... <mc cp --version-id>` to
retrieve the version of the "deleted" object with matching ``UUID``. retrieve the version of the "deleted" object with matching ``UUID``.
- Use :mc-cmd:`mc rm --version-id=UUID ... <mc rm version-id>` to delete - Use :mc-cmd:`mc rm --version-id=UUID ... <mc rm --version-id>` to delete
the version of the object with matching ``UUID``. the version of the object with matching ``UUID``.
- Use :mc-cmd:`mc rm --versions` to delete *all* versions of an object. - Use :mc-cmd:`mc rm --versions` to delete *all* versions of an object.

View File

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

View File

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

View File

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

View File

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

View File

@ -16,7 +16,7 @@
.. |command| replace:: :mc-cmd:`mc cat` .. |command| replace:: :mc-cmd:`mc cat`
.. |rewind| replace:: :mc-cmd:`~mc cat --rewind` .. |rewind| replace:: :mc-cmd:`~mc cat --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cat version-id` .. |versionid| replace:: :mc-cmd:`~mc cat --version-id`
.. |alias| replace:: :mc-cmd:`~mc cat ALIAS` .. |alias| replace:: :mc-cmd:`~mc cat ALIAS`
Syntax Syntax
@ -97,7 +97,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst
@ -175,7 +175,7 @@ point-in-time in the past:
View an S3 Object with Specific Version View an S3 Object with Specific Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cat version-id` to return a specific version of the Use :mc-cmd:`mc cat --version-id` to return a specific version of the
object: object:
.. code-block:: shell .. code-block:: shell
@ -188,7 +188,7 @@ object:
- Replace :mc-cmd:`PATH <mc cat ALIAS>` with the path to the object on the - Replace :mc-cmd:`PATH <mc cat ALIAS>` with the path to the object on the
S3-compatible host. S3-compatible host.
- Replace :mc-cmd:`VERSION <mc cat version-id>` with the specific version of the - Replace :mc-cmd:`VERSION <mc cat --version-id>` with the specific version of the
object to return. object to return.
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc cp` .. |command| replace:: :mc-cmd:`mc cp`
.. |rewind| replace:: :mc-cmd:`~mc cp --rewind` .. |rewind| replace:: :mc-cmd:`~mc cp --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cp version-id` .. |versionid| replace:: :mc-cmd:`~mc cp --version-id`
.. |alias| replace:: :mc-cmd:`~mc cp SOURCE` .. |alias| replace:: :mc-cmd:`~mc cp SOURCE`
Syntax Syntax
@ -272,7 +272,7 @@ Parameters
``KEY1=VALUE1&KEY2=VALUE2``, where each pair represents one tag to ``KEY1=VALUE1&KEY2=VALUE2``, where each pair represents one tag to
assign to the objects. assign to the objects.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst
@ -415,7 +415,7 @@ specific point in time. This command only applies to S3-to-S3 copy.
Copy Specific Version of Object Copy Specific Version of Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cp version-id` to copy a specific version of an object. This Use :mc-cmd:`mc cp --version-id` to copy a specific version of an object. This
command only applies to S3-to-S3 copy. command only applies to S3-to-S3 copy.
.. code-block:: shell .. code-block:: shell

View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc head` .. |command| replace:: :mc-cmd:`mc head`
.. |rewind| replace:: :mc-cmd:`~mc head --rewind` .. |rewind| replace:: :mc-cmd:`~mc head --rewind`
.. |versionid| replace:: :mc-cmd:`~mc head version-id` .. |versionid| replace:: :mc-cmd:`~mc head --version-id`
.. |alias| replace:: :mc-cmd:`~mc head ALIAS` .. |alias| replace:: :mc-cmd:`~mc head ALIAS`
Syntax Syntax
@ -91,14 +91,14 @@ Parameters
mc head ~/mydata/object.txt mc head ~/mydata/object.txt
.. mc-cmd:: lines, n .. mc-cmd:: --lines, n
*Optional* The number of lines to print. *Optional* The number of lines to print.
Defaults to ``10``. Defaults to ``10``.
.. mc-cmd:: encrypt-key .. mc-cmd:: --encrypt-key
*Optional* Encrypt or decrypt objects using server-side encryption with *Optional* Encrypt or decrypt objects using server-side encryption with
@ -109,9 +109,9 @@ Parameters
object(s). object(s).
Enclose the entire list of key-value pairs passed to Enclose the entire list of key-value pairs passed to
:mc-cmd:`~mc head encrypt-key` in double quotes ``"``. :mc-cmd:`~mc head --encrypt-key` in double quotes ``"``.
:mc-cmd:`~mc head encrypt-key` can use the ``MC_ENCRYPT_KEY`` :mc-cmd:`~mc head --encrypt-key` can use the ``MC_ENCRYPT_KEY``
environment variable for retrieving a list of encryption key-value pairs environment variable for retrieving a list of encryption key-value pairs
as an alternative to specifying them on the command line. as an alternative to specifying them on the command line.
@ -122,7 +122,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst
@ -184,7 +184,7 @@ object at a specific point-in-time in the past:
View Partial Contents of an Object with Specific Version View Partial Contents of an Object with Specific Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc head version-id` to return the first 10 lines of the Use :mc-cmd:`mc head --version-id` to return the first 10 lines of the
object at a specific point-in-time in the past: object at a specific point-in-time in the past:
.. code-block:: shell .. code-block:: shell
@ -198,7 +198,7 @@ object at a specific point-in-time in the past:
- Replace :mc-cmd:`PATH <mc head ALIAS>` with the path to the object on the - Replace :mc-cmd:`PATH <mc head ALIAS>` with the path to the object on the
S3-compatible host. S3-compatible host.
- Replace :mc-cmd:`VERSION <mc head version-id>` with the version of the object. - Replace :mc-cmd:`VERSION <mc head --version-id>` with the version of the object.
For example, specify ``30d`` to return the version of the object 30 days prior For example, specify ``30d`` to return the version of the object 30 days prior
to the current date. to the current date.

View File

@ -103,7 +103,7 @@ Parameters
For versioned buckets, the expiry rule applies only to the *current* For versioned buckets, the expiry rule applies only to the *current*
object version. Use the object version. Use the
:mc-cmd:`~mc ilm add noncurrentversion-expiration-days` option :mc-cmd:`~mc ilm add --noncurrentversion-expiration-days` option
to apply expiration behavior to noncurrent object versions. to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured MinIO uses a scanner process to check objects against all configured
@ -113,12 +113,12 @@ Parameters
Mutually exclusive with the following options: Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm add expired-object-delete-marker` - :mc-cmd:`~mc ilm add --expired-object-delete-marker`
For more complete documentation on object expiration, see For more complete documentation on object expiration, see
:ref:`minio-lifecycle-management-expiration`. :ref:`minio-lifecycle-management-expiration`.
.. mc-cmd:: expired-object-delete-marker .. mc-cmd:: --expired-object-delete-marker
*Required* Specify this option to direct MinIO to remove delete markers for *Required* Specify this option to direct MinIO to remove delete markers for
@ -149,7 +149,7 @@ Parameters
For versioned buckets, the transition rule applies only to the *current* For versioned buckets, the transition rule applies only to the *current*
object version. Use the object version. Use the
:mc-cmd:`~mc ilm add noncurrentversion-transition-days` option :mc-cmd:`~mc ilm add --noncurrentversion-transition-days` option
to apply transition behavior to noncurrent object versions. to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm add --storage-class`. Requires specifying :mc-cmd:`~mc ilm add --storage-class`.
@ -180,9 +180,9 @@ Parameters
This option is mutually exclusive with the following option: This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add expired-object-delete-marker` - :mc-cmd:`~mc ilm add --expired-object-delete-marker`
.. mc-cmd:: noncurrentversion-expiration-days .. mc-cmd:: --noncurrentversion-expiration-days
*Optional* The number of days to retain an object version after becoming *Optional* The number of days to retain an object version after becoming
@ -198,7 +198,7 @@ Parameters
limited system resources may delay application of lifecycle management limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information. rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-days .. mc-cmd:: --noncurrentversion-transition-days
*Optional* The number of days an object has been non-current (i.e. replaced *Optional* The number of days an object has been non-current (i.e. replaced
@ -209,7 +209,7 @@ Parameters
passes that calendar date. passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying This option has no effect on non-versioned buckets. Requires specifying
:mc-cmd:`~mc ilm add noncurrentversion-transition-storage-class`. :mc-cmd:`~mc ilm add --noncurrentversion-transition-storage-class`.
This option has the same behavior as the This option has the same behavior as the
S3 ``NoncurrentVersionTransition`` action. S3 ``NoncurrentVersionTransition`` action.
@ -219,7 +219,7 @@ Parameters
limited system resources may delay application of lifecycle management limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information. rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-storage-class .. mc-cmd:: --noncurrentversion-transition-storage-class
*Optional* The remote storage tier to which MinIO *Optional* The remote storage tier to which MinIO

View File

@ -101,7 +101,7 @@ Parameters
For versioned buckets, the expiry rule applies only to the *current* For versioned buckets, the expiry rule applies only to the *current*
object version. Use the object version. Use the
:mc-cmd:`~mc ilm edit noncurrentversion-expiration-days` option :mc-cmd:`~mc ilm edit --noncurrentversion-expiration-days` option
to apply expiration behavior to noncurrent object versions. to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured MinIO uses a scanner process to check objects against all configured
@ -111,9 +111,9 @@ Parameters
Mutually exclusive with the following options: Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm edit expired-object-delete-marker` - :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: expired-object-delete-marker .. mc-cmd:: --expired-object-delete-marker
*Optional* Specify this option to direct MinIO to remove delete markers for *Optional* Specify this option to direct MinIO to remove delete markers for
@ -130,7 +130,7 @@ Parameters
limited system resources may delay application of lifecycle management limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information. rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-expiration-days .. mc-cmd:: --noncurrentversion-expiration-days
*Optional* The number of days to retain an object version after becoming *Optional* The number of days to retain an object version after becoming
@ -146,7 +146,7 @@ Parameters
limited system resources may delay application of lifecycle management limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information. rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-days .. mc-cmd:: --noncurrentversion-transition-days
*Optional* The number of days an object has been non-current (i.e. replaced *Optional* The number of days an object has been non-current (i.e. replaced
@ -157,7 +157,7 @@ Parameters
passes that calendar date. passes that calendar date.
This option has no effect on non-versioned buckets. Requires specifying This option has no effect on non-versioned buckets. Requires specifying
:mc-cmd:`~mc ilm edit noncurrentversion-transition-storage-class`. :mc-cmd:`~mc ilm edit --noncurrentversion-transition-storage-class`.
This option has the same behavior as the This option has the same behavior as the
S3 ``NoncurrentVersionTransition`` action. S3 ``NoncurrentVersionTransition`` action.
@ -167,7 +167,7 @@ Parameters
limited system resources may delay application of lifecycle management limited system resources may delay application of lifecycle management
rules. See :ref:`minio-lifecycle-management-scanner` for more information. rules. See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: noncurrentversion-transition-storage-class .. mc-cmd:: --noncurrentversion-transition-storage-class
*Optional* The remote storage tier to which MinIO *Optional* The remote storage tier to which MinIO
@ -187,7 +187,7 @@ Parameters
This option is mutually exclusive with the following option: This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm edit expired-object-delete-marker` - :mc-cmd:`~mc ilm edit --expired-object-delete-marker`
.. mc-cmd:: --transition-days .. mc-cmd:: --transition-days
@ -199,7 +199,7 @@ Parameters
For versioned buckets, the transition rule applies only to the *current* For versioned buckets, the transition rule applies only to the *current*
object version. Use the object version. Use the
:mc-cmd:`~mc ilm edit noncurrentversion-transition-days` option :mc-cmd:`~mc ilm edit --noncurrentversion-transition-days` option
to apply transition behavior to noncurrent object versions. to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm edit --storage-class`. Requires specifying :mc-cmd:`~mc ilm edit --storage-class`.

View File

@ -70,26 +70,26 @@ Parameters
mc ilm restore myminio/mybucket/object.txt mc ilm restore myminio/mybucket/object.txt
.. mc-cmd:: days value .. mc-cmd:: --days
*Optional* The number of days after which MinIO expires the restored copy *Optional* The number of days after which MinIO expires the restored copy
of the archived object. of the archived object.
.. mc-cmd:: recursive, r .. mc-cmd:: --recursive, r
*Optional* Restores all objects under the specified prefix. *Optional* Restores all objects under the specified prefix.
.. mc-cmd:: versions .. mc-cmd:: --versions
*Optional* Restores all versions of the object on the remote tier. *Optional* Restores all versions of the object on the remote tier.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
*Optional* Restores the specified version of the object on the remote tier. *Optional* Restores the specified version of the object on the remote tier.

View File

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold clear` .. |command| replace:: :mc-cmd:`mc legalhold clear`
.. |rewind| replace:: :mc-cmd:`~mc legalhold clear --rewind` .. |rewind| replace:: :mc-cmd:`~mc legalhold clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold clear version-id` .. |versionid| replace:: :mc-cmd:`~mc legalhold clear --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold clear ALIAS` .. |alias| replace:: :mc-cmd:`~mc legalhold clear ALIAS`
Syntax Syntax
@ -87,7 +87,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -14,7 +14,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold info` .. |command| replace:: :mc-cmd:`mc legalhold info`
.. |rewind| replace:: :mc-cmd:`~mc legalhold info --rewind` .. |rewind| replace:: :mc-cmd:`~mc legalhold info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold info version-id` .. |versionid| replace:: :mc-cmd:`~mc legalhold info --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold info ALIAS` .. |alias| replace:: :mc-cmd:`~mc legalhold info ALIAS`
Syntax Syntax
@ -86,7 +86,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc legalhold set` .. |command| replace:: :mc-cmd:`mc legalhold set`
.. |rewind| replace:: :mc-cmd:`~mc legalhold set --rewind` .. |rewind| replace:: :mc-cmd:`~mc legalhold set --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold set version-id` .. |versionid| replace:: :mc-cmd:`~mc legalhold set --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold set ALIAS` .. |alias| replace:: :mc-cmd:`~mc legalhold set ALIAS`
Syntax Syntax
@ -88,7 +88,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -12,7 +12,7 @@
.. |command| replace:: :mc-cmd:`mc retention clear` .. |command| replace:: :mc-cmd:`mc retention clear`
.. |rewind| replace:: :mc-cmd:`~mc retention clear --rewind` .. |rewind| replace:: :mc-cmd:`~mc retention clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention clear version-id` .. |versionid| replace:: :mc-cmd:`~mc retention clear --version-id`
.. |versions| replace:: :mc-cmd:`~mc retention clear --versions` .. |versions| replace:: :mc-cmd:`~mc retention clear --versions`
.. |alias| replace:: :mc-cmd:`~mc retention clear ALIAS` .. |alias| replace:: :mc-cmd:`~mc retention clear ALIAS`
@ -63,7 +63,7 @@ To change the retention status of an object under
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc retention clear version-id` is mutually exclusive with :mc-cmd:`mc retention clear --version-id` is mutually exclusive with
multiple other parameters. See the reference documentation for more multiple other parameters. See the reference documentation for more
information. information.
@ -87,7 +87,7 @@ Parameters
- If the ``ALIAS`` bucket has versioning enabled, - If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention clear` by default applies to only the latest :mc-cmd:`mc retention clear` by default applies to only the latest
object version. Use :mc-cmd:`~mc retention clear version-id` or object version. Use :mc-cmd:`~mc retention clear --version-id` or
:mc-cmd:`~mc retention clear --versions` to clear the object lock :mc-cmd:`~mc retention clear --versions` to clear the object lock
settings for a specific version or for all versions of the object. settings for a specific version or for all versions of the object.
@ -106,7 +106,7 @@ Parameters
*Optional* Recursively clears the object lock settings for all objects in the *Optional* Recursively clears the object lock settings for all objects in the
specified :mc-cmd:`~mc retention clear ALIAS` path. specified :mc-cmd:`~mc retention clear ALIAS` path.
Mutually exclusive with :mc-cmd:`~mc retention clear version-id`. Mutually exclusive with :mc-cmd:`~mc retention clear --version-id`.
.. mc-cmd:: --rewind .. mc-cmd:: --rewind
@ -115,7 +115,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -12,7 +12,7 @@
.. |command| replace:: :mc-cmd:`mc retention info` .. |command| replace:: :mc-cmd:`mc retention info`
.. |rewind| replace:: :mc-cmd:`~mc retention info --rewind` .. |rewind| replace:: :mc-cmd:`~mc retention info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention info version-id` .. |versionid| replace:: :mc-cmd:`~mc retention info --version-id`
.. |alias| replace:: :mc-cmd:`~mc retention info ALIAS` .. |alias| replace:: :mc-cmd:`~mc retention info ALIAS`
.. |versions| replace:: :mc-cmd:`~mc retention info --versions` .. |versions| replace:: :mc-cmd:`~mc retention info --versions`
@ -67,7 +67,7 @@ object locking enabled.
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc retention info version-id` is mutually exclusive with :mc-cmd:`mc retention info --version-id` is mutually exclusive with
multiple other parameters. See the reference documentation for more multiple other parameters. See the reference documentation for more
information. information.
@ -93,7 +93,7 @@ Parameters
- If the ``ALIAS`` bucket has versioning enabled, - If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention info` by default applies to only the latest object :mc-cmd:`mc retention info` by default applies to only the latest object
version. Use :mc-cmd:`~mc retention info version-id` or version. Use :mc-cmd:`~mc retention info --version-id` or
:mc-cmd:`~mc retention info --versions` to return the object lock :mc-cmd:`~mc retention info --versions` to return the object lock
settings for a specific version or for all versions of the object. settings for a specific version or for all versions of the object.
@ -113,7 +113,7 @@ Parameters
*Optional* Recursively returns the object lock settings for all objects in the *Optional* Recursively returns the object lock settings for all objects in the
specified :mc-cmd:`~mc retention info ALIAS` path. specified :mc-cmd:`~mc retention info ALIAS` path.
Mutually exclusive with :mc-cmd:`~mc retention info version-id`. Mutually exclusive with :mc-cmd:`~mc retention info --version-id`.
.. mc-cmd:: --rewind .. mc-cmd:: --rewind
@ -122,7 +122,7 @@ Parameters
:start-after: start-rewind-desc :start-after: start-rewind-desc
:end-before: end-rewind-desc :end-before: end-rewind-desc
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -13,7 +13,7 @@
.. |command| replace:: :mc-cmd:`mc rm` .. |command| replace:: :mc-cmd:`mc rm`
.. |rewind| replace:: :mc-cmd:`~mc rm --rewind` .. |rewind| replace:: :mc-cmd:`~mc rm --rewind`
.. |versions| replace:: :mc-cmd:`~mc rm --versions` .. |versions| replace:: :mc-cmd:`~mc rm --versions`
.. |versionid| replace:: :mc-cmd:`~mc rm version-id` .. |versionid| replace:: :mc-cmd:`~mc rm --version-id`
.. |alias| replace:: :mc-cmd:`~mc rm ALIAS` .. |alias| replace:: :mc-cmd:`~mc rm ALIAS`
Syntax Syntax
@ -75,7 +75,7 @@ results to the ``rm`` commandline tool.
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc rm --force` is required by multiple parameters. :mc-cmd:`mc rm --force` is required by multiple parameters.
:mc-cmd:`mc rm version-id` is mutually exclusive with multiple :mc-cmd:`mc rm --version-id` is mutually exclusive with multiple
parameters. See the reference documentation for more information. parameters. See the reference documentation for more information.
Parameters Parameters
@ -232,7 +232,7 @@ Parameters
:mc-cmd:`~mc rm --fake` flag to validate the scope of the :mc-cmd:`~mc rm --fake` flag to validate the scope of the
recursive delete operation. recursive delete operation.
Mutually exclusive with :mc-cmd:`mc rm version-id` Mutually exclusive with :mc-cmd:`mc rm --version-id`
.. mc-cmd:: --rewind .. mc-cmd:: --rewind
@ -257,7 +257,7 @@ Parameters
:mc-cmd:`~mc rm --rewind` together to remove all object :mc-cmd:`~mc rm --rewind` together to remove all object
versions which existed at a specific point in time. versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst
@ -395,7 +395,7 @@ that marks an object as deleted while retaining all previous versions of that
object. object.
- To remove a specific object version from a bucket, use - To remove a specific object version from a bucket, use
:mc-cmd:`mc rm version-id` :mc-cmd:`mc rm --version-id`
- To remove all versions of an object from a bucket, use - To remove all versions of an object from a bucket, use
:mc-cmd:`mc rm --versions` :mc-cmd:`mc rm --versions`

View File

@ -11,7 +11,7 @@
.. mc:: mc share download .. mc:: mc share download
.. |command| replace:: :mc-cmd:`mc share download` .. |command| replace:: :mc-cmd:`mc share download`
.. |versionid| replace:: :mc-cmd:`~mc share download version-id` .. |versionid| replace:: :mc-cmd:`~mc share download --version-id`
.. |alias| replace:: :mc-cmd:`~mc share download ALIAS` .. |alias| replace:: :mc-cmd:`~mc share download ALIAS`
Syntax Syntax
@ -110,7 +110,7 @@ Parameters
Required if any ``ALIAS`` specifies a path to a bucket or bucket prefix. Required if any ``ALIAS`` specifies a path to a bucket or bucket prefix.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -115,7 +115,7 @@ Parameters
See the S3 API :s3-api:`CSVOutput <API_CSVOutput.html>` for more See the S3 API :s3-api:`CSVOutput <API_CSVOutput.html>` for more
information. information.
.. mc-cmd:: csv-output-header .. mc-cmd:: --csv-output-header
*Optional* The header row of the ``.csv`` output file. Specify a string of *Optional* The header row of the ``.csv`` output file. Specify a string of

View File

@ -13,7 +13,7 @@
.. |command| replace:: :mc-cmd:`mc stat` .. |command| replace:: :mc-cmd:`mc stat`
.. |rewind| replace:: :mc-cmd:`~mc stat --rewind` .. |rewind| replace:: :mc-cmd:`~mc stat --rewind`
.. |versions| replace:: :mc-cmd:`~mc stat --versions` .. |versions| replace:: :mc-cmd:`~mc stat --versions`
.. |versionid| replace:: :mc-cmd:`~mc stat version-id` .. |versionid| replace:: :mc-cmd:`~mc stat --version-id`
.. |alias| replace:: :mc-cmd:`~mc stat ALIAS` .. |alias| replace:: :mc-cmd:`~mc stat ALIAS`
Syntax Syntax
@ -61,7 +61,7 @@ results to the ``stat`` commandline tool.
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc stat version-id` is mutually exclusive with multiple :mc-cmd:`mc stat --version-id` is mutually exclusive with multiple
parameters. See the reference documentation for more information. parameters. See the reference documentation for more information.
Parameters Parameters
@ -137,7 +137,7 @@ Parameters
:mc-cmd:`~mc stat --rewind` together to remove all object :mc-cmd:`~mc stat --rewind` together to remove all object
versions which existed at a specific point in time. versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc tag list` .. |command| replace:: :mc-cmd:`mc tag list`
.. |rewind| replace:: :mc-cmd:`~mc tag list --rewind` .. |rewind| replace:: :mc-cmd:`~mc tag list --rewind`
.. |versions| replace:: :mc-cmd:`~mc tag list --versions` .. |versions| replace:: :mc-cmd:`~mc tag list --versions`
.. |versionid| replace:: :mc-cmd:`~mc tag list version-id` .. |versionid| replace:: :mc-cmd:`~mc tag list --version-id`
.. |alias| replace:: :mc-cmd:`~mc tag list ALIAS` .. |alias| replace:: :mc-cmd:`~mc tag list ALIAS`
Syntax Syntax
@ -56,7 +56,7 @@ The :mc:`mc tag list` command lists all tags from a bucket or object.
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc tag list version-id` is mutually exclusive with :mc-cmd:`mc tag list --version-id` is mutually exclusive with
multiple parameters. See the reference documentation for more information. multiple parameters. See the reference documentation for more information.
Parameters Parameters
@ -90,7 +90,7 @@ Parameters
:mc-cmd:`~mc tag list --rewind` together to list tags from all :mc-cmd:`~mc tag list --rewind` together to list tags from all
object versions which existed at a specific point in time. object versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -15,7 +15,7 @@
.. |command| replace:: :mc-cmd:`mc tag remove` .. |command| replace:: :mc-cmd:`mc tag remove`
.. |rewind| replace:: :mc-cmd:`~mc tag remove --rewind` .. |rewind| replace:: :mc-cmd:`~mc tag remove --rewind`
.. |versions| replace:: :mc-cmd:`~mc tag remove --versions` .. |versions| replace:: :mc-cmd:`~mc tag remove --versions`
.. |versionid| replace:: :mc-cmd:`~mc tag remove version-id` .. |versionid| replace:: :mc-cmd:`~mc tag remove --version-id`
.. |alias| replace:: :mc-cmd:`~mc tag remove ALIAS` .. |alias| replace:: :mc-cmd:`~mc tag remove ALIAS`
Syntax Syntax
@ -55,7 +55,7 @@ The :mc:`mc tag remove` command removes all tags from a bucket or object.
:start-after: start-minio-syntax :start-after: start-minio-syntax
:end-before: end-minio-syntax :end-before: end-minio-syntax
:mc-cmd:`mc tag remove version-id` is mutually exclusive with :mc-cmd:`mc tag remove --version-id` is mutually exclusive with
multiple parameters. See the reference documentation for more information. multiple parameters. See the reference documentation for more information.
Parameters Parameters
@ -89,7 +89,7 @@ Parameters
:mc-cmd:`~mc tag remove --rewind` together to remove tags from all :mc-cmd:`~mc tag remove --rewind` together to remove tags from all
object versions which existed at a specific point in time. object versions which existed at a specific point in time.
.. mc-cmd:: version-id, vid .. mc-cmd:: --version-id, vid
.. include:: /includes/facts-versioning.rst .. include:: /includes/facts-versioning.rst

View File

@ -156,7 +156,7 @@ The command accepts the following arguments:
Omit to direct MinIO to generate a dynamic port at server startup. The Omit to direct MinIO to generate a dynamic port at server startup. The
MinIO server outputs the port to the system log. MinIO server outputs the port to the system log.
.. mc-cmd:: certs-dir, -S .. mc-cmd:: --certs-dir, -S
*Optional* Specifies the path to the folder containing certificates the *Optional* Specifies the path to the folder containing certificates the

View File

@ -383,10 +383,10 @@ configuration.
- Replace ``HOSTNAME`` with the URL of the remote MinIO deployment - Replace ``HOSTNAME`` with the URL of the remote MinIO deployment
- (Optional) Specify the :mc-cmd:`~mc admin bucket remote add sync` - (Optional) Specify the :mc-cmd:`~mc admin bucket remote add`
option to enable synchronous replication. Omit the option to use the default option to enable synchronous replication. Omit the option to use the default
of asynchronous replication. See the reference documentation for of asynchronous replication. See the reference documentation for
:mc-cmd:`~mc admin bucket remote add sync` for more information on :mc-cmd:`~mc admin bucket remote add` for more information on
synchronous vs asynchronous replication. synchronous vs asynchronous replication.
The command returns an ARN similar to the following. Copy this ARN for use in The command returns an ARN similar to the following. Copy this ARN for use in

View File

@ -335,10 +335,10 @@ bucket.
- Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the - Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the
``Baker`` cluster. ``Baker`` cluster.
- Specify the :mc-cmd:`~mc admin bucket remote add sync` option to - Specify the :mc-cmd:`~mc admin bucket remote add` option to
enable synchronous replication. Omit the option to use the default of enable synchronous replication. Omit the option to use the default of
asynchronous replication. See the reference documentation for asynchronous replication. See the reference documentation for
:mc-cmd:`~mc admin bucket remote add sync` for more information :mc-cmd:`~mc admin bucket remote add` for more information
on synchronous vs asynchronous replication. on synchronous vs asynchronous replication.
The command returns an ARN similar to the following: The command returns an ARN similar to the following:
@ -402,5 +402,5 @@ Use :mc-cmd:`mc ls` to verify the object exists on the destination bucket:
mc ls Baker/DESTINATIONBUCKET mc ls Baker/DESTINATIONBUCKET
If the remote target was configured *without* the If the remote target was configured *without* the
:mc-cmd:`~mc admin bucket remote add sync` option, the destination :mc-cmd:`~mc admin bucket remote add` option, the destination
bucket may have some delay before it receives the new object. bucket may have some delay before it receives the new object.

View File

@ -371,10 +371,10 @@ A\) Create a Replication Target for Alpha -> Baker
- Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the - Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the
``Baker`` cluster. ``Baker`` cluster.
- Specify the :mc-cmd:`~mc admin bucket remote add sync` option to - Specify the :mc-cmd:`~mc admin bucket remote add` option to
enable synchronous replication. Omit the option to use the default of enable synchronous replication. Omit the option to use the default of
asynchronous replication. See the reference documentation for asynchronous replication. See the reference documentation for
:mc-cmd:`~mc admin bucket remote add sync` for more information :mc-cmd:`~mc admin bucket remote add` for more information
on synchronous vs asynchronous replication. on synchronous vs asynchronous replication.
The command returns an ARN similar to the following. Copy this ARN for use in The command returns an ARN similar to the following. Copy this ARN for use in
@ -405,10 +405,10 @@ B\) Create a Replication Target for Baker -> Alpha
- Replace ``DESTINATIONBUCKET`` with the name of the remote replication - Replace ``DESTINATIONBUCKET`` with the name of the remote replication
target on the ``Alpha`` cluster. target on the ``Alpha`` cluster.
- Specify the :mc-cmd:`~mc admin bucket remote add sync` option to - Specify the :mc-cmd:`~mc admin bucket remote add` option to
enable synchronous replication. Omit the option to use the default of enable synchronous replication. Omit the option to use the default of
asynchronous replication. See the reference documentation for asynchronous replication. See the reference documentation for
:mc-cmd:`~mc admin bucket remote add sync` for more information :mc-cmd:`~mc admin bucket remote add` for more information
on synchronous vs asynchronous replication. on synchronous vs asynchronous replication.
The command returns an ARN similar to the following. Copy this ARN for use in The command returns an ARN similar to the following. Copy this ARN for use in
@ -530,5 +530,5 @@ Use :mc-cmd:`mc ls` to verify the object exists on the destination bucket:
mc ls Alpha/DESTINATIONBUCKET mc ls Alpha/DESTINATIONBUCKET
If the remote target was configured *without* the If the remote target was configured *without* the
:mc-cmd:`~mc admin bucket remote add sync` option, the destination :mc-cmd:`~mc admin bucket remote add` option, the destination
bucket may have some delay before it receives the new object. bucket may have some delay before it receives the new object.

View File

@ -242,7 +242,7 @@ it may also increase the time of each write operation due to replication load.
You must explicitly enable synchronous replication when configuring the remote You must explicitly enable synchronous replication when configuring the remote
target target using the :mc-cmd:`mc admin bucket remote add` command with the target target using the :mc-cmd:`mc admin bucket remote add` command with the
:mc-cmd:`~mc admin bucket remote add sync` flag. :mc-cmd:`~mc admin bucket remote add` flag.
Replication Internals Replication Internals
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~

View File

@ -1765,7 +1765,7 @@ ObjectStat objectStat =
StatObjectArgs.builder() StatObjectArgs.builder()
.bucket("my-bucketname") .bucket("my-bucketname")
.object("my-objectname") .object("my-objectname")
.versionId("version-id") .versionId(--version-id")
.build()); .build());
// Get information of a SSE-C encrypted versioned object. // Get information of a SSE-C encrypted versioned object.
@ -1774,7 +1774,7 @@ ObjectStat objectStat =
StatObjectArgs.builder() StatObjectArgs.builder()
.bucket("my-bucketname") .bucket("my-bucketname")
.object("my-objectname") .object("my-objectname")
.versionId("version-id") .versionId(--version-id")
.ssec(ssec) .ssec(ssec)
.build()); .build());
``` ```

View File

@ -849,7 +849,7 @@ __Parameters__
| `length` | _int_ | Number of bytes of object data from offset. | | `length` | _int_ | Number of bytes of object data from offset. |
| `request_headers` | _dict_ | Any additional headers to be added with GET request. | | `request_headers` | _dict_ | Any additional headers to be added with GET request. |
| `ssec` | _SseCustomerKey_ | Server-side encryption customer key. | | `ssec` | _SseCustomerKey_ | Server-side encryption customer key. |
| `version_id` | _str_ | Version-ID of the object. | | `version_id` | _str_ |--version-id of the object. |
| `extra_query_params` | _dict_ | Extra query parameters for advanced usage. | | `extra_query_params` | _dict_ | Extra query parameters for advanced usage. |
__Return Value__ __Return Value__
@ -869,7 +869,7 @@ finally:
response.close() response.close()
response.release_conn() response.release_conn()
# Get data of an object of version-ID. # Get data of an object of --version-id.
try: try:
response = client.get_object( response = client.get_object(
"my-bucket", "my-object", "my-bucket", "my-object",
@ -954,7 +954,7 @@ __Parameters__
| `file_path` | _str_ | Name of file to download. | | `file_path` | _str_ | Name of file to download. |
| `request_headers` | _dict_ | Any additional headers to be added with GET request. | | `request_headers` | _dict_ | Any additional headers to be added with GET request. |
| `ssec` | _SseCustomerKey_ | Server-side encryption customer key. | | `ssec` | _SseCustomerKey_ | Server-side encryption customer key. |
| `version_id` | _str_ | Version-ID of the object. | | `version_id` | _str_ |--version-id of the object. |
| `extra_query_params` | _dict_ | Extra query parameters for advanced usage. | | `extra_query_params` | _dict_ | Extra query parameters for advanced usage. |
| `tmp_file_path` | _str_ | Path to a temporary file. | | `tmp_file_path` | _str_ | Path to a temporary file. |
@ -970,7 +970,7 @@ __Example__
# Download data of an object. # Download data of an object.
client.fget_object("my-bucket", "my-object", "my-filename") client.fget_object("my-bucket", "my-object", "my-filename")
# Download data of an object of version-ID. # Download data of an object of --version-id.
client.fget_object( client.fget_object(
"my-bucket", "my-object", "my-filename", "my-bucket", "my-object", "my-filename",
version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d", version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d",
@ -1144,7 +1144,7 @@ result = client.put_object(
"my-bucket", "my-object", io.BytesIO(b"hello"), 5, "my-bucket", "my-object", io.BytesIO(b"hello"), 5,
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1157,7 +1157,7 @@ result = client.put_object(
"my-bucket", "my-object", data, length=-1, part_size=10*1024*1024, "my-bucket", "my-object", data, length=-1, part_size=10*1024*1024,
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1168,7 +1168,7 @@ result = client.put_object(
content_type="application/csv", content_type="application/csv",
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1179,7 +1179,7 @@ result = client.put_object(
metadata={"My-Project": "one"}, metadata={"My-Project": "one"},
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1190,7 +1190,7 @@ result = client.put_object(
sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"), sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1201,7 +1201,7 @@ result = client.put_object(
sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}), sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1212,7 +1212,7 @@ result = client.put_object(
sse=SseS3(), sse=SseS3(),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1230,7 +1230,7 @@ result = client.put_object(
legal_hold=True, legal_hold=True,
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1241,7 +1241,7 @@ result = client.put_object(
progress=Progress(), progress=Progress(),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1281,7 +1281,7 @@ result = client.fput_object(
"my-bucket", "my-object", "my-filename", "my-bucket", "my-object", "my-filename",
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1292,7 +1292,7 @@ result = client.fput_object(
content_type="application/csv", content_type="application/csv",
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1303,7 +1303,7 @@ result = client.fput_object(
metadata={"My-Project": "one"}, metadata={"My-Project": "one"},
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1314,7 +1314,7 @@ result = client.fput_object(
sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"), sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1325,7 +1325,7 @@ result = client.fput_object(
sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}), sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1336,7 +1336,7 @@ result = client.fput_object(
sse=SseS3(), sse=SseS3(),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1354,7 +1354,7 @@ result = client.fput_object(
legal_hold=True, legal_hold=True,
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1365,7 +1365,7 @@ result = client.fput_object(
progress=Progress(), progress=Progress(),
) )
print( print(
"created {0} object; etag: {1}, version-id: {2}".format( "created {0} object; etag: {1},--version-id: {2}".format(
result.object_name, result.etag, result.version_id, result.object_name, result.etag, result.version_id,
), ),
) )
@ -1404,7 +1404,7 @@ print(
), ),
) )
# Get object information of version-ID. # Get object information of --version-id.
result = client.stat_object( result = client.stat_object(
"my-bucket", "my-object", "my-bucket", "my-object",
version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d", version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d",

View File

@ -191,8 +191,8 @@ For example, consider the following policy assignments:
.. code-block:: shell .. code-block:: shell
mc admin policy set consoleAdmin user='cn=sisko,cn=users,dc=example,dc=com' mc admin policy set --consoleAdmin user='cn=sisko,cn=users,dc=example,dc=com'
mc admin policy set readwrite,diagnostics user='cn=dax,cn=users,dc=example,dc=com' mc admin policy set --readwrite,diagnostics user='cn=dax,cn=users,dc=example,dc=com'
- MinIO would assign an authenticated user with DN matching - MinIO would assign an authenticated user with DN matching
``cn=sisko,cn=users,dc=example,dc=com`` the :userpolicy:`consoleAdmin` ``cn=sisko,cn=users,dc=example,dc=com`` the :userpolicy:`consoleAdmin`
@ -235,8 +235,8 @@ For example, consider the following policy assignments:
.. code-block:: shell .. code-block:: shell
mc admin policy set consoleAdmin group='cn=ops,cn=groups,dc=example,dc=com' mc admin policy set --consoleAdmin group='cn=ops,cn=groups,dc=example,dc=com'
mc admin policy set diagnostics group='cn=engineering,cn=groups,dc=example,dc=com' mc admin policy set --diagnostics group='cn=engineering,cn=groups,dc=example,dc=com'
- MinIO would assign any authenticating user with membership in the - MinIO would assign any authenticating user with membership in the
``cn=ops,cn=groups,dc=example,dc=com`` AD/LDAP group the ``cn=ops,cn=groups,dc=example,dc=com`` AD/LDAP group the

View File

@ -40,7 +40,7 @@ appropriate TLS certificate for that hostname.
MinIO by default searches an OS-specific directory for TLS keys and MinIO by default searches an OS-specific directory for TLS keys and
certificates. For deployments started with a custom TLS directory certificates. For deployments started with a custom TLS directory
:mc-cmd:`minio server certs-dir`, use that directory instead of the :mc-cmd:`minio server --certs-dir`, use that directory instead of the
defaults. defaults.
.. tab-set:: .. tab-set::
@ -234,7 +234,7 @@ necessary CA key for MinIO to explicitly trust:
MinIO by default searches an OS-specific directory for Certificate Authority MinIO by default searches an OS-specific directory for Certificate Authority
certificates. For deployments started with a custom TLS directory certificates. For deployments started with a custom TLS directory
:mc-cmd:`minio server certs-dir`, use that directory instead of the :mc-cmd:`minio server --certs-dir`, use that directory instead of the
defaults. defaults.
.. tab-set:: .. tab-set::

39
sphinxext/cond.py Normal file
View File

@ -0,0 +1,39 @@
from docutils import nodes
from docutils.parsers.rst import Directive, directives
from docutils.utils import SafeString
from sphinx.util.nodes import nested_parse_with_titles, set_source_info
class Cond(Directive):
"""
Directive to only include text if the given tag(s) are enabled.
"""
has_content = True
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
option_spec = {}
def run(self):
config = self.state.document.settings.env.config
try:
result = config._raw_config['tags'].eval_condition(self.arguments[0])
except ValueError as err:
raise self.severe(u'Error parsing conditional parsing expression: {}'.format(SafeString(str(err))))
if result:
node = nodes.Element()
set_source_info(self, node)
nested_parse_with_titles(self.state, self.content, node)
return node.children
return []
def setup(app):
directives.register_directive('cond', Cond)
return {
'parallel_read_safe': True,
'parallel_write_safe': True,
}