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

Mc updates for multiple releases (#642)

Browse Source 
Updates `mc` reference docs for several releases of the MinIO Client.

- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
    
Closes #571
Closes #614
Closes #627
Closes #633
This commit is contained in:
Daryl White
2022-11-18 12:49:03 -06:00
committed by GitHub
parent 2f8c5a94f6
commit 0cd491c328
36 changed files with 291 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,8 +21,8 @@ corrupted and heals those objects.
.. end-mc-admin-heal-desc
: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
after drive failures or corruption events. Instead, MinIO automatically heals
objects damaged by silent bit rot corruption, drive failure, or other issues on
POST/GET. MinIO also performs periodic background object healing.
.. admonition:: Use ``mc admin`` on MinIO Deployments Only

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

@ -26,18 +26,45 @@ The :mc-cmd:`mc admin trace` command displays API operations occurring on the ta
:start-after: start-minio-only
:end-before: end-minio-only
Example
-------
Examples
--------
Monitor All API operations
~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin trace` to monitor API operations on a MinIO deployment:
.. code-block:: shell
:class: copyable
mc admin trace ALIAS
mc admin trace -a ALIAS
- Replace :mc-cmd:`ALIAS <mc admin trace TARGET>` with the
:mc-cmd:`alias <mc alias>` of the MinIO deployment.
- Replace :mc-cmd:`ALIAS <mc admin trace TARGET>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
See Calls that Return 503 Errors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin trace` to monitor API operations that return a service unavailable 503 error:
.. code-block:: shell
:class: copyable
mc admin trace -v --status-code 503 ALIAS
- Replace :mc-cmd:`ALIAS <mc admin trace TARGET>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
See Console Trace for a Path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc-cmd:`mc admin trace` to monitory activity for a specific path:
.. code-block:: shell
:class: copyable
mc admin trace --path my-bucket/my-prefix/* ALIAS
- Replace :mc-cmd:`ALIAS <mc admin trace TARGET>` with the :mc-cmd:`alias <mc alias>` of the MinIO deployment.
- Replace ``my-bucket/my-prefix/*`` with the bucket, prefix, and object name or wildcard you wish to trace.
Syntax
------
@ -57,16 +84,60 @@ Syntax
.. mc-cmd:: --all, a
Returns all traffic on the MinIO deployment, including internode traffic between MinIO servers.
Returns all traffic on the MinIO deployment, including internode traffic
between MinIO servers.
.. mc-cmd:: --call
Traces only matching call types.
For example, the following command only traces calls of the type ``scanner``.
.. code-block:: shell
mc admin trace --call scanner TARGET
Valid call types include:
- ``s3``
- ``internal``
- ``storage``
- ``os``
- ``scanner``
- ``decommission``
- ``healing``
.. mc-cmd:: --verbose
Returns verbose output.
.. mc-cmd:: --errors, e
Returns failed API operations only.
.. mc-cmd:: --response-threshold
Takes a time string as a value, such as ``5ms``.
Returns only calls with a response time greater than the supplied threshold.
.. mc-cmd:: --status-code
Returns calls of the specified HTTP status code.
.. mc-cmd:: --method
Returns call of the specified HTTP method.
.. mc-cmd:: --funcname
Returns calls for the entered function name.
.. mc-cmd:: --path
Returns calls for the specified path.
.. mc-cmd:: --node
Returns calls for the specified server.
.. mc-cmd:: --request-header
Returns calls matching the supplied request header.

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

@ -249,8 +249,10 @@ The following table lists :mc-cmd:`mc` commands:
* - | :mc:`mc license register`
| :mc:`mc license info`
| :mc:`mc license update`
- The ``mc license`` command registers clusters with |SUBNET|, displays information about the cluster's current license, or updates the license key for a cluster.
| :mc:`mc license update`
| :mc:`mc license unregister`
- The ``mc license`` commands work with cluster registration for |SUBNET|.
Use the commands to register a deployment, unregister a deployment, display information about the cluster's current license, or update the license key for a cluster.
* - :mc:`mc ls`
- .. include:: /reference/minio-mc/mc-ls.rst
@ -509,6 +511,7 @@ All :ref:`commands <minio-mc-commands>` support the following global options:
/reference/minio-mc/mc-legalhold-clear
/reference/minio-mc/mc-license-info
/reference/minio-mc/mc-license-register
/reference/minio-mc/mc-license-unregister
/reference/minio-mc/mc-license-update
/reference/minio-mc/mc-ls
/reference/minio-mc/mc-mb

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

@ -32,13 +32,13 @@ The command supports adding both :ref:`Transition (Tiering) <minio-lifecycle-man
.. code-block:: shell
:class: copyable
mc ilm add --expiry-days 90 --noncurrentversion-expiry-days 30 mydata/myminio
mc ilm add --expire-days 90 --noncurrent-expire-days 30 mydata/myminio
mc ilm add --expired-object-delete-marker mydata/myminio
mc ilm add --expire-delete-marker mydata/myminio
mc ilm add --transition-days 30 --tier "COLDTIER" mydata/myminio
mc ilm add --noncurrentversion-transition-days 7 --noncurrent-version-transition-tier "COLDTIER"
mc ilm add --noncurrent-transition-days 7 --noncurrent-transition-tier "COLDTIER"
The configured rules have the following effect:
@ -55,18 +55,18 @@ The command supports adding both :ref:`Transition (Tiering) <minio-lifecycle-man
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm add \
--expiry-days "integer" \
[--prefix string] \
[--tags string] \
[--transition-days "string"] \
[--tier "string"] \
[--expired-object-delete-marker] \
[--noncurrentversion-expiration-days "integer"] \
[--noncurrentversion-transition-days "integer"] \
[--noncurrentversion-tier "string"] \
[--newer-noncurrentversions-expiration "integer"] \
[--newer-noncurrentversions-transition "integer"] \
mc [GLOBALFLAGS] ilm add \
[--prefix string] \
[--tags string] \
--expire-days "integer" \
[--expire-delete-marker] \
[--transition-days "string"] \
[--transition-tier "string"] \
[--noncurrent-expire-days "integer"] \
[--noncurrent-expire-newer "integer"] \
[--noncurrent-transition-days "integer"] \
[--noncurrent-transition-newer "integer"] \
[--noncurrent-transition-tier "string"] \
ALIAS
.. include:: /includes/common-minio-mc.rst
@ -100,7 +100,16 @@ Parameters
The command creates a rule that expires objects in the ``mydata`` bucket of the ``myminio`` ALIAS after 90 days for any object with the ``meetingnotes/`` prefix.
.. mc-cmd:: --expiry-days
.. mc-cmd:: --tags
:optional:
One or more ampersand ``&``-delimited key-value pairs describing the object tags to use for filtering objects to which the lifecycle configuration rule applies.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add --expire-delete-marker`
.. mc-cmd:: --expire-days
:required:
The number of days to retain an object after being created.
@ -108,7 +117,7 @@ Parameters
Specify the number of days as an integer, e.g. ``30`` for 30 days.
For versioned buckets, the expiry rule applies only to the *current* object version.
Use the :mc-cmd:`~mc ilm add --noncurrentversion-expiration-days` option to apply expiration behavior to noncurrent object versions.
Use the :mc-cmd:`~mc ilm add --noncurrent-expire-days` option to apply expiration behavior to noncurrent object versions.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
@ -116,11 +125,11 @@ Parameters
Mutually exclusive with the following options:
- :mc-cmd:`~mc ilm add --expired-object-delete-marker`
- :mc-cmd:`~mc ilm add --expire-delete-marker`
For more complete documentation on object expiration, see :ref:`minio-lifecycle-management-expiration`.
.. mc-cmd:: --expired-object-delete-marker
.. mc-cmd:: --expire-delete-marker
:optional:
Specify this option to direct MinIO to remove delete markers for objects with no remaining object versions.
@ -129,7 +138,7 @@ Parameters
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add --tags`
- :mc-cmd:`~mc ilm add --expiry-days`
- :mc-cmd:`~mc ilm add --expire-days`
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
@ -142,13 +151,13 @@ Parameters
:optional:
The number of calendar days from object creation after which MinIO marks an object as eligible for transition.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --tier`.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --transition-tier`.
Specify the number of days as an integer, e.g. ``30`` for 30 days.
For versioned buckets, the transition rule applies only to the *current* object version.
Use the :mc-cmd:`~mc ilm add --noncurrentversion-transition-days` option to apply transition behavior to noncurrent object versions.
Use the :mc-cmd:`~mc ilm add --noncurrent-transition-days` option to apply transition behavior to noncurrent object versions.
Requires specifying :mc-cmd:`~mc ilm add --tier`.
Requires specifying :mc-cmd:`~mc ilm add --transition-tier`.
MinIO uses a scanner process to check objects against all configured lifecycle management rules.
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
@ -156,7 +165,7 @@ Parameters
For more complete documentation on object transition, see :ref:`minio-lifecycle-management-tiering`.
.. mc-cmd:: --tier
.. mc-cmd:: --transition-tier
:optional:
The remote tier to which MinIO :ref:`transition objects <minio-lifecycle-management-tiering>`.
@ -164,16 +173,7 @@ Parameters
Required if specifying :mc-cmd:`~mc ilm add --transition-days`.
.. mc-cmd:: --tags
:optional:
One or more ampersand ``&``-delimited key-value pairs describing the object tags to use for filtering objects to which the lifecycle configuration rule applies.
This option is mutually exclusive with the following option:
- :mc-cmd:`~mc ilm add --expired-object-delete-marker`
.. mc-cmd:: --noncurrentversion-expiration-days
.. mc-cmd:: --noncurrent-expire-days
:optional:
The number of days to retain an object version after becoming *non-current* (i.e. a different version of that object is now the `HEAD`).
@ -185,14 +185,14 @@ Parameters
Slow scanning due to high IO workloads or 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:: --noncurrent-transition-days
:optional:
The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --tier` once the system host datetime passes that calendar date.
The number of days an object has been non-current (i.e. replaced by a newer version of that same object) after which MinIO marks the object version as eligible for transition.
MinIO transitions the object to the configured remote tier specified to the :mc-cmd:`~mc ilm add --transition-tier` once the system host datetime passes that calendar date.
This option has no effect on non-versioned buckets.
Requires specifying :mc-cmd:`~mc ilm add --noncurrentversion-tier`.
Requires specifying :mc-cmd:`~mc ilm add --noncurrent-transition-tier`.
This option has the same behavior as the S3 ``NoncurrentVersionTransition`` action.
@ -200,13 +200,13 @@ Parameters
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --noncurrentversion-tier
.. mc-cmd:: --noncurrent-transition-tier
:optional:
The remote tier to which MinIO :ref:`transitions noncurrent objects versions <minio-lifecycle-management-tiering>`.
Specify a remote tier created by :mc:`mc admin tier`.
.. mc-cmd:: --newer-noncurrentversions-expiration
.. mc-cmd:: --noncurrent-expire-newer
:optional:
The maximum number of non-current object versions to retain, ordered from newest to oldest.
@ -214,7 +214,7 @@ Parameters
Use this flag to retain a certain number of past versions of a file in a first in, first out fashion.
After retaining the maximum number of non-current versions, MinIO marks any remaining older non-current object versions as eligible for expiration.
The following table lists a number of object versions and their expiration eligibility based on ``--newer-noncurrentversions-expiration 3``:
The following table lists a number of object versions and their expiration eligibility based on ``--noncurrent-expire-newer 3``:
.. list-table::
:widths: 50 50
@ -244,7 +244,7 @@ Parameters
Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules.
See :ref:`minio-lifecycle-management-scanner` for more information.
.. mc-cmd:: --newer-noncurrentversions-transition
.. mc-cmd:: --noncurrent-transition-newer
:optional:
The maximum number of non-current object versions to retain on the current tier.
@ -254,7 +254,7 @@ Parameters
If not specified, all non-current object versions transition to the different tier.
The following table lists a number of object versions and their transition eligibility based on ``--newer-noncurrentversions-transition 3``:
The following table lists a number of object versions and their transition eligibility based on ``--noncurrent-transition-newer 3``:
.. list-table::
:widths: 50 50

58
source/reference/minio-mc/mc-license-unregister.rst Normal file
View File

@ -0,0 +1,58 @@
=========================
``mc license unregister``
=========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc license unregister
Description
-----------
The :mc-cmd:`mc license unregister` command disconnects your deployment from your |SUBNET| account.
After unregistering, you can no longer use the :mc:`mc support` commands.
Examples
--------
Unregister a Deployment Using the Deployment's Name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove the registration of the MinIO deployment at alias ``minio1`` from SUBNET.
.. code-block:: shell
:class: copyable
mc license unregister minio1
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc [GLOBALFLAGS] license unregister ALIAS
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` of the MinIO deployment.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

1
source/reference/minio-mc/mc-support-diag.rst
View File

@ -8,6 +8,7 @@
:local:
:depth: 1
.. mc:: mc support
.. mc:: mc support diag
.. include:: /includes/common-mc-support.rst

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

@ -110,6 +110,7 @@ Measure the read/write speed of the drives in a cluster.
[--filesize] \
[--blocksize] \
[--serial] \
[--airgap] \
ALIAS
.. mc-cmd:: object
@ -124,12 +125,13 @@ Measure the S3 peformance of reading and writing objects in a cluster.
[--size] \
[--concurrent] \
[--verbose, -v] \
[--airgap] \
ALIAS
.. mc-cmd:: net
:fullpath:
Measure the network throughput of all nodes in a cluster.
Measure the network throughput of all nodes in a cluster.
.. code-block:: shell
@ -137,6 +139,7 @@ Measure the network throughput of all nodes in a cluster.
[--concurrent] \
[--verbose, -v] \
[--serial] \
[--airgap] \
ALIAS
Parameters
@ -153,9 +156,16 @@ Parameters
Use ``--duration <value>`` where ``<value>`` is a number and a unit of ``s`` for seconds, ``m`` for minutes.
.. mc-cmd:: --size
.. mc-cmd:: --airgap
:optional:
Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).
If the deployment is airgapped, but the local device where you are using the :ref:`minio client <minio-client>` has network access, you do not need to use the ``--airgap`` flag.
.. mc-cmd:: --size
:optional:
Applies to the :mc-cmd:`~mc support perf object` command.
Specify the size of the object to use for upload and download performance test.

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

@ -68,10 +68,11 @@ The :mc:`mc support profile` command has the following syntax:
.. code-block:: shell
mc [GLOBALFLAGS] support profile \
COMMAND \
[--type] \
[--duration]
mc [GLOBALFLAGS] support profile \
COMMAND \
[--type] \
[--airgap] \
[--duration] \
ALIAS
Parameters
@ -106,6 +107,13 @@ Parameters
If not specified, the command collects data for CPU, memory, block, mutex, threads, and goroutines.
.. mc-cmd:: --airgap
:optional:
Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).
If the deployment is airgapped, but the local device where you are using the :ref:`minio client <minio-client>` has network access, you do not need to use the ``--airgap`` flag.
.. mc-cmd:: ALIAS
:required:

6
source/reference/minio-mc/mc-support-top-disk.rst
View File

@ -15,7 +15,7 @@ Syntax
.. start-mc-support-top-disk-desc
The :mc:`mc support top disk` command displays current disk statistics.
The :mc:`mc support top disk` command displays current drive statistics.
.. end-mc-support-top-disk-desc
@ -56,9 +56,9 @@ Parameters
.. mc-cmd:: --count, -c
:optional:
Display statistics for up to the entered number of disks.
Display statistics for up to the entered number of drives.
If no entry is made, the command returns statistics for up to 10 disks.
If no entry is made, the command returns statistics for up to 10 drives.
Global Flags
~~~~~~~~~~~~

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

@ -116,7 +116,7 @@ The command accepts the following arguments:
.. important::
MinIO recommends locally-attached drives, where the
:mc-cmd:`~minio server DIRECTORIES` path points to each disk on the
:mc-cmd:`~minio server DIRECTORIES` path points to each drive on the
host machine. MinIO recommends *against* using network-attached
storage, as network latency reduces performance of those drives
compared to locally-attached storage.