minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

Final pass on platformization (#555)

Browse Source
This commit is contained in:
Ravind Kumar
2022-09-16 16:40:20 -04:00
committed by GitHub
parent 5efcffbff1
commit d815aa9ce8
144 changed files with 1510 additions and 1102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
source/reference/minio-mc-admin.rst
View File

@ -14,9 +14,9 @@ The MinIO Client :mc-cmd:`mc` command line tool provides The command
command for performing administrative tasks on your MinIO deployments.
While :mc-cmd:`mc` supports any S3-compatible service,
:mc-cmd:`mc admin` *only* supports MinIO deployments.
:mc:`mc admin` *only* supports MinIO deployments.
:mc-cmd:`mc admin` has the following syntax:
:mc:`mc admin` has the following syntax:
.. code-block:: shell
@ -25,7 +25,7 @@ While :mc-cmd:`mc` supports any S3-compatible service,
Command Quick reference
-----------------------
The following table lists :mc-cmd:`mc admin` commands:
The following table lists :mc:`mc admin` commands:
.. list-table::
:header-rows: 1
@ -35,17 +35,22 @@ The following table lists :mc-cmd:`mc admin` commands:
* - Command
- Description
* - :mc:`mc admin bucket remote`
* - :mc-cmd:`mc admin bucket remote`
- .. include:: /reference/minio-mc-admin/mc-admin-bucket-remote.rst
:start-after: start-mc-admin-bucket-remote-desc
:end-before: end-mc-admin-bucket-remote-desc
* - :mc:`mc admin bucket quota`
* - :mc-cmd:`mc admin bucket quota`
- .. include:: /reference/minio-mc-admin/mc-admin-bucket-quota.rst
:start-after: start-mc-admin-bucket-quota-desc
:end-before: end-mc-admin-bucket-quota-desc
* - :mc:`mc admin decommission`
* - :mc-cmd:`mc admin console`
- .. include:: /reference/minio-mc-admin/mc-admin-console.rst
:start-after: start-mc-admin-console-desc
:end-before: end-mc-admin-console-desc
* - :mc-cmd:`mc admin decommission`
- .. include:: /reference/minio-mc-admin/mc-admin-decommission.rst
:start-after: start-mc-admin-decommission-desc
:end-before: end-mc-admin-decommission-desc
@ -55,22 +60,22 @@ The following table lists :mc-cmd:`mc admin` commands:
:start-after: start-mc-admin-group-desc
:end-before: end-mc-admin-group-desc
* - :mc:`mc admin heal`
* - :mc-cmd:`mc admin heal`
- .. include:: /reference/minio-mc-admin/mc-admin-heal.rst
:start-after: start-mc-admin-heal-desc
:end-before: end-mc-admin-heal-desc
* - :mc:`mc admin info`
* - :mc-cmd:`mc admin info`
- .. include:: /reference/minio-mc-admin/mc-admin-info.rst
:start-after: start-mc-admin-info-desc
:end-before: end-mc-admin-info-desc
* - :mc:`mc admin kms key`
* - :mc-cmd:`mc admin kms key`
- .. include:: /reference/minio-mc-admin/mc-admin-kms-key.rst
:start-after: start-mc-admin-kms-key-desc
:end-before: end-mc-admin-kms-key-desc
* - :mc:`mc admin obd`
* - :mc-cmd:`mc admin obd`
- .. include:: /reference/minio-mc-admin/mc-admin-obd.rst
:start-after: start-mc-admin-obd-desc
:end-before: end-mc-admin-obd-desc
@ -80,27 +85,27 @@ The following table lists :mc-cmd:`mc admin` commands:
:start-after: start-mc-admin-policy-desc
:end-before: end-mc-admin-policy-desc
* - :mc:`mc admin profile`
* - :mc-cmd:`mc admin profile`
- .. include:: /reference/minio-mc-admin/mc-admin-profile.rst
:start-after: start-mc-admin-profile-desc
:end-before: end-mc-admin-profile-desc
* - :mc:`mc admin prometheus`
* - :mc-cmd:`mc admin prometheus`
- .. include:: /reference/minio-mc-admin/mc-admin-prometheus.rst
:start-after: start-mc-admin-prometheus-desc
:end-before: end-mc-admin-prometheus-desc
* - :mc:`mc admin replicate`
* - :mc-cmd:`mc admin replicate`
- .. include:: /reference/minio-mc-admin/mc-admin-replicate.rst
:start-after: start-mc-admin-replicate-desc
:end-before: end-mc-admin-replicate-desc
* - :mc:`mc admin service`
* - :mc-cmd:`mc admin service`
- .. include:: /reference/minio-mc-admin/mc-admin-service.rst
:start-after: start-mc-admin-service-desc
:end-before: end-mc-admin-service-desc
* - :mc:`mc admin speedtest`
* - :mc-cmd:`mc admin speedtest`
- .. include:: /reference/minio-mc-admin/mc-admin-speedtest.rst
:start-after: start-mc-admin-speedtest-desc
:end-before: end-mc-admin-speedtest-desc
@ -110,17 +115,17 @@ The following table lists :mc-cmd:`mc admin` commands:
:start-after: start-mc-admin-tier-desc
:end-before: end-mc-admin-tier-desc
* - :mc:`mc admin top`
* - :mc-cmd:`mc admin top`
- .. include:: /reference/minio-mc-admin/mc-admin-top.rst
:start-after: start-mc-admin-top-desc
:end-before: end-mc-admin-top-desc
* - :mc:`mc admin trace`
* - :mc-cmd:`mc admin trace`
- .. include:: /reference/minio-mc-admin/mc-admin-trace.rst
:start-after: start-mc-admin-trace-desc
:end-before: end-mc-admin-trace-desc
* - :mc:`mc admin update`
* - :mc-cmd:`mc admin update`
- .. include:: /reference/minio-mc-admin/mc-admin-update.rst
:start-after: start-mc-admin-update-desc
:end-before: end-mc-admin-update-desc
@ -130,7 +135,7 @@ The following table lists :mc-cmd:`mc admin` commands:
:start-after: start-mc-admin-user-desc
:end-before: end-mc-admin-user-desc
* - :mc:`mc admin user`
* - :mc:`mc admin user svcacct`
- .. include:: /reference/minio-mc-admin/mc-admin-user-svcacct.rst
:start-after: start-mc-admin-user-svcacct-desc
:end-before: end-mc-admin-user-svcacct-desc
@ -156,7 +161,7 @@ Ensure that the host machine has :mc:`mc`
security best practices for your operating system for inputting sensitive
information on the command line.
Use the :mc-cmd:`mc alias set` command to add the
Use the :mc:`mc alias set` command to add the
deployment to the :program:`mc` configuration.
.. code-block:: shell
@ -181,7 +186,7 @@ the newly added MinIO deployment:
Global Options
--------------
:mc-cmd:`mc admin` supports the same global options as
:mc:`mc admin` supports the same global options as
:mc-cmd:`mc`. See :ref:`minio-mc-global-options`.
.. toctree::

6
source/reference/minio-mc-admin/mc-admin-bucket-quota.rst
View File

@ -76,7 +76,7 @@ Examples
Configure a Hard Quota on a Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc admin bucket quota` with the
Use :mc-cmd:`mc admin bucket quota` with the
:mc-cmd:`~mc admin bucket quota --hard` flag to specify a hard quota
on a bucket. Hard quotas prevent the bucket size from growing past the specified
limit.
@ -97,7 +97,7 @@ limit.
Retrieve Bucket Quota Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc admin bucket quota` to retrieve the current quota configuration
Use :mc-cmd:`mc admin bucket quota` to retrieve the current quota configuration
for a bucket:
.. code-block:: shell
@ -112,7 +112,7 @@ retrieve the quota.
Clear Configured Bucket Quota
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc admin bucket quota` with the
Use :mc-cmd:`mc admin bucket quota` with the
:mc-cmd:`~mc admin bucket quota --clear` flag to clear all quotas from
a bucket.

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

@ -34,7 +34,7 @@ Add a New Replication Target
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin bucket remote add` to create a new replication target
ARN for use with :mc-cmd:`mc replicate add`:
ARN for use with :mc:`mc replicate add`:
.. code-block:: shell
:class: copyable

2
source/reference/minio-mc-admin/mc-admin-config.rst
View File

@ -17,7 +17,7 @@ Description
.. start-mc-admin-config-desc
The :mc-cmd:`mc admin config` command manages configuration settings for the
The :mc:`mc admin config` command manages configuration settings for the
:mc:`minio` server.
.. end-mc-admin-bucket-remote-desc

6
source/reference/minio-mc-admin/mc-admin-console.rst
View File

@ -15,7 +15,7 @@ Description
.. start-mc-admin-console-desc
The :mc-cmd:`mc admin console` command returns server log entries for each
The :mc:`mc admin console` command returns server log entries for each
MinIO server in the deployment.
.. end-mc-admin-console-desc
@ -31,14 +31,14 @@ MinIO server in the deployment.
Syntax
------
:mc-cmd:`mc admin console` has the following syntax:
:mc:`mc admin console` has the following syntax:
.. code-block:: shell
:class: copyable
mc admin console [FLAGS] TARGET NODENAME
:mc-cmd:`mc admin console` supports the following:
:mc:`mc admin console` supports the following:
.. mc-cmd:: TARGET

2
source/reference/minio-mc-admin/mc-admin-decommission.rst
View File

@ -17,7 +17,7 @@ Syntax
.. start-mc-admin-decommission-desc
The :mc:`mc admin decommission` command starts the decommissioning process for a
The :mc-cmd:`mc admin decommission` command starts the decommissioning process for a
MinIO :ref:`server pools <minio-intro-server-pool>`. Decommissioning is designed
for removing an older server pool whose hardware is no longer sufficient or
performant compared to the pools in the deployment. MinIO automatically migrates

2
source/reference/minio-mc-admin/mc-admin-group.rst
View File

@ -15,7 +15,7 @@ Description
.. start-mc-admin-group-desc
The :mc-cmd:`mc admin group` command manages groups on a MinIO deployment.
The :mc:`mc admin group` command manages groups on a MinIO deployment.
.. end-mc-admin-group-desc

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

@ -15,12 +15,12 @@ Description
.. start-mc-admin-heal-desc
The :mc:`mc admin heal` command scans for objects that are damaged or
The :mc-cmd:`mc admin heal` command scans for objects that are damaged or
corrupted and heals those objects.
.. end-mc-admin-heal-desc
:mc:`mc admin heal` is resource intensive and typically not required even
:mc-cmd:`mc admin heal` is resource intensive and typically not required even
after disk failures or corruption events. Instead, MinIO automatically heals
objects damaged by silent bit rot corruption, disk failure, or other issues on
POST/GET. MinIO also performs periodic background object healing.
@ -35,14 +35,14 @@ POST/GET. MinIO also performs periodic background object healing.
Syntax
------
:mc:`mc admin heal` has the following syntax:
:mc-cmd:`mc admin heal` has the following syntax:
.. code-block:: shell
:class: copyable
mc admin heal [FLAGS] TARGET
:mc:`mc admin heal` supports the following arguments:
:mc-cmd:`mc admin heal` supports the following arguments:
.. mc-cmd:: TARGET

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

@ -15,8 +15,8 @@ Description
.. start-mc-admin-info-desc
The :mc:`mc admin info` command displays information on a MinIO server.
For distributed MinIO deployments, :mc:`mc admin info` displays information
The :mc-cmd:`mc admin info` command displays information on a MinIO server.
For distributed MinIO deployments, :mc-cmd:`mc admin info` displays information
for each MinIO server in the deployment.
.. end-mc-admin-info-desc

10
source/reference/minio-mc-admin/mc-admin-obd.rst
View File

@ -15,23 +15,23 @@ Description
.. start-mc-admin-obd-desc
The :mc:`mc admin obd` command generates detailed diagnostics for the
The :mc-cmd:`mc admin obd` command generates detailed diagnostics for the
target MinIO deployment as a ``GZIP`` compressed ``JSON`` file. MinIO Support
may request the output of :mc:`mc admin obd` as part of troubleshooting
may request the output of :mc-cmd:`mc admin obd` as part of troubleshooting
and diagnostics.
.. end-mc-admin-obd-desc
:mc:`mc admin obd` names the file using the following pattern:
:mc-cmd:`mc admin obd` names the file using the following pattern:
.. code-block:: none
alias-health_YYYYMMDDHHMMSS.json.gzip
The ``alias`` is the :mc-cmd:`~mc admin obd TARGET` MinIO deployment from which
:mc:`mc admin obd` returned the diagnostics.
:mc-cmd:`mc admin obd` returned the diagnostics.
The :mc:`mc admin obd` output may contain sensitive information about your
The :mc-cmd:`mc admin obd` output may contain sensitive information about your
environment. Exercise all possible precautions, such as redacting sensitive
fields, prior to sharing the data on any public forum.

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

@ -15,7 +15,7 @@ Description
.. start-mc-admin-policy-desc
The :mc-cmd:`mc admin policy` command manages policies for use with MinIO
The :mc:`mc admin policy` command manages policies for use with MinIO
Policy-Based Access Control (PBAC). MinIO PBAC uses IAM-compatible policy JSON
documents to define rules for accessing resources on a MinIO server.

6
source/reference/minio-mc-admin/mc-admin-replicate.rst
View File

@ -17,7 +17,7 @@ Description
.. start-mc-admin-replicate-desc
The :mc:`mc admin replicate` command creates and manages :ref:`site replication <minio-site-replication-overview>` for a set of MinIO peer sites.
The :mc-cmd:`mc admin replicate` command creates and manages :ref:`site replication <minio-site-replication-overview>` for a set of MinIO peer sites.
Site replication mimics an active-active bucket replication, but for multiple MinIO deployments.
Wherever a change occurs to IAM settings, buckets, or objects across the set of sites, the change replicates across all sites in the site replication group.
@ -26,7 +26,7 @@ Wherever a change occurs to IAM settings, buckets, or objects across the set of
Where :ref:`bucket replication <minio-bucket-replication>` manages the mirroring of particular buckets or objects from one location to another within a deployment or across deployments, site replication continuously mirrors an entire MinIO site to other sites.
:mc:`mc admin replicate` only supports site replication for :ref:`distributed deployments <deploy-minio-distributed>` when configuring site replication.
:mc-cmd:`mc admin replicate` only supports site replication for :ref:`distributed deployments <deploy-minio-distributed>` when configuring site replication.
Only one deployment can have any data when initiating a new site replication configuration.
@ -40,7 +40,7 @@ Site replication enforces :ref:`bucket versioning <minio-bucket-versioning>` on
:end-before: end-minio-only
The :mc:`mc admin replicate` command has the following subcommands:
The :mc-cmd:`mc admin replicate` command has the following subcommands:
.. list-table::
:header-rows: 1

2
source/reference/minio-mc-admin/mc-admin-trace.rst
View File

@ -31,7 +31,7 @@ request against each MinIO server in a deployment.
Example
-------
Use :mc:`mc admin trace` to perform an HTTP trace of each MinIO server in
Use :mc-cmd:`mc admin trace` to perform an HTTP trace of each MinIO server in
the deployment:
.. code-block:: shell

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

@ -46,7 +46,7 @@ procedures.
Examples
--------
Use :mc:`mc admin update` to update each :mc:`minio` server process in the
Use :mc-cmd:`mc admin update` to update each :mc:`minio` server process in the
MinIO deployment:
.. code-block:: shell
@ -77,7 +77,7 @@ Syntax
deployment, :mc-cmd:`mc admin update` updates *all* MinIO servers
in the deployment at the same time.
Use :mc-cmd:`mc alias list` to review the configured aliases and their
Use :mc:`mc alias list` to review the configured aliases and their
corresponding MinIO deployment endpoints.
.. mc-cmd:: MIRROR_URL

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

@ -15,9 +15,9 @@ Description
.. start-mc-admin-user-desc
The :mc-cmd:`mc admin user` command manages users on a MinIO deployment. Clients
The :mc:`mc admin user` command manages users on a MinIO deployment. Clients
*must* authenticate to the MinIO deployment with the access key and secret key
associated to a user on the deployment. MinIO users constitue a key component in
associated to a user on the deployment. MinIO users constitute a key component in
MinIO Identity and Access Management.
.. end-mc-admin-user-desc

6
source/reference/minio-mc.rst
View File

@ -63,7 +63,7 @@ the tab that corresponds to the host machine operating system or environment:
security best practices for your operating system for inputting sensitive
information on the command line.
Use the :mc-cmd:`mc alias set` command to add an Amazon S3-compatible service
Use the :mc:`mc alias set` command to add an Amazon S3-compatible service
to the :mc-cmd:`mc` :ref:`configuration <mc-configuration>`.
.. code-block:: shell
@ -297,7 +297,7 @@ The following table lists :mc-cmd:`mc` commands:
* - | :mc:`mc share download`
| :mc:`mc share upload`
| :mc:`mc share list`
- The :mc-cmd:`mc share download` and :mc-cmd:`mc share upload`
- The :mc:`mc share download` and :mc:`mc share upload`
commands generate presigned URLs for downloading and uploading
objects to a MinIO bucket.
@ -348,7 +348,7 @@ The following table lists :mc-cmd:`mc` commands:
:mc-cmd:`mc` also includes an administration extension for managing MinIO
deployments. See :mc-cmd:`mc admin` for more complete documentation.
deployments. See :mc:`mc admin` for more complete documentation.
.. _mc-configuration:

6
source/reference/minio-mc/mc-alias-list.rst
View File

@ -39,7 +39,7 @@ to each alias.
.. tab-item:: SYNTAX
The :mc-cmd:`mc alias list` command has the following syntax:
The :mc:`mc alias list` command has the following syntax:
.. code-block:: shell
@ -73,7 +73,7 @@ List All Configured Aliases
.. tab-item:: Example
The following :mc-cmd:`mc alias list` command lists all configured aliases
The following :mc:`mc alias list` command lists all configured aliases
in the local :program:`mc` configuration.
.. code-block:: shell
@ -95,7 +95,7 @@ List a Specific Alias
.. tab-item:: Example
The following :mc-cmd:`mc alias list` command lists the details of a
The following :mc:`mc alias list` command lists the details of a
specific alias in the local :program:`mc` configuration.
.. code-block:: shell

4
source/reference/minio-mc/mc-alias-remove.rst
View File

@ -36,7 +36,7 @@ The :mc:`mc alias remove` removes an existing alias from the local
.. tab-item:: SYNTAX
The :mc-cmd:`mc alias remove` command has the following syntax:
The :mc:`mc alias remove` command has the following syntax:
.. code-block:: shell
:class: copyable
@ -67,7 +67,7 @@ Examples
Remove an Alias from the ``mc`` Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc alias remove` to remove an existing alias from the
Use :mc:`mc alias remove` to remove an existing alias from the
:program:`mc` configuration:
.. tab-set::

12
source/reference/minio-mc/mc-alias-set.rst
View File

@ -15,7 +15,7 @@
.. mc:: mc alias
.. mc:: mc alias set
.. |command| replace:: :mc-cmd:`mc alias set`
.. |command| replace:: :mc:`mc alias set`
Syntax
------
@ -46,7 +46,7 @@ The :mc:`mc alias set` command adds or updates an alias to the local
.. tab-item:: SYNTAX
The :mc-cmd:`mc alias set` command has the following syntax:
The :mc:`mc alias set` command has the following syntax:
.. code-block:: shell
:class: copyable
@ -103,7 +103,7 @@ Parameters
AWS Signature V2 is considered
`deprecated <https://aws.amazon.com/blogs/aws/amazon-s3-update-sigv2-deprecation-period-extended-modified/>`__
by AWS. :mc-cmd:`mc alias set` includes this option only for S3 buckets
by AWS. :mc:`mc alias set` includes this option only for S3 buckets
or services still reliant on the Signature V2.
Use ``S3v4`` unless explicitly required by the S3-compatible service.
@ -135,7 +135,7 @@ Examples
Add or Update an Alias for a MinIO Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc alias set` to add an S3-compatible service for use with
Use :mc:`mc alias set` to add an S3-compatible service for use with
:program:`mc`:
.. tab-set::
@ -153,7 +153,7 @@ Use :mc-cmd:`mc alias set` to add an S3-compatible service for use with
mc alias set myminio https://minio.example.net miniouser miniopassword
If the ``myminio`` alias already exists, the
:mc-cmd:`mc alias set` command overwrites that alias with the specified
:mc:`mc alias set` command overwrites that alias with the specified
arguments.
.. tab-item:: Syntax
@ -186,7 +186,7 @@ S3 Compatibility
Required Credentials and Access Control
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:mc-cmd:`mc alias set` requires specifying an access key and corresponding
:mc:`mc alias set` requires specifying an access key and corresponding
secret key for the S3-compatible host. :program:`mc` functionality is limited
based on the policies associated to the specified credentials. For example, if
the specified credentials do not have read/write access to a specific bucket,

4
source/reference/minio-mc/mc-cat.rst
View File

@ -14,7 +14,7 @@
.. Replacement substitutions
.. |command| replace:: :mc-cmd:`mc cat`
.. |command| replace:: :mc:`mc cat`
.. |rewind| replace:: :mc-cmd:`~mc cat --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cat --version-id`
.. |alias| replace:: :mc-cmd:`~mc cat ALIAS`
@ -134,7 +134,7 @@ Examples
View an S3 Object
~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cat` to return the object:
Use :mc:`mc cat` to return the object:
.. code-block:: shell
:class: copyable

10
source/reference/minio-mc/mc-cp.rst
View File

@ -12,7 +12,7 @@
.. mc:: mc cp
.. |command| replace:: :mc-cmd:`mc cp`
.. |command| replace:: :mc:`mc cp`
.. |rewind| replace:: :mc-cmd:`~mc cp --rewind`
.. |versionid| replace:: :mc-cmd:`~mc cp --version-id`
.. |alias| replace:: :mc-cmd:`~mc cp SOURCE`
@ -89,7 +89,7 @@ Parameters
mc cp play/mybucket/object.txt ~/mydata/object.txt
Specify multiple ``SOURCE`` paths to copy multiple objects to the
specified :mc-cmd:`~mc cp TARGET`. :mc-cmd:`mc cp` treats the
specified :mc-cmd:`~mc cp TARGET`. :mc:`mc cp` treats the
*last* specified alias or filesystem path as the ``TARGET``. For example:
.. code-block:: none
@ -292,7 +292,7 @@ Examples
Copy Object to S3
~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc cp` to copy an object to an S3-compatible host:
Use :mc:`mc cp` to copy an object to an S3-compatible host:
.. tab-set::
@ -355,7 +355,7 @@ S3-compatible host:
of a configured S3-compatible host.
- Replace :mc-cmd:`PATH <mc cp TARGET>` with the path to the object on
the S3-compatible host. :mc-cmd:`mc cp` uses the ``SOURCE`` filenames
the S3-compatible host. :mc:`mc cp` uses the ``SOURCE`` filenames
when creating the objects on the target host.
.. tab-item:: S3 to S3
@ -375,7 +375,7 @@ S3-compatible host:
:mc:`alias <mc alias>` of a target S3-compatible host.
- Replace :mc-cmd:`TGTPATH <mc cp TARGET>` with the path to the
object on the target S3-compatible host. :mc-cmd:`mc cp` uses the
object on the target S3-compatible host. :mc:`mc cp` uses the
``SRCPATH`` object names when creating objects on the target
host.

2
source/reference/minio-mc/mc-event-add.rst
View File

@ -183,7 +183,7 @@ Behavior
Supported Bucket Events
~~~~~~~~~~~~~~~~~~~~~~~
The following table lists the supported :mc-cmd:`mc event add` values and their
The following table lists the supported :mc:`mc event add` values and their
corresponding :ref:`S3 events <minio-bucket-notifications-event-types>`:
.. list-table::

2
source/reference/minio-mc/mc-find.rst
View File

@ -84,7 +84,7 @@ Parameters
mc find ~/mydata/
Issuing :mc-cmd:`mc find ALIAS` with no other arguments returns a list of
*all* objects or files at the specified path, similar to :mc-cmd:`mc ls`.
*all* objects or files at the specified path, similar to :mc:`mc ls`.
.. mc-cmd:: --exec

4
source/reference/minio-mc/mc-head.rst
View File

@ -13,7 +13,7 @@
.. mc:: mc head
.. |command| replace:: :mc-cmd:`mc head`
.. |command| replace:: :mc:`mc head`
.. |rewind| replace:: :mc-cmd:`~mc head --rewind`
.. |versionid| replace:: :mc-cmd:`~mc head --version-id`
.. |alias| replace:: :mc-cmd:`~mc head ALIAS`
@ -143,7 +143,7 @@ Examples
View Partial Contents of an Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc head` to return the first 10 lines of an object:
Use :mc:`mc head` to return the first 10 lines of an object:
.. code-block:: shell
:class: copyable

8
source/reference/minio-mc/mc-ilm-add.rst
View File

@ -167,7 +167,7 @@ Parameters
*Required* The remote storage tier to which MinIO
:ref:`transition objects <minio-lifecycle-management-tiering>`.
Specify a remote storage tier created by :mc-cmd:`mc admin tier`.
Specify a remote storage tier created by :mc:`mc admin tier`.
Required if specifying :mc-cmd:`~mc ilm add --transition-days`.
@ -225,7 +225,7 @@ Parameters
*Optional* The remote storage tier to which MinIO
:ref:`transitions noncurrent objects versions
<minio-lifecycle-management-tiering>`. Specify a remote storage tier created
by :mc-cmd:`mc admin tier`.
by :mc:`mc admin tier`.
Global Flags
@ -241,7 +241,7 @@ Examples
Expire Bucket Contents After Number of Days
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc ilm add` with :mc-cmd:`~mc ilm add --expiry-days` to
Use :mc:`mc ilm add` with :mc-cmd:`~mc ilm add --expiry-days` to
expire bucket contents a number of days after object creation:
.. code-block:: shell
@ -276,7 +276,7 @@ Expiry vs Transition
MinIO supports specifying both expiry and transition rules in the same
bucket or bucket prefix. MinIO can execute an expiration rule on an object
regardless of its transition status. Use
:mc-cmd:`mc ilm ls` to review the currently configured object lifecycle
:mc:`mc ilm ls` to review the currently configured object lifecycle
management rules for any potential interactions between expiry and transition
rules.

8
source/reference/minio-mc/mc-ilm-edit.rst
View File

@ -82,7 +82,7 @@ Parameters
.. mc-cmd:: --id
*Required* The unique ID of the rule. Use :mc-cmd:`mc ilm ls` to list bucket
*Required* The unique ID of the rule. Use :mc:`mc ilm ls` to list bucket
rules and retrieve the ``id`` for the rule you want to modify.
.. mc-cmd:: --expiry-days
@ -173,7 +173,7 @@ Parameters
*Optional* The remote storage tier to which MinIO
:ref:`transitions noncurrent objects versions
<minio-lifecycle-management-tiering>`. Specify a remote storage tier created
by :mc-cmd:`mc admin tier`.
by :mc:`mc admin tier`.
MinIO does *not* automatically migrate objects from the previously
specified remote tier to the new remote tier. MinIO continues to
@ -214,7 +214,7 @@ Parameters
*Optional* The remote storage tier to which MinIO
:ref:`transition objects <minio-lifecycle-management-tiering>`. Specify a
remote storage tier created by :mc-cmd:`mc admin tier`.
remote storage tier created by :mc:`mc admin tier`.
Required if specifying :mc-cmd:`~mc ilm edit --transition-days`.
@ -235,7 +235,7 @@ Examples
Modify an Existing Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc ilm edit` with :mc-cmd:`~mc ilm edit --id` to modify
Use :mc:`mc ilm edit` with :mc-cmd:`~mc ilm edit --id` to modify
an existing object expiration rule:
.. code-block:: shell

2
source/reference/minio-mc/mc-ilm-import.rst
View File

@ -115,7 +115,7 @@ Behavior
Importing Configuration Overrides Existing Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:mc-cmd:`mc ilm import` replaces the current bucket lifecycle management
:mc:`mc ilm import` replaces the current bucket lifecycle management
rules with those defined in the imported JSON configuration.
S3 Compatibility

8
source/reference/minio-mc/mc-ilm-ls.rst
View File

@ -36,7 +36,7 @@ rules on a MinIO bucket.
.. tab-item:: SYNTAX
The :mc-cmd:`mc ilm ls` command has the following syntax:
The :mc:`mc ilm ls` command has the following syntax:
.. code-block:: shell
:class: copyable
@ -65,7 +65,7 @@ Parameters
.. mc-cmd:: --expiry
*Optional* :mc-cmd:`mc ilm ls` returns only fields related to lifecycle rule
*Optional* :mc:`mc ilm ls` returns only fields related to lifecycle rule
expiration.
Mutually exclusive with :mc-cmd:`~mc ilm ls --transition`.
@ -73,7 +73,7 @@ Parameters
.. mc-cmd:: --transition
*Optional* :mc-cmd:`mc ilm ls` returns only fields related to lifecycle rule
*Optional* :mc:`mc ilm ls` returns only fields related to lifecycle rule
transition.
Mutually exclusive with :mc-cmd:`~mc ilm ls --expiry`.
@ -92,7 +92,7 @@ Examples
List Bucket Lifecycle Management Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc ilm ls` to list a bucket's lifecycle management rules:
Use :mc:`mc ilm ls` to list a bucket's lifecycle management rules:
.. code-block:: shell
:class: copyable

10
source/reference/minio-mc/mc-ilm-rm.rst
View File

@ -65,9 +65,9 @@ Parameters
.. mc-cmd:: all
*Required* Removes all rules in the bucket. Mutually exclusive with
:mc-cmd:`mc ilm rm id`.
:mc:`mc ilm rm id`.
Mutually exclusive with :mc-cmd:`mc ilm rm id`
Mutually exclusive with :mc:`mc ilm rm id`
Requires including :mc-cmd:`~mc ilm rm force`.
@ -77,10 +77,10 @@ Parameters
.. mc-cmd:: id
*Required* The unique ID of the rule. Use :mc-cmd:`mc ilm ls` to list bucket
*Required* The unique ID of the rule. Use :mc:`mc ilm ls` to list bucket
rules and retrieve the ``id`` for the rule you want to remove.
Mutually exclusive with :mc-cmd:`mc ilm rm all`
Mutually exclusive with :mc:`mc ilm rm all`
Global Flags
~~~~~~~~~~~~
@ -95,7 +95,7 @@ Examples
Remove a Bucket Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc ilm rm` to remove a bucket lifecycle management rule:
Use :mc:`mc ilm rm` to remove a bucket lifecycle management rule:
.. code-block:: shell
:class: copyable

4
source/reference/minio-mc/mc-legalhold-clear.rst
View File

@ -12,7 +12,7 @@
.. mc:: mc legalhold clear
.. |command| replace:: :mc-cmd:`mc legalhold clear`
.. |command| replace:: :mc:`mc legalhold clear`
.. |rewind| replace:: :mc-cmd:`~mc legalhold clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold clear --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold clear ALIAS`
@ -107,7 +107,7 @@ Examples
Retrieve the Legal Hold Status Objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc legalhold clear` to retrieve the legal hold status of an object.
Use :mc:`mc legalhold clear` to retrieve the legal hold status of an object.
Include :mc-cmd:`~mc legalhold clear --recursive` to return the legal hold
status of the contents of a bucket:

4
source/reference/minio-mc/mc-legalhold-info.rst
View File

@ -12,7 +12,7 @@
.. mc:: mc legalhold info
.. |command| replace:: :mc-cmd:`mc legalhold info`
.. |command| replace:: :mc:`mc legalhold info`
.. |rewind| replace:: :mc-cmd:`~mc legalhold info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold info --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold info ALIAS`
@ -106,7 +106,7 @@ Examples
Retrieve the Legal Hold Status Objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc legalhold info` to retrieve the legal hold status of an object.
Use :mc:`mc legalhold info` to retrieve the legal hold status of an object.
Include :mc-cmd:`~mc legalhold info --recursive` to return the legal hold
status of the contents of a bucket:

4
source/reference/minio-mc/mc-legalhold-set.rst
View File

@ -13,7 +13,7 @@
.. mc:: mc legalhold
.. mc:: mc legalhold set
.. |command| replace:: :mc-cmd:`mc legalhold set`
.. |command| replace:: :mc:`mc legalhold set`
.. |rewind| replace:: :mc-cmd:`~mc legalhold set --rewind`
.. |versionid| replace:: :mc-cmd:`~mc legalhold set --version-id`
.. |alias| replace:: :mc-cmd:`~mc legalhold set ALIAS`
@ -105,7 +105,7 @@ Global Flags
Examples
--------
Use :mc-cmd:`mc legalhold set` to enable legal hold on objects:
Use :mc:`mc legalhold set` to enable legal hold on objects:
.. code-block:: shell
:class: copyable

2
source/reference/minio-mc/mc-ls.rst
View File

@ -12,7 +12,7 @@
.. Replacement substitutions
.. |command| replace:: :mc-cmd:`mc ls`
.. |command| replace:: :mc:`mc ls`
.. |rewind| replace:: :mc-cmd:`~mc ls --rewind`
.. |versions| replace:: :mc-cmd:`~mc ls --versions`
.. |alias| replace:: :mc-cmd:`~mc ls ALIAS`

2
source/reference/minio-mc/mc-mb.rst
View File

@ -79,7 +79,7 @@ Parameters
.. mc-cmd:: --ignore-existing, p
Directs :mc-cmd:`mc mb` to do nothing if the bucket or directory already
Directs :mc:`mc mb` to do nothing if the bucket or directory already
exists.
.. mc-cmd:: --region

2
source/reference/minio-mc/mc-mirror.rst
View File

@ -88,7 +88,7 @@ Parameters
mc mirror [FLAGS] ~/data/ myminio/mybucket
If specifying a directory, :mc-cmd:`mc mirror` synchronizes all files in the directory.
If specifying a directory, :mc:`mc mirror` synchronizes all files in the directory.
.. mc-cmd:: TARGET

8
source/reference/minio-mc/mc-mv.rst
View File

@ -83,7 +83,7 @@ Parameters
mc mv ~/mydata/object.txt play/mybucket/object.txt
Specify multiple ``SOURCE`` paths to move multiple objects to the
specified :mc-cmd:`~mc mv TARGET`. :mc-cmd:`mc rm` treats the
specified :mc-cmd:`~mc mv TARGET`. :mc:`mc rm` treats the
*last* specified alias or filesystem path as the ``TARGET``. For example:
.. code-block:: shell
@ -121,8 +121,8 @@ Parameters
The ``TARGET`` object name can differ from the ``SOURCE`` to
"rename" the object as part of the move operation.
If running :mc-cmd:`mc mv` with the :mc-cmd:`~mc mv --recursive` option,
:mc-cmd:`mc mv` treats the ``TARGET`` as the bucket prefix for all
If running :mc:`mc mv` with the :mc-cmd:`~mc mv --recursive` option,
:mc:`mc mv` treats the ``TARGET`` as the bucket prefix for all
objects at the ``SOURCE``.
.. mc-cmd:: --attr
@ -355,7 +355,7 @@ move operation from the point of failure.
MinIO Trims Empty Prefixes on Object Removal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. |command| replace:: :mc-cmd:`mc mv`
.. |command| replace:: :mc:`mc mv`
.. include:: /includes/common-admonitions.rst
:start-after: start-remove-api-trims-prefixes

2
source/reference/minio-mc/mc-policy-get.rst
View File

@ -84,7 +84,7 @@ Examples
Get Anonymous Policy for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc policy get` to get the anonymous policy for a
Use :mc:`mc policy get` to get the anonymous policy for a
bucket:
.. code-block:: shell

2
source/reference/minio-mc/mc-policy-links.rst
View File

@ -87,7 +87,7 @@ Examples
List Anonymous Policies for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc policy links` to links the anonymous policies for a
Use :mc:`mc policy links` to links the anonymous policies for a
bucket:
.. code-block:: shell

2
source/reference/minio-mc/mc-policy-list.rst
View File

@ -81,7 +81,7 @@ Examples
List Anonymous Policies for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc policy list` to list the anonymous policies for a
Use :mc:`mc policy list` to list the anonymous policies for a
bucket:
.. code-block:: shell

2
source/reference/minio-mc/mc-policy-set-json.rst
View File

@ -106,7 +106,7 @@ bucket:
Remove Anonymous Policy for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc policy set` to clear the anonymous policy for a
Use :mc:`mc policy set` to clear the anonymous policy for a
bucket:
.. code-block:: shell

2
source/reference/minio-mc/mc-policy-set.rst
View File

@ -112,7 +112,7 @@ Examples
Set Anonymous Policy for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc policy set` to set the anonymous policy for a
Use :mc:`mc policy set` to set the anonymous policy for a
bucket:
.. code-block:: shell

12
source/reference/minio-mc/mc-replicate-add.rst
View File

@ -30,7 +30,7 @@ objects.
This command *requires* first configuring the remote bucket target using the
:mc-cmd:`mc admin bucket remote add` command. You must specify the resulting
remote ARN as part of running :mc-cmd:`mc replicate add`.
remote ARN as part of running :mc:`mc replicate add`.
.. tab-set::
@ -102,7 +102,7 @@ Parameters
*Optional* Creates the replication rule in the "disabled" state. MinIO does
not begin replicating objects using the rule until it is enabled using
:mc-cmd:`mc replicate edit`.
:mc:`mc replicate edit`.
Objects created while replication is disabled are not
immediately eligible for replication after enabling the rule.
@ -177,7 +177,7 @@ Examples
Configure Bucket Replication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following :mc-cmd:`mc replicate add` command creates a replication
The following :mc:`mc replicate add` command creates a replication
configuration that synchronizes all new objects, existing objects, delete
operations, and delete markers to the remote target:
@ -204,7 +204,7 @@ operations, and delete markers to the remote target:
Configure Bucket Replication for Historical Data Record
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following :mc-cmd:`mc replicate add` command creates a new bucket
The following :mc:`mc replicate add` command creates a new bucket
replication configuration that synchronizes all new and existing objects
to the remote target:
@ -241,7 +241,7 @@ MinIO server-side replication only works between MinIO deployments. Both the
source and destination deployments *must* run MinIO.
To configure replication between arbitrary S3-compatible services,
use :mc-cmd:`mc mirror`.
use :mc:`mc mirror`.
Enable Versioning on Source and Destination Buckets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -249,7 +249,7 @@ Enable Versioning on Source and Destination Buckets
MinIO relies on the immutability protections provided by versioning to
synchronize objects between the source and replication target.
Use the :mc-cmd:`mc version suspend` command to enable versioning on
Use the :mc:`mc version suspend` command to enable versioning on
*both* the source and destination bucket before starting this procedure:
.. code-block:: shell

10
source/reference/minio-mc/mc-replicate-edit.rst
View File

@ -84,7 +84,7 @@ Parameters
*Required* Specify the unique ID for a configured replication rule.
Use the :mc-cmd:`mc replicate ls` command to list the replication rules
Use the :mc:`mc replicate ls` command to list the replication rules
for a bucket.
.. mc-cmd:: --priority
@ -183,7 +183,7 @@ Examples
Modify an Existing Replication Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate edit` to modify an existing replication rule.
Use :mc:`mc replicate edit` to modify an existing replication rule.
.. code-block:: shell
:class: copyable
@ -199,7 +199,7 @@ Use :mc-cmd:`mc replicate edit` to modify an existing replication rule.
bucket or bucket prefix on which the rule exists.
- Replace :mc-cmd:`ID <mc replicate edit --id>` with the unique identifier for the
rule to modify. Use :mc-cmd:`mc replicate ls` to retrieve the list of
rule to modify. Use :mc:`mc replicate ls` to retrieve the list of
replication rules on the bucket and their corresponding identifiers.
.. note::
@ -212,7 +212,7 @@ Use :mc-cmd:`mc replicate edit` to modify an existing replication rule.
Disable or Enable an Existing Replication Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate edit` with the
Use :mc:`mc replicate edit` with the
:mc-cmd:`~mc replicate edit --state` flag to disable or enable a
replication rule.
@ -230,7 +230,7 @@ replication rule.
bucket or bucket prefix on which the rule exists.
- Replace :mc-cmd:`ID <mc replicate edit --id>` with the unique identifier for the
rule to modify. Use :mc-cmd:`mc replicate ls` to retrieve the list of
rule to modify. Use :mc:`mc replicate ls` to retrieve the list of
replication rules on the bucket and their corresponding identifiers.
- Specify either ``"disabled"`` or ``"enabled"`` to the

2
source/reference/minio-mc/mc-replicate-export.rst
View File

@ -74,7 +74,7 @@ Examples
Export Existing Replication Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate export` to export bucket replication rules:
Use :mc:`mc replicate export` to export bucket replication rules:
.. code-block:: shell
:class: copyable

4
source/reference/minio-mc/mc-replicate-import.rst
View File

@ -74,7 +74,7 @@ Examples
Import Existing Replication Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate import` to import bucket replication rules:
Use :mc:`mc replicate import` to import bucket replication rules:
.. code-block:: shell
:class: copyable
@ -93,7 +93,7 @@ Behavior
Importing Configuration Overrides Existing Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:mc-cmd:`mc replicate import` replaces the current bucket replication
:mc:`mc replicate import` replaces the current bucket replication
rules with those defined in the imported JSON configuration.
S3 Compatibility

4
source/reference/minio-mc/mc-replicate-ls.rst
View File

@ -73,7 +73,7 @@ Parameters
- ``enabled`` - Show only enabled replication rules.
- ``disabled`` - Show only disabled replication rules.
If omitted, :mc-cmd:`mc replicate ls` defaults to showing all replication
If omitted, :mc:`mc replicate ls` defaults to showing all replication
rules.
Global Flags
@ -89,7 +89,7 @@ Examples
List Existing Replication Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate ls` to list bucket replication rules:
Use :mc:`mc replicate ls` to list bucket replication rules:
.. code-block:: shell
:class: copyable

8
source/reference/minio-mc/mc-replicate-resync.rst
View File

@ -26,7 +26,7 @@ specified MinIO bucket to a remote :ref:`replication
This command *requires* first configuring the remote bucket target using the
:mc-cmd:`mc admin bucket remote add` command. You must specify the resulting
remote ARN as part of running :mc-cmd:`mc replicate resync`.
remote ARN as part of running :mc:`mc replicate resync`.
This command supports rebuilding a MinIO deployment using an active-active
replication remote as the "backup" source. See the following tutorials
@ -89,7 +89,7 @@ Parameters
:mc-cmd:`--remote-bucket <mc replicate resync --remote-bucket>` as the
remote target.
Mutually exclusive with :mc-cmd:`mc replicate resync status`.
Mutually exclusive with :mc:`mc replicate resync status`.
.. mc-cmd:: status
:required:
@ -118,7 +118,7 @@ Parameters
Specify a duration in days where MinIO only resynchronizes
objects older than the specified duration.
Only valid with :mc-cmd:`mc replicate resync start`.
Only valid with :mc:`mc replicate resync start`.
Global Flags
~~~~~~~~~~~~
@ -133,7 +133,7 @@ Examples
Resynchronize Remote Replication Target from Source Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following :mc-cmd:`mc replicate resync` command resynchronizes all objects
The following :mc:`mc replicate resync` command resynchronizes all objects
on the specified source bucket to the remote target regardless of their
replication status:

8
source/reference/minio-mc/mc-replicate-rm.rst
View File

@ -101,7 +101,7 @@ Examples
Remove a Replication Rule from a Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate rm` to remote a bucket replication rule:
Use :mc:`mc replicate rm` to remote a bucket replication rule:
.. code-block:: shell
:class: copyable
@ -109,7 +109,7 @@ Use :mc-cmd:`mc replicate rm` to remote a bucket replication rule:
mc replicate rm --id "ID" ALIAS/PATH
- Replace :mc-cmd:`ID <mc replicate rm --id>` with the unique ID of the
replication rule to remove. Use :mc-cmd:`mc replicate ls` to list all
replication rule to remove. Use :mc:`mc replicate ls` to list all
replication rules for the bucket.
- Replace :mc-cmd:`ALIAS <mc replicate rm ALIAS>` with the
@ -121,7 +121,7 @@ Use :mc-cmd:`mc replicate rm` to remote a bucket replication rule:
Remove All Replication Rules from a Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate rm` to list bucket replication rules:
Use :mc:`mc replicate rm` to list bucket replication rules:
.. code-block:: shell
:class: copyable
@ -143,7 +143,7 @@ Removing Replication Rules Does Not Affect Replicated Objects
Removing one or all replication rule for a bucket does *not*
remove any objects already replicated under those rule(s).
Use The command or :mc-cmd:`mc rb` commands to remove replicated
Use The command or :mc:`mc rb` commands to remove replicated
objects on the remote target. You can identify replicated objects using
the ``X-Amz-Replication-Status`` metadata field where the value is
``REPLICA``. Buckets which contain objects from multiple replication sources

2
source/reference/minio-mc/mc-replicate-status.rst
View File

@ -75,7 +75,7 @@ Examples
Display Replication Status
~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc replicate status` to show bucket replication status:
Use :mc:`mc replicate status` to show bucket replication status:
.. code-block:: shell
:class: copyable

8
source/reference/minio-mc/mc-retention-clear.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc retention clear
.. |command| replace:: :mc-cmd:`mc retention clear`
.. |command| replace:: :mc:`mc retention clear`
.. |rewind| replace:: :mc-cmd:`~mc retention clear --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention clear --version-id`
.. |versions| replace:: :mc-cmd:`~mc retention clear --versions`
@ -86,7 +86,7 @@ Parameters
settings to the bucket contents.
- If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention clear` by default applies to only the latest
:mc:`mc retention clear` by default applies to only the latest
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.
@ -98,7 +98,7 @@ Parameters
to :mc-cmd:`~mc retention clear ALIAS`.
If specifying :mc-cmd:`~mc retention clear --default`,
:mc-cmd:`mc retention clear` ignores all other flags.
:mc:`mc retention clear` ignores all other flags.
.. mc-cmd:: --recursive, r
@ -171,7 +171,7 @@ Clear Object Lock Settings for an Object or Object(s)
.. tab-item:: Multiple Objects
Use :mc-cmd:`mc retention clear` with
Use :mc:`mc retention clear` with
:mc-cmd:`~mc retention clear --recursive` to clear the retention
settings from all objects in a bucket:

10
source/reference/minio-mc/mc-retention-info.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc retention info
.. |command| replace:: :mc-cmd:`mc retention info`
.. |command| replace:: :mc:`mc retention info`
.. |rewind| replace:: :mc-cmd:`~mc retention info --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention info --version-id`
.. |alias| replace:: :mc-cmd:`~mc retention info ALIAS`
@ -92,7 +92,7 @@ Parameters
lock settings for all objects in the bucket or bucket prefix.
- If the ``ALIAS`` bucket has versioning enabled,
:mc-cmd:`mc retention info` by default applies to only the latest object
:mc:`mc retention info` by default applies to only the latest object
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.
@ -105,7 +105,7 @@ Parameters
to :mc-cmd:`~mc retention info ALIAS`.
If specifying :mc-cmd:`~mc retention info --default`,
:mc-cmd:`mc retention info` ignores all other flags.
:mc:`mc retention info` ignores all other flags.
.. mc-cmd:: --recursive, r
@ -177,7 +177,7 @@ Retrieve Object Lock Settings for an Object or Object(s)
.. tab-item:: Multiple Objects
Use :mc-cmd:`mc retention info` with
Use :mc:`mc retention info` with
:mc-cmd:`~mc retention info --recursive` to retrieve the retention
settings for all objects in a bucket:
@ -199,7 +199,7 @@ Retrieve Object Lock Settings for an Object or Object(s)
Retrieve Default Object Lock Settings for a Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc retention info` with
Use :mc:`mc retention info` with
:mc-cmd:`~mc retention info --default` to retrieve the default
object lock settings for a bucket:

16
source/reference/minio-mc/mc-retention-set.rst
View File

@ -15,7 +15,7 @@
.. replacements for mc retention set
.. |command| replace:: :mc-cmd:`mc retention set`
.. |command| replace:: :mc:`mc retention set`
.. |rewind| replace:: :mc-cmd:`~mc retention set --rewind`
.. |versionid| replace:: :mc-cmd:`~mc retention set --version-id`
.. |alias| replace:: :mc-cmd:`~mc retention set ALIAS`
@ -126,7 +126,7 @@ Parameters
:mc-cmd:`~mc retention set --recursive` to apply the object lock
settings to the bucket contents.
- :mc-cmd:`mc retention set` by default applies to only the latest object
- :mc:`mc retention set` by default applies to only the latest object
version. Use :mc-cmd:`~mc retention set --version-id` or
:mc-cmd:`~mc retention set --versions` to apply the object lock
settings to a specific version or to all versions of the object
@ -146,10 +146,10 @@ Parameters
:mc-cmd:`~mc retention set ALIAS` using the
:mc-cmd:`~mc retention set MODE` and :mc-cmd:`~mc retention set VALIDITY`.
Any objects created in the bucket inherit the default object lock settings
unless explicitly overriden using :mc-cmd:`mc retention set`.
unless explicitly overriden using :mc:`mc retention set`.
If specifying :mc-cmd:`~mc retention set --default`,
:mc-cmd:`mc retention set` ignores all other flags.
:mc:`mc retention set` ignores all other flags.
.. mc-cmd:: --recursive
:optional:
@ -207,7 +207,7 @@ Examples
Set Default Bucket Retention Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc retention set` with the
Use :mc:`mc retention set` with the
:mc-cmd:`~mc retention set --recursive` and
:mc-cmd:`~mc retention set --default` to set the default bucket
retention settings.
@ -241,7 +241,7 @@ Set Object Lock Configuration for Versioned Object
.. tab-item:: Specific Version
Use :mc-cmd:`mc retention set` with
Use :mc:`mc retention set` with
:mc-cmd:`~mc retention set --version-id` to apply the retention
settings to a specific object version:
@ -269,7 +269,7 @@ Set Object Lock Configuration for Versioned Object
.. tab-item:: All Versions
Use :mc-cmd:`mc retention set` with
Use :mc:`mc retention set` with
:mc-cmd:`~mc retention set --versions` to apply the retention
settings to a specific object version:
@ -343,7 +343,7 @@ legal hold remains locked *even if* the retention period expires. Setting,
modifying, or clearing retention settings for an object under legal hold has no
effect until the legal hold either expires or is explicitly disabled.
For more information on object legal holds, see :mc-cmd:`mc legalhold`.
For more information on object legal holds, see :mc:`mc legalhold`.
S3 Compatibility
~~~~~~~~~~~~~~~~

4
source/reference/minio-mc/mc-rm.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc rm
.. |command| replace:: :mc-cmd:`mc rm`
.. |command| replace:: :mc:`mc rm`
.. |rewind| replace:: :mc-cmd:`~mc rm --rewind`
.. |versions| replace:: :mc-cmd:`~mc rm --versions`
.. |versionid| replace:: :mc-cmd:`~mc rm --version-id`
@ -131,7 +131,7 @@ Parameters
specifies the root (all buckets) on the MinIO deployment.
When combined with :mc-cmd:`~mc rm --versions`, this flag
directs :mc-cmd:`mc rm` to permanently remove all objects *and* versions from
directs :mc:`mc rm` to permanently remove all objects *and* versions from
the ``ALIAS`` target.
Consider first running the command with the :mc-cmd:`~mc rm --fake` to

6
source/reference/minio-mc/mc-share-download.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc share download
.. |command| replace:: :mc-cmd:`mc share download`
.. |command| replace:: :mc:`mc share download`
.. |versionid| replace:: :mc-cmd:`~mc share download --version-id`
.. |alias| replace:: :mc-cmd:`~mc share download ALIAS`
@ -134,7 +134,7 @@ Generate a URL to Download Object(s)
.. tab-item:: Get Specific Object
Use :mc-cmd:`mc share download` to generate a URL that supports
Use :mc:`mc share download` to generate a URL that supports
``GET`` requests for an object:
.. code-block:: shell
@ -154,7 +154,7 @@ Generate a URL to Download Object(s)
.. tab-item:: Get Object(s) in a Bucket
Use :mc-cmd:`mc share download` with the
Use :mc:`mc share download` with the
:mc-cmd:`~mc share download --recursive` option to generate a URL for
each object in a bucket. Each URL supports ``GET`` requests for its
associated object:

10
source/reference/minio-mc/mc-share-list.rst
View File

@ -16,7 +16,7 @@ Syntax
.. start-mc-share-upload-desc
The :mc:`mc share list` command displays any unexpired presigned URLs generated
by :mc-cmd:`mc share upload` or :mc-cmd:`mc share download`
by :mc:`mc share upload` or :mc:`mc share download`
.. end-mc-share-upload-desc
@ -62,13 +62,13 @@ Parameters
*Required* Lists all unexpired presigned download (``GET``) URLs.
Mutually exclusive with :mc-cmd:`mc share list upload`
Mutually exclusive with :mc:`mc share list upload`
.. mc-cmd:: upload
*Required* Lists all unexpired presigned upload (``PUT``) URLs.
Mutually exclusive with :mc-cmd:`mc share list download`
Mutually exclusive with :mc:`mc share list download`
.. mc-cmd:: ALIAS
@ -94,7 +94,7 @@ List Generated Download and Upload URLs
.. tab-item:: List Active Download Presigned URLs
Use :mc-cmd:`mc share list download` to generate a URL
Use :mc:`mc share list download` to generate a URL
that supports ``POST`` requests for uploading a file to a specific object
location on an S3-compatible host:
@ -108,7 +108,7 @@ List Generated Download and Upload URLs
.. tab-item:: List Active Upload Presigned URLs
Use :mc-cmd:`mc share list upload` to generate a URL that
Use :mc:`mc share list upload` to generate a URL that
supports ``POST`` requests for uploading a file to a specific object
location on an S3-compatible host:

4
source/reference/minio-mc/mc-share-upload.rst
View File

@ -127,7 +127,7 @@ Generate a URL to Upload Object(s)
.. tab-item:: Upload Single Object
Use :mc-cmd:`mc share upload` to generate a URL that supports
Use :mc:`mc share upload` to generate a URL that supports
``POST`` requests for uploading a file to a specific object location
on a MinIO deployment:
@ -148,7 +148,7 @@ Generate a URL to Upload Object(s)
.. tab-item:: Upload Multiple Objects
Use :mc-cmd:`mc share upload` with the
Use :mc:`mc share upload` with the
:mc-cmd:`~mc share upload --recursive` and
:mc-cmd:`~mc share upload --expire` options to generate a temporary URL
that supports ``POST`` requests for uploading files to a bucket on a MinIO

2
source/reference/minio-mc/mc-sql.rst
View File

@ -235,7 +235,7 @@ information on CSV formatting fields.
For ``.json`` file types, use :mc-cmd:`mc sql --json-input` to specify
the JSON data format.
For ``.parquet`` file types, :mc-cmd:`mc sql` automatically interprets the
For ``.parquet`` file types, :mc:`mc sql` automatically interprets the
data format.
.. _mc-sql-csv-format:

2
source/reference/minio-mc/mc-stat.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc stat
.. |command| replace:: :mc-cmd:`mc stat`
.. |command| replace:: :mc:`mc stat`
.. |rewind| replace:: :mc-cmd:`~mc stat --rewind`
.. |versions| replace:: :mc-cmd:`~mc stat --versions`
.. |versionid| replace:: :mc-cmd:`~mc stat --version-id`

8
source/reference/minio-mc/mc-support-diagnostics.rst
View File

@ -13,7 +13,7 @@
Description
-----------
The :mc-cmd:`mc support diagnostics` command generates a health report for a MinIO deployment.
The :mc:`mc support diagnostics` command generates a health report for a MinIO deployment.
For deployments registered with the MinIO subscription network (|subnet-short|), the command can automatically upload the health report for analysis.
The resulting health report is intended for use by MinIO Engineering via SUBNET and may contain internal or private data points.
@ -23,10 +23,10 @@ MinIO recommends that you run the health diagnostics when first provisioning the
This diagnostic test runs as a one-shot test and can run for as long as 5 minutes.
During the test, MinIO freezes all S3 calls and queues read or write operations until the test completes.
The queue is limited based on the supported maximum concurrent :ref:`requests per host <minio-requests-per-node>`.
The queue is limited based on the supported maximum concurrent :ref:`requests per host <minio-hardware-checklist-memory>`.
Requests that exceed this limit on a given host return a ``503`` error after ~10 seconds.
Use the :mc-cmd:`mc support diagnostics` command to trigger the diagnostic test.
Use the :mc:`mc support diagnostics` command to trigger the diagnostic test.
For clusters registered with SUBNET, the command uploads the results as part of SUBNET Health reports.
For airgapped or firewalled environments, or other environments that prevent direct network access from the deployment, you can save the report locally with the :mc-cmd:`~mc support diagnostics --airgap` flag.
@ -73,7 +73,7 @@ Generate health data for a MinIO cluster and automatically for a MinIO cluster a
mc support diag minio1
The automatic upload of data only occurs for deployments registered with SUBNET using :mc-cmd:`mc support register`.
The automatic upload of data only occurs for deployments registered with SUBNET using :mc:`mc support register`.
.. _minio-support-diagnostics-airgap:

4
source/reference/minio-mc/mc-support-inspect.rst
View File

@ -13,7 +13,7 @@
Description
-----------
The :mc-cmd:`mc support inspect` command collects the data and metadata associated to objects at the specified path.
The :mc:`mc support inspect` command collects the data and metadata associated to objects at the specified path.
MinIO assembles this data from each backend drive storing an :ref:`erasure shard <minio-erasure-coding>` for each specified object.
The command produces a zip file that includes all matching files with their respective *host+drive+path*.
@ -25,7 +25,7 @@ Exercise caution before sending a report to a third party or posting the report
.. important::
:mc-cmd:`mc support inspect` requires a MinIO deployment server from October 2021 or later.
:mc:`mc support inspect` requires a MinIO deployment server from October 2021 or later.
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only

4
source/reference/minio-mc/mc-support-perf.rst
View File

@ -13,13 +13,13 @@
Description
-----------
Use the :mc-cmd:`mc support perf` command to review the performance of the S3 API (read/write), network IO, and storage (drive read/write).
Use the :mc:`mc support perf` command to review the performance of the S3 API (read/write), network IO, and storage (drive read/write).
The resulting tests can provide general guidance of deployment performance under S3 ``GET`` and ``PUT`` requests and identify any potential bottlenecks.
For more complete performance testing, consider using a combination of load-testing using your staging application environments and the MinIO `WARP <https://github.com/minio/warp>`_ S3 benchmarking tool.
:mc-cmd:`mc support perf` has three subcommands
:mc:`mc support perf` has three subcommands
#. :mc-cmd:`~mc support perf drive`

4
source/reference/minio-mc/mc-support-profile.rst
View File

@ -13,7 +13,7 @@
Description
-----------
The :mc-cmd:`mc support profile` command runs a system profile for your deployment.
The :mc:`mc support profile` command runs a system profile for your deployment.
The results of the profile can provide insight into the MinIO server process running on a given node.
The resulting report is intended for use by MinIO Engineering.
@ -64,7 +64,7 @@ The profile runs for 10 minutes (600 seconds).
Syntax
------
The :mc-cmd:`mc support profile` command has the following syntax:
The :mc:`mc support profile` command has the following syntax:
.. code-block:: shell

4
source/reference/minio-mc/mc-support-register.rst
View File

@ -13,9 +13,9 @@
Description
-----------
The :mc-cmd:`mc support register` command connects your deployment with your |SUBNET| account.
The :mc:`mc support register` command connects your deployment with your |SUBNET| account.
After registration, upload deployment health reports directly to SUBNET using :mc-cmd:`mc support diagnostics` command.
After registration, upload deployment health reports directly to SUBNET using :mc:`mc support diagnostics` command.
Examples

4
source/reference/minio-mc/mc-tag-list.rst
View File

@ -12,7 +12,7 @@
.. mc:: mc tag list
.. |command| replace:: :mc-cmd:`mc tag list`
.. |command| replace:: :mc:`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`
@ -115,7 +115,7 @@ Examples
List Tags for a Bucket or Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc tag list` to list tags for a bucket or object:
Use :mc:`mc tag list` to list tags for a bucket or object:
.. code-block:: shell
:class: copyable

4
source/reference/minio-mc/mc-tag-remove.rst
View File

@ -12,7 +12,7 @@
.. mc:: mc tag remove
.. |command| replace:: :mc-cmd:`mc tag remove`
.. |command| replace:: :mc:`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`
@ -114,7 +114,7 @@ Examples
Remove Tags from a Bucket or Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc tag remove` to remove tags from a bucket or object:
Use :mc:`mc tag remove` to remove tags from a bucket or object:
.. code-block:: shell
:class: copyable

4
source/reference/minio-mc/mc-tag-set.rst
View File

@ -13,7 +13,7 @@
.. mc:: mc tag
.. mc:: mc tag set
.. |command| replace:: :mc-cmd:`mc tag set`
.. |command| replace:: :mc:`mc tag set`
.. |rewind| replace:: :mc-cmd:`~mc tag set --rewind`
.. |versions| replace:: :mc-cmd:`~mc tag set --versions`
.. |versionid| replace:: :mc-cmd:`~mc tag set --version-id`
@ -128,7 +128,7 @@ Examples
Apply Tags to a Bucket or Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc tag set` to apply tags to a bucket or object:
Use :mc:`mc tag set` to apply tags to a bucket or object:
.. code-block:: shell
:class: copyable

2
source/reference/minio-mc/mc-tree.rst
View File

@ -10,7 +10,7 @@
.. mc:: mc tree
.. |command| replace:: :mc-cmd:`mc tree`
.. |command| replace:: :mc:`mc tree`
.. |rewind| replace:: :mc-cmd:`~mc tree --rewind`
.. |alias| replace:: :mc-cmd:`~mc tree ALIAS`

6
source/reference/minio-mc/mc-version.rst
View File

@ -98,7 +98,7 @@ Examples
Enable Bucket Versioning
~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc version suspend` to enable versioning on a bucket:
Use :mc:`mc version suspend` to enable versioning on a bucket:
.. code-block:: shell
:class: copyable
@ -114,7 +114,7 @@ Use :mc-cmd:`mc version suspend` to enable versioning on a bucket:
Disable Bucket Versioning
~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc version suspend` to suspend versioning on a bucket:
Use :mc:`mc version suspend` to suspend versioning on a bucket:
.. code-block:: shell
:class: copyable
@ -130,7 +130,7 @@ Use :mc-cmd:`mc version suspend` to suspend versioning on a bucket:
Get Bucket Versioning Status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc version info` to enable versioning on a bucket:
Use :mc:`mc version info` to enable versioning on a bucket:
.. code-block:: shell
:class: copyable

2
source/reference/minio-server/minio-server.rst
View File

@ -43,7 +43,7 @@ Configuration Settings
The :mc:`minio server` process stores its configuration in the storage
backend :mc-cmd:`directory <minio server DIRECTORIES>`. You can modify
configuration options using the
:mc-cmd:`mc admin config` command.
:mc:`mc admin config` command.
Syntax
~~~~~~~