diff --git a/source/conf.py b/source/conf.py index 8d641091..f5c9d1fd 100644 --- a/source/conf.py +++ b/source/conf.py @@ -38,6 +38,7 @@ release = '0.1' extensions = [ 'sphinx.ext.extlinks', 'minio', + 'cond', 'sphinx_copybutton', 'sphinx_markdown_tables', 'sphinx-prompt', diff --git a/source/includes/common-installation.rst b/source/includes/common-installation.rst index 2587222c..1724f22d 100644 --- a/source/includes/common-installation.rst +++ b/source/includes/common-installation.rst @@ -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 ``$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 ``/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 diff --git a/source/includes/common-minio-tiering.rst b/source/includes/common-minio-tiering.rst index 11aa1d79..020da5a9 100644 --- a/source/includes/common-minio-tiering.rst +++ b/source/includes/common-minio-tiering.rst @@ -37,14 +37,14 @@ The example above specifies the following arguments: If you want to transition noncurrent object versions to a distinct 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 ` - The number of calendar days after which MinIO marks an object as eligible for transition. Specify the number of days as an integer, e.g. ``30`` for 30 days. - * - :mc-cmd:`NONCURRENT_DAYS ` + * - :mc-cmd:`NONCURRENT_DAYS ` - The number of calendar days after which MinIO marks a noncurrent object version as eligible for transition. MinIO specifically measures the time since an object *became* non-current instead of the object diff --git a/source/installation/deploy-minio-standalone.rst b/source/installation/deploy-minio-standalone.rst index 7e7fc919..e654e48c 100644 --- a/source/installation/deploy-minio-standalone.rst +++ b/source/installation/deploy-minio-standalone.rst @@ -93,7 +93,7 @@ certificate (``public.crt``) in the MinIO ``certs`` directory: - For Windows: ``%%USERPROFILE%%\.minio\certs`` 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/lifecycle-management/create-lifecycle-management-expiration-rule.rst b/source/lifecycle-management/create-lifecycle-management-expiration-rule.rst index cbdc4ce5..5fb50f4a 100644 --- a/source/lifecycle-management/create-lifecycle-management-expiration-rule.rst +++ b/source/lifecycle-management/create-lifecycle-management-expiration-rule.rst @@ -87,10 +87,10 @@ Use :mc-cmd:`mc ilm add` to expiring noncurrent object versions and object delete markers: - 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, - include :mc-cmd:`~mc ilm add expired-object-delete-marker`. + include :mc-cmd:`~mc ilm add --expired-object-delete-marker`. .. code-block:: shell :class: copyable @@ -106,7 +106,7 @@ delete markers: S3-compatible host. - Replace :mc-cmd:`NONCURRENT_DAYS - ` with the number of days after + ` with the number of days after which to expire noncurrent object versions. For example, specify ``30d`` to expire a version after it has been noncurrent for at least 30 days. diff --git a/source/lifecycle-management/lifecycle-management-overview.rst b/source/lifecycle-management/lifecycle-management-overview.rst index e6b0e0f6..d68ad8fc 100644 --- a/source/lifecycle-management/lifecycle-management-overview.rst +++ b/source/lifecycle-management/lifecycle-management-overview.rst @@ -69,8 +69,8 @@ on :ref:`versioned buckets `. Specifically, MinIO by default applies the transition operation to the *current* object version. To transition noncurrent object versions, specify the -: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-days` and +:mc-cmd:`~mc ilm add --noncurrentversion-transition-storage-class` options when creating the transition rule. .. _minio-lifecycle-management-expiration: @@ -104,14 +104,14 @@ specific default behaviors for versioned buckets: creating a ``DeleteMarker`` as is normal with versioned delete. 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. - MinIO does not expire ``DeleteMarkers`` *even if* no other versions of that object exist. 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. .. _minio-lifecycle-management-scanner: diff --git a/source/lifecycle-management/transition-objects-to-azure.rst b/source/lifecycle-management/transition-objects-to-azure.rst index 912ca105..7786d885 100644 --- a/source/lifecycle-management/transition-objects-to-azure.rst +++ b/source/lifecycle-management/transition-objects-to-azure.rst @@ -122,7 +122,7 @@ Use the :mc-cmd:`mc admin tier add` command to add a new remote storage tier: .. code-block:: shell :class: copyable - mc admin tier add azure TARGET TIER_NAME \ + mc admin tier add --azure TARGET TIER_NAME \ --endpoint https://HOSTNAME --bucket BUCKET \ --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``. This value is required in the next step. - * - :mc-cmd:`HOSTNAME ` + * - :mc-cmd:`HOSTNAME ` - The URL endpoint for the :abbr:`Azure (Microsoft Azure)` storage backend. - * - :mc-cmd:`BUCKET ` + * - :mc-cmd:`BUCKET ` - The name of the bucket on the :abbr:`Azure (Microsoft Azure)` storage backend to which MinIO transitions objects. - * - :mc-cmd:`PREFIX ` + * - :mc-cmd:`PREFIX ` - The optional bucket prefix within which MinIO transitions objects. 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 diagnostics, maintenance, or disaster recovery. - * - :mc-cmd:`ACCOUNT ` + * - :mc-cmd:`ACCOUNT ` - The account name MinIO uses to access the bucket. The account name *must* correspond to an :abbr:`Azure (Microsoft Azure)` user with the required :ref:`permissions @@ -179,10 +179,10 @@ The example above uses the following arguments: You cannot change this account name after creating the tier. - * - :mc-cmd:`KEY ` + * - :mc-cmd:`KEY ` - The corresponding key for the specified ``ACCOUNT``. - * - :mc-cmd:`REGION ` + * - :mc-cmd:`REGION ` - The :abbr:`Azure (Microsoft Azure)` blob storage region of the specified ``BUCKET``. You can safely omit this option if the ``HOSTNAME`` includes the region. diff --git a/source/lifecycle-management/transition-objects-to-gcs.rst b/source/lifecycle-management/transition-objects-to-gcs.rst index a66f9822..fde5d2dc 100644 --- a/source/lifecycle-management/transition-objects-to-gcs.rst +++ b/source/lifecycle-management/transition-objects-to-gcs.rst @@ -121,7 +121,7 @@ service as the remote storage tier: .. code-block:: shell :class: copyable - mc admin tier add gcs TARGET TIER_NAME \ + mc admin tier add --gcs TARGET TIER_NAME \ --endpoint https://HOSTNAME \ --bucket BUCKET \ --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``. This value is required in the next step. - * - :mc-cmd:`HOSTNAME ` + * - :mc-cmd:`HOSTNAME ` - The URL endpoint for the :abbr:`GCS (Google Cloud Storage)` storage backend. - * - :mc-cmd:`BUCKET ` + * - :mc-cmd:`BUCKET ` - The name of the bucket on the :abbr:`GCS (Google Cloud Storage)` storage backend to which MinIO transitions objects. - * - :mc-cmd:`PREFIX ` + * - :mc-cmd:`PREFIX ` - The optional bucket prefix within which MinIO transitions objects. 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 diagnostics, maintenance, or disaster recovery. - * - :mc-cmd:`CREDENTIALS ` + * - :mc-cmd:`CREDENTIALS ` - The `credential file `__ for a user on the remote GCS tier. The specified user credentials *must* @@ -176,7 +176,7 @@ The example above uses the following arguments: :ref:`permissions `. - * - :mc-cmd:`REGION ` + * - :mc-cmd:`REGION ` - The :abbr:`GCS (Google Cloud Storage)` region of the specified ``BUCKET``. You can safely omit this option if the ``HOSTNAME`` includes the region. diff --git a/source/lifecycle-management/transition-objects-to-s3.rst b/source/lifecycle-management/transition-objects-to-s3.rst index 948ae45d..4892098a 100644 --- a/source/lifecycle-management/transition-objects-to-s3.rst +++ b/source/lifecycle-management/transition-objects-to-s3.rst @@ -130,7 +130,7 @@ new remote storage tier: .. code-block:: shell :class: copyable - mc admin tier add s3 TARGET TIER_NAME \ + mc admin tier add --s3 TARGET TIER_NAME \ --endpoint https://HOSTNAME \ --bucket BUCKET \ --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 step. - * - :mc-cmd:`HOSTNAME ` + * - :mc-cmd:`HOSTNAME ` - The URL endpoint for the S3 storage backend. - * - :mc-cmd:`BUCKET ` + * - :mc-cmd:`BUCKET ` - The name of the bucket on the S3 storage backend to which MinIO transitions objects. - * - :mc-cmd:`PREFIX ` + * - :mc-cmd:`PREFIX ` - The optional bucket prefix within which MinIO transitions objects. 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 diagnostics, maintenance, or disaster recovery. - * - :mc-cmd:`ACCESS_KEY ` + * - :mc-cmd:`ACCESS_KEY ` - The S3 access key MinIO uses to access the bucket. The access key *must* correspond to an IAM user with the required :ref:`permissions `. - * - :mc-cmd:`SECRET_KEY ` + * - :mc-cmd:`SECRET_KEY ` - The corresponding secret key for the specified ``ACCESS_KEY``. - * - :mc-cmd:`REGION ` + * - :mc-cmd:`REGION ` - The AWS S3 region of the specified ``BUCKET``. You can safely omit this option if the ``HOSTNAME`` includes the region. - * - :mc-cmd:`STORAGE_CLASS ` + * - :mc-cmd:`STORAGE_CLASS ` - The S3 storage class to which MinIO transitions objects. Specify one of the following supported storage classes: diff --git a/source/object-retention/bucket-versioning.rst b/source/object-retention/bucket-versioning.rst index 7b409d78..ea353eec 100644 --- a/source/object-retention/bucket-versioning.rst +++ b/source/object-retention/bucket-versioning.rst @@ -192,10 +192,10 @@ objects: - Use :mc-cmd:`mc ls --versions` to view all versions of an object, including delete markers. -- Use :mc-cmd:`mc cp --version-id=UUID ... ` to +- Use :mc-cmd:`mc cp --version-id=UUID ... ` to retrieve the version of the "deleted" object with matching ``UUID``. -- Use :mc-cmd:`mc rm --version-id=UUID ... ` to delete +- Use :mc-cmd:`mc rm --version-id=UUID ... ` to delete the version of the object with matching ``UUID``. - Use :mc-cmd:`mc rm --versions` to delete *all* versions of an object. diff --git a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst index 8d964b44..51c1af4d 100644 --- a/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst +++ b/source/reference/minio-mc-admin/mc-admin-bucket-remote.rst @@ -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* diff --git a/source/reference/minio-mc-admin/mc-admin-heal.rst b/source/reference/minio-mc-admin/mc-admin-heal.rst index e889cd96..79ac9a13 100644 --- a/source/reference/minio-mc-admin/mc-admin-heal.rst +++ b/source/reference/minio-mc-admin/mc-admin-heal.rst @@ -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. diff --git a/source/reference/minio-mc-admin/mc-admin-policy.rst b/source/reference/minio-mc-admin/mc-admin-policy.rst index 87e435c8..8e189f99 100644 --- a/source/reference/minio-mc-admin/mc-admin-policy.rst +++ b/source/reference/minio-mc-admin/mc-admin-policy.rst @@ -152,7 +152,7 @@ Replace the ```` with the name of a user that exists on the deployment. .. code-block:: shell :class: copyable - mc admin policy set myminio listbucketsonly user= + mc admin policy set --myminio listbucketsonly 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 ```` with the name of a user that exists on the deployment. .. code-block:: shell :class: copyable - mc admin policy set myminio listbucketsonly group= + mc admin policy set --myminio listbucketsonly group= Syntax ------ @@ -264,14 +264,14 @@ Syntax The :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: diff --git a/source/reference/minio-mc-admin/mc-admin-tier.rst b/source/reference/minio-mc-admin/mc-admin-tier.rst index ea450922..33571a59 100644 --- a/source/reference/minio-mc-admin/mc-admin-tier.rst +++ b/source/reference/minio-mc-admin/mc-admin-tier.rst @@ -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* diff --git a/source/reference/minio-mc/mc-cat.rst b/source/reference/minio-mc/mc-cat.rst index b2344721..d1ee6c80 100644 --- a/source/reference/minio-mc/mc-cat.rst +++ b/source/reference/minio-mc/mc-cat.rst @@ -16,7 +16,7 @@ .. |command| replace:: :mc-cmd:`mc cat` .. |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` Syntax @@ -97,7 +97,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst @@ -175,7 +175,7 @@ point-in-time in the past: 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: .. code-block:: shell @@ -188,7 +188,7 @@ object: - Replace :mc-cmd:`PATH ` with the path to the object on the S3-compatible host. -- Replace :mc-cmd:`VERSION ` with the specific version of the +- Replace :mc-cmd:`VERSION ` with the specific version of the object to return. .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-cp.rst b/source/reference/minio-mc/mc-cp.rst index 66252a17..1279ed87 100644 --- a/source/reference/minio-mc/mc-cp.rst +++ b/source/reference/minio-mc/mc-cp.rst @@ -14,7 +14,7 @@ .. |command| replace:: :mc-cmd:`mc cp` .. |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` Syntax @@ -272,7 +272,7 @@ Parameters ``KEY1=VALUE1&KEY2=VALUE2``, where each pair represents one tag to assign to the objects. -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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. .. code-block:: shell diff --git a/source/reference/minio-mc/mc-head.rst b/source/reference/minio-mc/mc-head.rst index b11bc46e..37e6a6ef 100644 --- a/source/reference/minio-mc/mc-head.rst +++ b/source/reference/minio-mc/mc-head.rst @@ -15,7 +15,7 @@ .. |command| replace:: :mc-cmd:`mc head` .. |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` Syntax @@ -66,7 +66,7 @@ tool. Parameters ~~~~~~~~~~ -.. mc-cmd:: ALIAS +.. mc-cmd:: ALIAS *Required* The object or objects to print. @@ -91,14 +91,14 @@ Parameters mc head ~/mydata/object.txt -.. mc-cmd:: lines, n +.. mc-cmd:: --lines, n *Optional* The number of lines to print. Defaults to ``10``. -.. mc-cmd:: encrypt-key +.. mc-cmd:: --encrypt-key *Optional* Encrypt or decrypt objects using server-side encryption with @@ -109,9 +109,9 @@ Parameters object(s). 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 as an alternative to specifying them on the command line. @@ -122,7 +122,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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: .. code-block:: shell @@ -198,7 +198,7 @@ object at a specific point-in-time in the past: - Replace :mc-cmd:`PATH ` with the path to the object on the S3-compatible host. -- Replace :mc-cmd:`VERSION ` with the version of the object. +- Replace :mc-cmd:`VERSION ` with the version of the object. For example, specify ``30d`` to return the version of the object 30 days prior to the current date. diff --git a/source/reference/minio-mc/mc-ilm-add.rst b/source/reference/minio-mc/mc-ilm-add.rst index 4b7b17c6..5e4fcbfe 100644 --- a/source/reference/minio-mc/mc-ilm-add.rst +++ b/source/reference/minio-mc/mc-ilm-add.rst @@ -103,7 +103,7 @@ Parameters For versioned buckets, the expiry rule applies only to the *current* 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. MinIO uses a scanner process to check objects against all configured @@ -113,12 +113,12 @@ Parameters 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 :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 @@ -149,7 +149,7 @@ Parameters For versioned buckets, the transition rule applies only to the *current* 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. Requires specifying :mc-cmd:`~mc ilm add --storage-class`. @@ -180,9 +180,9 @@ Parameters 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 @@ -198,7 +198,7 @@ Parameters limited system resources may delay application of lifecycle management 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 @@ -209,7 +209,7 @@ Parameters passes that calendar date. 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 S3 ``NoncurrentVersionTransition`` action. @@ -219,7 +219,7 @@ Parameters limited system resources may delay application of lifecycle management 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 diff --git a/source/reference/minio-mc/mc-ilm-edit.rst b/source/reference/minio-mc/mc-ilm-edit.rst index 1bc90fe9..74849a0b 100644 --- a/source/reference/minio-mc/mc-ilm-edit.rst +++ b/source/reference/minio-mc/mc-ilm-edit.rst @@ -101,7 +101,7 @@ Parameters For versioned buckets, the expiry rule applies only to the *current* 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. MinIO uses a scanner process to check objects against all configured @@ -111,9 +111,9 @@ Parameters 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 @@ -130,7 +130,7 @@ Parameters limited system resources may delay application of lifecycle management 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 @@ -146,7 +146,7 @@ Parameters limited system resources may delay application of lifecycle management 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 @@ -157,7 +157,7 @@ Parameters passes that calendar date. 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 S3 ``NoncurrentVersionTransition`` action. @@ -167,7 +167,7 @@ Parameters limited system resources may delay application of lifecycle management 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 @@ -187,7 +187,7 @@ Parameters 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 @@ -199,7 +199,7 @@ Parameters For versioned buckets, the transition rule applies only to the *current* 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. Requires specifying :mc-cmd:`~mc ilm edit --storage-class`. diff --git a/source/reference/minio-mc/mc-ilm-restore.rst b/source/reference/minio-mc/mc-ilm-restore.rst index 434ac828..c0128f78 100644 --- a/source/reference/minio-mc/mc-ilm-restore.rst +++ b/source/reference/minio-mc/mc-ilm-restore.rst @@ -70,26 +70,26 @@ Parameters 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 of the archived object. -.. mc-cmd:: recursive, r +.. mc-cmd:: --recursive, r *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. -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid *Optional* Restores the specified version of the object on the remote tier. diff --git a/source/reference/minio-mc/mc-legalhold-clear.rst b/source/reference/minio-mc/mc-legalhold-clear.rst index 78797af6..cfba3d2a 100644 --- a/source/reference/minio-mc/mc-legalhold-clear.rst +++ b/source/reference/minio-mc/mc-legalhold-clear.rst @@ -14,7 +14,7 @@ .. |command| replace:: :mc-cmd:`mc legalhold clear` .. |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` Syntax @@ -87,7 +87,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-legalhold-info.rst b/source/reference/minio-mc/mc-legalhold-info.rst index 90640f81..ce09de51 100644 --- a/source/reference/minio-mc/mc-legalhold-info.rst +++ b/source/reference/minio-mc/mc-legalhold-info.rst @@ -14,7 +14,7 @@ .. |command| replace:: :mc-cmd:`mc legalhold info` .. |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` Syntax @@ -86,7 +86,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-legalhold-set.rst b/source/reference/minio-mc/mc-legalhold-set.rst index 42dfd719..21a7eafc 100644 --- a/source/reference/minio-mc/mc-legalhold-set.rst +++ b/source/reference/minio-mc/mc-legalhold-set.rst @@ -15,7 +15,7 @@ .. |command| replace:: :mc-cmd:`mc legalhold set` .. |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` Syntax @@ -88,7 +88,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-retention-clear.rst b/source/reference/minio-mc/mc-retention-clear.rst index c42761b5..03661623 100644 --- a/source/reference/minio-mc/mc-retention-clear.rst +++ b/source/reference/minio-mc/mc-retention-clear.rst @@ -12,7 +12,7 @@ .. |command| replace:: :mc-cmd:`mc retention clear` .. |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` .. |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 :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 information. @@ -87,7 +87,7 @@ Parameters - If the ``ALIAS`` bucket has versioning enabled, :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 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 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 @@ -115,7 +115,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-retention-info.rst b/source/reference/minio-mc/mc-retention-info.rst index ac61dcfa..c096ff4d 100644 --- a/source/reference/minio-mc/mc-retention-info.rst +++ b/source/reference/minio-mc/mc-retention-info.rst @@ -12,7 +12,7 @@ .. |command| replace:: :mc-cmd:`mc retention info` .. |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` .. |versions| replace:: :mc-cmd:`~mc retention info --versions` @@ -67,7 +67,7 @@ object locking enabled. :start-after: start-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 information. @@ -93,7 +93,7 @@ Parameters - If the ``ALIAS`` bucket has versioning enabled, :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 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 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 @@ -122,7 +122,7 @@ Parameters :start-after: start-rewind-desc :end-before: end-rewind-desc -.. mc-cmd:: version-id, vid +.. mc-cmd:: --version-id, vid .. include:: /includes/facts-versioning.rst diff --git a/source/reference/minio-mc/mc-rm.rst b/source/reference/minio-mc/mc-rm.rst index 5c3590ea..48a34190 100644 --- a/source/reference/minio-mc/mc-rm.rst +++ b/source/reference/minio-mc/mc-rm.rst @@ -13,7 +13,7 @@ .. |command| replace:: :mc-cmd:`mc rm` .. |rewind| replace:: :mc-cmd:`~mc rm --rewind` .. |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` Syntax @@ -75,7 +75,7 @@ results to the ``rm`` commandline tool. :end-before: end-minio-syntax :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 @@ -232,7 +232,7 @@ Parameters :mc-cmd:`~mc rm --fake` flag to validate the scope of the recursive delete operation. - Mutually exclusive with :mc-cmd:`mc rm version-id` + Mutually exclusive with :mc-cmd:`mc rm --version-id` .. mc-cmd:: --rewind @@ -257,7 +257,7 @@ Parameters :mc-cmd:`~mc rm --rewind` together to remove all 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 @@ -395,7 +395,7 @@ that marks an object as deleted while retaining all previous versions of that object. - 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 :mc-cmd:`mc rm --versions` diff --git a/source/reference/minio-mc/mc-share-download.rst b/source/reference/minio-mc/mc-share-download.rst index 89e211b7..ccdabda4 100644 --- a/source/reference/minio-mc/mc-share-download.rst +++ b/source/reference/minio-mc/mc-share-download.rst @@ -11,7 +11,7 @@ .. mc:: 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` Syntax @@ -110,7 +110,7 @@ Parameters 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 diff --git a/source/reference/minio-mc/mc-sql.rst b/source/reference/minio-mc/mc-sql.rst index bf4df1cf..1c30674c 100644 --- a/source/reference/minio-mc/mc-sql.rst +++ b/source/reference/minio-mc/mc-sql.rst @@ -115,7 +115,7 @@ Parameters See the S3 API :s3-api:`CSVOutput ` for more information. -.. mc-cmd:: csv-output-header +.. mc-cmd:: --csv-output-header *Optional* The header row of the ``.csv`` output file. Specify a string of diff --git a/source/reference/minio-mc/mc-stat.rst b/source/reference/minio-mc/mc-stat.rst index e1f92be2..d6781bd5 100644 --- a/source/reference/minio-mc/mc-stat.rst +++ b/source/reference/minio-mc/mc-stat.rst @@ -13,7 +13,7 @@ .. |command| replace:: :mc-cmd:`mc stat` .. |rewind| replace:: :mc-cmd:`~mc stat --rewind` .. |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` Syntax @@ -61,7 +61,7 @@ results to the ``stat`` commandline tool. :start-after: start-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 @@ -137,7 +137,7 @@ Parameters :mc-cmd:`~mc stat --rewind` together to remove all 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 diff --git a/source/reference/minio-mc/mc-tag-list.rst b/source/reference/minio-mc/mc-tag-list.rst index b7140226..d4a59e22 100644 --- a/source/reference/minio-mc/mc-tag-list.rst +++ b/source/reference/minio-mc/mc-tag-list.rst @@ -15,7 +15,7 @@ .. |command| replace:: :mc-cmd:`mc tag list` .. |rewind| replace:: :mc-cmd:`~mc tag list --rewind` .. |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` Syntax @@ -56,7 +56,7 @@ The :mc:`mc tag list` command lists all tags from a bucket or object. :start-after: start-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. Parameters @@ -90,7 +90,7 @@ Parameters :mc-cmd:`~mc tag list --rewind` together to list tags from all 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 diff --git a/source/reference/minio-mc/mc-tag-remove.rst b/source/reference/minio-mc/mc-tag-remove.rst index 73b16fd1..40875df4 100644 --- a/source/reference/minio-mc/mc-tag-remove.rst +++ b/source/reference/minio-mc/mc-tag-remove.rst @@ -15,7 +15,7 @@ .. |command| replace:: :mc-cmd:`mc tag remove` .. |rewind| replace:: :mc-cmd:`~mc tag remove --rewind` .. |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` Syntax @@ -55,7 +55,7 @@ The :mc:`mc tag remove` command removes all tags from a bucket or object. :start-after: start-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. Parameters @@ -89,7 +89,7 @@ Parameters :mc-cmd:`~mc tag remove --rewind` together to remove tags from all 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 diff --git a/source/reference/minio-server/minio-server.rst b/source/reference/minio-server/minio-server.rst index 32f5073f..a9345bc6 100644 --- a/source/reference/minio-server/minio-server.rst +++ b/source/reference/minio-server/minio-server.rst @@ -156,7 +156,7 @@ The command accepts the following arguments: Omit to direct MinIO to generate a dynamic port at server startup. The 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 diff --git a/source/replication/enable-server-side-multi-site-bucket-replication.rst b/source/replication/enable-server-side-multi-site-bucket-replication.rst index 6d54f9e5..c1aa5001 100644 --- a/source/replication/enable-server-side-multi-site-bucket-replication.rst +++ b/source/replication/enable-server-side-multi-site-bucket-replication.rst @@ -383,10 +383,10 @@ configuration. - 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 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. The command returns an ARN similar to the following. Copy this ARN for use in diff --git a/source/replication/enable-server-side-one-way-bucket-replication.rst b/source/replication/enable-server-side-one-way-bucket-replication.rst index 720ad3ab..8e404651 100644 --- a/source/replication/enable-server-side-one-way-bucket-replication.rst +++ b/source/replication/enable-server-side-one-way-bucket-replication.rst @@ -335,10 +335,10 @@ bucket. - Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the ``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 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. 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 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. \ No newline at end of file diff --git a/source/replication/enable-server-side-two-way-bucket-replication.rst b/source/replication/enable-server-side-two-way-bucket-replication.rst index 8794250e..87cb0c43 100644 --- a/source/replication/enable-server-side-two-way-bucket-replication.rst +++ b/source/replication/enable-server-side-two-way-bucket-replication.rst @@ -371,10 +371,10 @@ A\) Create a Replication Target for Alpha -> Baker - Replace ``DESTINATIONBUCKET`` with the name of the target bucket on the ``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 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. 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 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 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. 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 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. \ No newline at end of file diff --git a/source/replication/replication-overview.rst b/source/replication/replication-overview.rst index b18d97cf..de80c732 100644 --- a/source/replication/replication-overview.rst +++ b/source/replication/replication-overview.rst @@ -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 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 ~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/sdk/java/API.md b/source/sdk/java/API.md index ea13fd9e..de429753 100644 --- a/source/sdk/java/API.md +++ b/source/sdk/java/API.md @@ -1765,7 +1765,7 @@ ObjectStat objectStat = StatObjectArgs.builder() .bucket("my-bucketname") .object("my-objectname") - .versionId("version-id") + .versionId(--version-id") .build()); // Get information of a SSE-C encrypted versioned object. @@ -1774,7 +1774,7 @@ ObjectStat objectStat = StatObjectArgs.builder() .bucket("my-bucketname") .object("my-objectname") - .versionId("version-id") + .versionId(--version-id") .ssec(ssec) .build()); ``` diff --git a/source/sdk/python/API.md b/source/sdk/python/API.md index c0ffe0a3..dee24c9e 100644 --- a/source/sdk/python/API.md +++ b/source/sdk/python/API.md @@ -849,7 +849,7 @@ __Parameters__ | `length` | _int_ | Number of bytes of object data from offset. | | `request_headers` | _dict_ | Any additional headers to be added with GET request. | | `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. | __Return Value__ @@ -869,7 +869,7 @@ finally: response.close() response.release_conn() -# Get data of an object of version-ID. +# Get data of an object of --version-id. try: response = client.get_object( "my-bucket", "my-object", @@ -954,7 +954,7 @@ __Parameters__ | `file_path` | _str_ | Name of file to download. | | `request_headers` | _dict_ | Any additional headers to be added with GET request. | | `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. | | `tmp_file_path` | _str_ | Path to a temporary file. | @@ -970,7 +970,7 @@ __Example__ # Download data of an object. 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( "my-bucket", "my-object", "my-filename", version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d", @@ -1144,7 +1144,7 @@ result = client.put_object( "my-bucket", "my-object", io.BytesIO(b"hello"), 5, ) 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, ), ) @@ -1157,7 +1157,7 @@ result = client.put_object( "my-bucket", "my-object", data, length=-1, part_size=10*1024*1024, ) 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, ), ) @@ -1168,7 +1168,7 @@ result = client.put_object( content_type="application/csv", ) 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, ), ) @@ -1179,7 +1179,7 @@ result = client.put_object( metadata={"My-Project": "one"}, ) 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, ), ) @@ -1190,7 +1190,7 @@ result = client.put_object( sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"), ) 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, ), ) @@ -1201,7 +1201,7 @@ result = client.put_object( sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}), ) 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, ), ) @@ -1212,7 +1212,7 @@ result = client.put_object( sse=SseS3(), ) 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, ), ) @@ -1230,7 +1230,7 @@ result = client.put_object( legal_hold=True, ) 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, ), ) @@ -1241,7 +1241,7 @@ result = client.put_object( progress=Progress(), ) 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, ), ) @@ -1281,7 +1281,7 @@ result = client.fput_object( "my-bucket", "my-object", "my-filename", ) 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, ), ) @@ -1292,7 +1292,7 @@ result = client.fput_object( content_type="application/csv", ) 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, ), ) @@ -1303,7 +1303,7 @@ result = client.fput_object( metadata={"My-Project": "one"}, ) 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, ), ) @@ -1314,7 +1314,7 @@ result = client.fput_object( sse=SseCustomerKey(b"32byteslongsecretkeymustprovided"), ) 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, ), ) @@ -1325,7 +1325,7 @@ result = client.fput_object( sse=SseKMS("KMS-KEY-ID", {"Key1": "Value1", "Key2": "Value2"}), ) 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, ), ) @@ -1336,7 +1336,7 @@ result = client.fput_object( sse=SseS3(), ) 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, ), ) @@ -1354,7 +1354,7 @@ result = client.fput_object( legal_hold=True, ) 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, ), ) @@ -1365,7 +1365,7 @@ result = client.fput_object( progress=Progress(), ) 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, ), ) @@ -1404,7 +1404,7 @@ print( ), ) -# Get object information of version-ID. +# Get object information of --version-id. result = client.stat_object( "my-bucket", "my-object", version_id="dfbd25b3-abec-4184-a4e8-5a35a5c1174d", diff --git a/source/security/ad-ldap-external-identity-management/external-authentication-with-ad-ldap-identity-provider.rst b/source/security/ad-ldap-external-identity-management/external-authentication-with-ad-ldap-identity-provider.rst index 8575f914..f2dad3c4 100644 --- a/source/security/ad-ldap-external-identity-management/external-authentication-with-ad-ldap-identity-provider.rst +++ b/source/security/ad-ldap-external-identity-management/external-authentication-with-ad-ldap-identity-provider.rst @@ -191,8 +191,8 @@ For example, consider the following policy assignments: .. code-block:: shell - 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 --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' - MinIO would assign an authenticated user with DN matching ``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 - 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 --consoleAdmin group='cn=ops,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 ``cn=ops,cn=groups,dc=example,dc=com`` AD/LDAP group the diff --git a/source/security/network-encryption/minio-tls.rst b/source/security/network-encryption/minio-tls.rst index 358ff192..3cab1c72 100644 --- a/source/security/network-encryption/minio-tls.rst +++ b/source/security/network-encryption/minio-tls.rst @@ -40,7 +40,7 @@ appropriate TLS certificate for that hostname. MinIO by default searches an OS-specific directory for TLS keys and 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. .. 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 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. .. tab-set:: diff --git a/sphinxext/cond.py b/sphinxext/cond.py new file mode 100644 index 00000000..72115b6e --- /dev/null +++ b/sphinxext/cond.py @@ -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, + }