minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +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

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