diff --git a/source/administration/object-management/object-lifecycle-management.rst b/source/administration/object-management/object-lifecycle-management.rst index ee768def..c8310fad 100644 --- a/source/administration/object-management/object-lifecycle-management.rst +++ b/source/administration/object-management/object-lifecycle-management.rst @@ -119,6 +119,9 @@ MinIO has two specific default behaviors for versioned buckets: To expire delete markers when there are no remaining versions for that object, specify the :mc-cmd:`~mc ilm rule add --expire-delete-marker` option when creating the expiration rule. +- To expire *all* versions of an object after a specified period of days, use the :mc-cmd:`~mc ilm rule add --expire-all-object-versions` flag with the :mc-cmd:`~mc ilm rule add --expire-days` flag. + This permits the permanent deletion of the object after the specified number of days pass. + .. _minio-lifecycle-management-scanner: Lifecycle Management Object Scanner diff --git a/source/reference/minio-mc-admin/mc-admin-service.rst b/source/reference/minio-mc-admin/mc-admin-service.rst index 0071f00d..6b092546 100644 --- a/source/reference/minio-mc-admin/mc-admin-service.rst +++ b/source/reference/minio-mc-admin/mc-admin-service.rst @@ -15,15 +15,13 @@ Description .. start-mc-admin-service-desc -The :mc-cmd:`mc admin service` command can restart or stop MinIO servers. +The :mc-cmd:`mc admin service` command can restart or unfreeze MinIO servers. .. end-mc-admin-service-desc :mc-cmd:`mc admin service` affects *all* MinIO servers in the target deployment at the same time. The command interrupts in-progress API operations on -the MinIO deployment. Exercise caution before issuing an update command on -production environments. - +the MinIO deployment. Use caution when issuing this command to a deployment. .. admonition:: Use ``mc admin`` on MinIO Deployments Only :class: note @@ -47,8 +45,8 @@ Restart MinIO Servers in Target Deployment mc admin service restart myminio -Stop MinIO Servers in Target Deployment -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Resume S3 Calls on a Target Deployment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: /includes/play-alias-available.rst :start-after: myminio-alias @@ -57,7 +55,7 @@ Stop MinIO Servers in Target Deployment .. code-block:: shell :class: copyable - mc admin service stop myminio + mc admin service unfreeze myminio Syntax ------ @@ -74,30 +72,29 @@ Syntax .. mc-cmd:: restart Restarts MinIO servers. + If needed, the command may suggest restarting the node based on the status. :mc-cmd:`mc admin service restart` has the following syntax: .. code-block:: shell :class: copyable - mc admin service restart TARGET + mc admin service restart ALIAS Specify the :mc-cmd:`alias ` of a configured MinIO deployment. :mc-cmd:`~mc admin service restart` restarts *all* MinIO servers in the deployment. -.. mc-cmd:: stop +.. mc-cmd:: unfreeze - Stops MinIO servers. + Restart S3 API calls on a MinIO cluster. - :mc-cmd:`mc admin service stop` has the following syntax: + :mc-cmd:`mc admin service unfreeze` has the following syntax: .. code-block:: shell :class: copyable - mc admin service stop TARGET + mc admin service unfreeze ALIAS Specify the :mc-cmd:`alias ` of a configured MinIO deployment. - :mc-cmd:`~mc admin service stop` stops *all* MinIO servers in the - deployment. diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 41e53629..ffd72242 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -242,7 +242,12 @@ The following table lists :mc-cmd:`mc` commands: - .. include:: /reference/minio-mc/mc-find.rst :start-after: start-mc-find-desc :end-before: end-mc-find-desc - + + * - :mc:`mc get` + - .. include:: /reference/minio-mc/mc-get.rst + :start-after: start-mc-get-desc + :end-before: end-mc-get-desc + * - :mc:`mc head` - .. include:: /reference/minio-mc/mc-head.rst :start-after: start-mc-head-desc @@ -345,6 +350,11 @@ The following table lists :mc-cmd:`mc` commands: :start-after: start-mc-pipe-desc :end-before: end-mc-pipe-desc + * - :mc:`mc put` + - .. include:: /reference/minio-mc/mc-put.rst + :start-after: start-mc-put-desc + :end-before: end-mc-put-desc + * - | :mc:`mc quota clear` | :mc:`mc quota info` | :mc:`mc quota set` @@ -590,6 +600,7 @@ You can also define some of these options using :ref:`Environment Variables `, bucket, prefix (if used), and object to download. + +.. mc-cmd:: TARGET + :required: + + The destination path on the local file system where the command should place the downloaded file. + +.. mc-cmd:: --encrypt + :optional: + + Specify the key to use for decrypting and encrypting the downloaded object. + + Requires that you also specify the key to use with the :mc-cmd:`~mc put --encrypt-key` flag. + + Alternatively, set the :envvar:`MC_ENCRYPT` environment variable. + +.. mc-cmd:: --encrypt-key + :optional: + + Specify the key to use for decrypting and encrypting the downloaded object. + + Requires that you also pass the :mc-cmd:`~mc put --encrypt` flag set to ``TRUE``. + + Alternatively, set the :envvar:`MC_ENCRYPT_KEY` environment variable. + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals diff --git a/source/reference/minio-mc/mc-ilm-rule-add.rst b/source/reference/minio-mc/mc-ilm-rule-add.rst index a0dfb4c6..ce76faed 100644 --- a/source/reference/minio-mc/mc-ilm-rule-add.rst +++ b/source/reference/minio-mc/mc-ilm-rule-add.rst @@ -64,6 +64,7 @@ The command supports adding both :ref:`Transition (Tiering) ` processes this command, no versions of the object remain on the deployment. + .. mc-cmd:: --expire-days :optional: diff --git a/source/reference/minio-mc/mc-mirror.rst b/source/reference/minio-mc/mc-mirror.rst index c448aa39..4024a712 100644 --- a/source/reference/minio-mc/mc-mirror.rst +++ b/source/reference/minio-mc/mc-mirror.rst @@ -254,6 +254,13 @@ Parameters See the Amazon documentation on :aws-docs:`Storage Classes ` for more information on S3 storage classses. +.. mc-cmd:: --skip-errors + :optional: + + .. versionadded:: mc RELEASE.2024-01-28T16-23-14Z + + Skip any objects that produce errors while mirroring. + .. mc-cmd:: --summary :optional: diff --git a/source/reference/minio-mc/mc-put.rst b/source/reference/minio-mc/mc-put.rst new file mode 100644 index 00000000..fc5d3040 --- /dev/null +++ b/source/reference/minio-mc/mc-put.rst @@ -0,0 +1,139 @@ +========== +``mc put`` +========== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. mc:: mc put + +.. versionadded:: mc RELEASE.2024-02-24T01-33-20Z + +Syntax +------ + +.. start-mc-put-desc + +The :mc:`mc put` uploads an object from the local file system to a bucket on a target S3 deployment. + +.. end-mc-put-desc + +``mc put`` provides a simplified interface for uploading files compared to :mc:`mc cp` or :mc:`mc mirror`. +``mc put`` uses a one-way upload function that trades efficiency for the power and complexity of the other commands. + + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following uploads the file ``logo.png`` from the local file system at path ``~/images/collateral/`` to a bucket called ``marketing`` on the MinIO deployment with the alias of ``minio``. + + .. code-block:: shell + :class: copyable + + mc put ~/images/collateral/logo.png minio/marketing + + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] put \ + TARGET \ + [--encrypt-key value] \ + [--encrypt value] \ + [--parallel, -P integer] \ + [--part-size, -s string] + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: TARGET + :required: + + The full path to the :ref:`alias ` or prefix where the command should run. + The TARGET *must* contain an :ref:`alias ` and ``bucket`` name. + + The TARGET may also contain the following optional components: + - PREFIX where the object should upload to + - OBJECT-NAME to use in place of the file names + + Valid TARGETs could take any of the following forms: + - ``ALIAS/BUCKET`` + - ``ALIAS/BUCKET/PREFIX`` + - ``ALIAS/BUCKET/OBJECT-NAME`` + - ``ALIAS/BUCKET/PREFIX/OBJECT-NAME`` + +.. mc-cmd:: --encrypt + :optional: + + Specify the key to use for decrypting and encrypting the uploaded object. + + Requires that you also specify the key to use with the :mc-cmd:`~mc put --encrypt-key` flag. + + Alternatively, set the :envvar:`MC_ENCRYPT` environment variable. + +.. mc-cmd:: --encrypt-key + :optional: + + Specify the key to use for decrypting and encrypting the uploaded object. + + Requires that you also pass the :mc-cmd:`~mc put --encrypt` flag set to ``TRUE``. + + Alternatively, set the :envvar:`MC_ENCRYPT_KEY` environment variable. + +.. mc-cmd:: --parallel, --P + :optional: + + For multi-part uploads, specify the number of parts of the object to upload in parallel. + + If not defined, defaults to a value of ``4``. + +.. mc-cmd:: --part-size, -s + :optional: + + Specify the size to use for each part of a multi-part upload. + + If not defined, defaults to a value of ``16MiB``. + + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals + +Examples +-------- + +Upload a File and Specify the Object Name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following command uploads the file ``logo.png`` from the local file system to the ``business`` bucket on the ``minio`` deployment, uploading it on the destination as ``company-logo.png``. + +.. code-block:: shell + :class: copyable + + mc put images/collateral/logo.png minio/business/company-logo.png + +Upload a Multipart Object in Parallel with a Specified Part Size +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following command uploads a file in chunks of 20MiB each and uploads 8 parts of the file in parallel. +8 parts are uploaded in succession until all parts of the object have uploaded. + +.. code-block:: shell + :class: copyable + + mc put ~/videos/collateral/splash-page.mp4 minio/business --parallel 8 --part-size 20MiB