mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +03:00
Updates for MinIO Server and MC releases on 2024-07-03/04 (#1299)
- Adds info about tracking batch job status for completed jobs - Deprecates `mc license update` - Adds flags for updating Azure credentials in `mc ilm tier update` Closes #1260
This commit is contained in:
@ -12,6 +12,12 @@
|
|||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
|
|
||||||
|
This command is no longer maintained in the Open Source MinIO Server or MinIO Client product and has been removed completely as of MinIO Client ``RELEASE.2024-07-03T20-17-25Z``.
|
||||||
|
|
||||||
|
For questions about licensing the MinIO Server, contact sales@min.io.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
``mc license update`` requires :ref:`MinIO Client <minio-client>` version ``RELEASE.2023-11-20T16-30-59Z``.
|
``mc license update`` requires :ref:`MinIO Client <minio-client>` version ``RELEASE.2023-11-20T16-30-59Z``.
|
||||||
While not strictly required, best practice keeps the :ref:`MinIO Client version <mc-client-versioning>` in alignment with the MinIO Server version.
|
While not strictly required, best practice keeps the :ref:`MinIO Client version <mc-client-versioning>` in alignment with the MinIO Server version.
|
||||||
|
|
@ -71,6 +71,10 @@ Table of Deprecated Commands
|
|||||||
- :mc-cmd:`mc replicate backlog`
|
- :mc-cmd:`mc replicate backlog`
|
||||||
- mc RELEASE.2023-07-18T21-05-38Z
|
- mc RELEASE.2023-07-18T21-05-38Z
|
||||||
|
|
||||||
|
* - ``mc license update``
|
||||||
|
- No replacement
|
||||||
|
- mc RELEASE.2024-07-03T20-17-25Z
|
||||||
|
|
||||||
|
|
||||||
Table of Deprecated Admin Commands
|
Table of Deprecated Admin Commands
|
||||||
----------------------------------
|
----------------------------------
|
||||||
@ -226,6 +230,7 @@ Table of Deprecated Admin Commands
|
|||||||
/reference/deprecated/mc-ilm-import
|
/reference/deprecated/mc-ilm-import
|
||||||
/reference/deprecated/mc-ilm-ls
|
/reference/deprecated/mc-ilm-ls
|
||||||
/reference/deprecated/mc-ilm-rm
|
/reference/deprecated/mc-ilm-rm
|
||||||
|
/reference/deprecated/mc-license-update
|
||||||
/reference/deprecated/mc-quota
|
/reference/deprecated/mc-quota
|
||||||
/reference/deprecated/mc-quota-clear
|
/reference/deprecated/mc-quota-clear
|
||||||
/reference/deprecated/mc-quota-info
|
/reference/deprecated/mc-quota-info
|
||||||
|
@ -19,7 +19,11 @@ Syntax
|
|||||||
|
|
||||||
.. start-mc-batch-status-desc
|
.. start-mc-batch-status-desc
|
||||||
|
|
||||||
The :mc:`mc batch status` command outputs real-time summaries of job events on a MinIO server.
|
The :mc:`mc batch status` command outputs summaries of job events on a MinIO server.
|
||||||
|
|
||||||
|
.. versionchanged:: mc RELEASE.2024-07-03T20-17-25Z
|
||||||
|
|
||||||
|
Batch status displays summaries for active, in-progress jobs or any batch job completed in the previous three (3) days.
|
||||||
|
|
||||||
.. end-mc-batch-status-desc
|
.. end-mc-batch-status-desc
|
||||||
|
|
||||||
@ -28,12 +32,12 @@ The :mc:`mc batch status` command outputs real-time summaries of job events on a
|
|||||||
|
|
||||||
.. tab-item:: EXAMPLE
|
.. tab-item:: EXAMPLE
|
||||||
|
|
||||||
The following command outputs a list of all jobs currently in progress on the ``myminio`` alias.
|
The following command outputs the status of the specified job with JobID ``KwSysDpxcBU9FNhGkn2dCf`` currently in progress on the ``myminio`` alias.
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc batch status myminio KwSysDpxcBU9FNhGkn2dCf
|
mc batch status myminio "KwSysDpxcBU9FNhGkn2dCf"
|
||||||
|
|
||||||
.. tab-item:: SYNTAX
|
.. tab-item:: SYNTAX
|
||||||
|
|
||||||
@ -43,7 +47,7 @@ The :mc:`mc batch status` command outputs real-time summaries of job events on a
|
|||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc [GLOBALFLAGS] batch list TARGET \
|
mc [GLOBALFLAGS] batch list TARGET \
|
||||||
JOBID
|
["JOBID"]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
:start-after: start-minio-syntax
|
:start-after: start-minio-syntax
|
||||||
@ -63,6 +67,8 @@ Parameters
|
|||||||
The unique identifier of a job to summarize.
|
The unique identifier of a job to summarize.
|
||||||
To find the ID of a job, use :mc:`mc batch list`.
|
To find the ID of a job, use :mc:`mc batch list`.
|
||||||
|
|
||||||
|
If not specified, the command returns a summary for the current active batch job.
|
||||||
|
|
||||||
Global Flags
|
Global Flags
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
@ -73,15 +79,15 @@ Global Flags
|
|||||||
Example
|
Example
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Summary the Events of a Replicate Job
|
Summarize the Events of an Active Replicate Job
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The following command provides the real-time summary of an active job on the deployment at :mc:`alias <mc alias>` ``myminio``:
|
The following command provides the real-time summary of an active job on the deployment at :mc:`alias <mc alias>` ``myminio``:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc batch status myminio KwSysDpxcBU9FNhGkn2dCf
|
mc batch status myminio "KwSysDpxcBU9FNhGkn2dCf"
|
||||||
|
|
||||||
- Replace ``myminio`` with the :mc:`alias <mc alias>` of the MinIO deployment that should run the job.
|
- Replace ``myminio`` with the :mc:`alias <mc alias>` of the MinIO deployment that should run the job.
|
||||||
|
|
||||||
@ -90,13 +96,16 @@ The output of the above command is similar to the following:
|
|||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
●∙∙
|
●∙∙
|
||||||
|
JobType: replicate
|
||||||
Objects: 28766
|
Objects: 28766
|
||||||
Versions: 28766
|
Versions: 28766
|
||||||
Throughput: 3.0 MiB/s
|
FailedObjects: 0
|
||||||
Transferred: 406 MiB
|
Transferred: 406 MiB
|
||||||
Elapsed: 2m14.227222868s
|
Elapsed: 2m14.227222868s
|
||||||
CurrObjName: share/doc/xml-core/examples/foo.xmlcatalogs
|
CurrObjName: share/doc/xml-core/examples/foo.xmlcatalogs
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
S3 Compatibility
|
S3 Compatibility
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -320,7 +320,7 @@ The command accepts the following arguments:
|
|||||||
|
|
||||||
Tenant ID for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
Tenant ID for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
||||||
|
|
||||||
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using an service principal identity.
|
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using a service principal identity.
|
||||||
This option has no effect for any other value of ``TIER_TYPE``.
|
This option has no effect for any other value of ``TIER_TYPE``.
|
||||||
|
|
||||||
.. mc-cmd:: --azure-sp-client-id
|
.. mc-cmd:: --azure-sp-client-id
|
||||||
@ -328,7 +328,7 @@ The command accepts the following arguments:
|
|||||||
|
|
||||||
Client ID for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
Client ID for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
||||||
|
|
||||||
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using an service principal identity.
|
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using a service principal identity.
|
||||||
This option has no effect for any other value of ``TIER_TYPE``.
|
This option has no effect for any other value of ``TIER_TYPE``.
|
||||||
|
|
||||||
.. mc-cmd:: --azure-sp-client-secret
|
.. mc-cmd:: --azure-sp-client-secret
|
||||||
@ -336,7 +336,7 @@ The command accepts the following arguments:
|
|||||||
|
|
||||||
The client secret for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
The client secret for the `service principal account <https://learn.microsoft.com/en-us/cli/azure/azure-cli-sp-tutorial-1>`__ to use to log in to Azure storage.
|
||||||
|
|
||||||
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using an service principal identity.
|
This option only applies if :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure`` and you log in using a service principal identity.
|
||||||
This option has no effect for any other value of ``TIER_TYPE``.
|
This option has no effect for any other value of ``TIER_TYPE``.
|
||||||
|
|
||||||
Global Flags
|
Global Flags
|
||||||
|
@ -114,12 +114,15 @@ Syntax
|
|||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
mc ilm tier update TARGET \
|
mc ilm tier update TARGET \
|
||||||
TIER_NAME \
|
TIER_NAME \
|
||||||
[--access-key value] \
|
[--account-key value] \
|
||||||
[--secret-key value] \
|
[--access-key value] \
|
||||||
[--use-aws-role] \
|
[--az-sp-tenant-id value] \
|
||||||
[--account-key value] \
|
[--az-sp-client-id value] \
|
||||||
|
[--az-sp-client-secret value] \
|
||||||
|
[--secret-key value] \
|
||||||
|
[--use-aws-role] \
|
||||||
[--credentials-file value]
|
[--credentials-file value]
|
||||||
|
|
||||||
.. include:: /includes/common-minio-mc.rst
|
.. include:: /includes/common-minio-mc.rst
|
||||||
@ -177,7 +180,41 @@ The command accepts the following arguments:
|
|||||||
Use this option to rotate the credentials for the :mc-cmd:`~mc ilm tier add --account-name` associated to the remote tier.
|
Use this option to rotate the credentials for the :mc-cmd:`~mc ilm tier add --account-name` associated to the remote tier.
|
||||||
|
|
||||||
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure``.
|
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure``.
|
||||||
This option has no effect for any other ``TIER_TYPE``.
|
This option has no effect for any other type of login.
|
||||||
|
|
||||||
|
.. mc-cmd:: --az-sp-tenant-id
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
.. versionadded:: mc RELEASE.2024-07-03T20-17-25Z
|
||||||
|
|
||||||
|
Directory ID for the Azure service principal account.
|
||||||
|
|
||||||
|
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure``.
|
||||||
|
This option has no effect for any other type of login.
|
||||||
|
|
||||||
|
.. mc-cmd:: --az-sp-client-id
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
.. versionadded:: mc RELEASE.2024-07-03T20-17-25Z
|
||||||
|
|
||||||
|
Client ID of the Azure service principal account.
|
||||||
|
|
||||||
|
Requires :mc-cmd:`~mc ilm tier update --az-sp-client-secret`.
|
||||||
|
|
||||||
|
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure``.
|
||||||
|
This option has no effect for any other type of login.
|
||||||
|
|
||||||
|
.. mc-cmd:: --az-sp-client-secret
|
||||||
|
:optional:
|
||||||
|
|
||||||
|
.. versionadded:: mc RELEASE.2024-07-03T20-17-25Z
|
||||||
|
|
||||||
|
The secret for the Azure service principal account.
|
||||||
|
|
||||||
|
Requires :mc-cmd:`~mc ilm tier update --az-sp-client-id`.
|
||||||
|
|
||||||
|
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``azure``.
|
||||||
|
This option has no effect for any other type of login.
|
||||||
|
|
||||||
.. mc-cmd:: --credentials-file
|
.. mc-cmd:: --credentials-file
|
||||||
:optional:
|
:optional:
|
||||||
@ -188,7 +225,7 @@ The command accepts the following arguments:
|
|||||||
The user must have permission to perform read/write/list/delete operations on the remote bucket or bucket prefix.
|
The user must have permission to perform read/write/list/delete operations on the remote bucket or bucket prefix.
|
||||||
|
|
||||||
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``gcs``.
|
This option only applies to remote storage tiers with :mc-cmd:`~mc ilm tier add TIER_TYPE` is ``gcs``.
|
||||||
This option has no effect for any other ``TIER_TYPE``.
|
This option has no effect for any other type of login.
|
||||||
|
|
||||||
Global Flags
|
Global Flags
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
@ -44,15 +44,10 @@ Subcommands
|
|||||||
:start-after: start-mc-license-register-desc
|
:start-after: start-mc-license-register-desc
|
||||||
:end-before: end-mc-license-register-desc
|
:end-before: end-mc-license-register-desc
|
||||||
|
|
||||||
* - :mc:`~mc license update`
|
|
||||||
- .. include:: /reference/minio-mc/mc-license-update.rst
|
|
||||||
:start-after: start-mc-license-update-desc
|
|
||||||
:end-before: end-mc-license-update-desc
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:titlesonly:
|
:titlesonly:
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
/reference/minio-mc/mc-license-info
|
/reference/minio-mc/mc-license-info
|
||||||
/reference/minio-mc/mc-license-register
|
/reference/minio-mc/mc-license-register
|
||||||
/reference/minio-mc/mc-license-update
|
|
Reference in New Issue
Block a user