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

Updates docs of mc release RELEASE.2023-04-12T02-21-51Z (#850)

Browse Source 
- Adds info to `mc ilm restore` about using `mc stat`
- Adds additional flag to `mc admin replicate update` syntax
- Adds metadata tags flags to `mc find`, plus examples

Closes #815
This commit is contained in:
Daryl White
2023-05-12 11:36:19 -05:00
committed by GitHub
parent b3fdcef007
commit 947b16155a
4 changed files with 95 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/operations/checklists/software.rst
View File

@ -22,7 +22,7 @@ MinIO Pre-requisites
* - :octicon:`circle`
- Servers running a Linux operating system with a 5.x+ kernel, such as Red Hat Enterprise Linux (RHEL) 9 or Ubuntu LTS 20.04+
* - :opticon:`circle`
* - :octicon:`circle`
- A method to synchronize time servers across nodes, such as with ``ntp``, ``timedatectl`` or ``timesyncd``.
The method to use varies by operating system.
Check with your operating system's documentation for how to synchronize time with a time server.

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

@ -129,7 +129,6 @@ Syntax
Then include one or more additional :ref:`aliases <alias>` to add to the existing site replication.
The deployments to add must be empty.
.. mc-cmd:: update
:fullpath:
@ -157,10 +156,11 @@ Syntax
.. code-block:: shell
mc [GLOBALFLAGS] admin replicate update \
mc [GLOBALFLAGS] admin replicate update \
ALIAS \
--deployment-id [deploymentID] \
--endpoint [newEndpoint]
--endpoint [newEndpoint] \
--sync ["enable" | "disable"]
.. mc-cmd:: ALIAS
:required:

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

@ -17,8 +17,8 @@ Syntax
.. start-mc-find-desc
The :mc:`mc find` command supports searching for objects on a MinIO
deployment. You can also use the command to search for files on a filesystem.
The :mc:`mc find` command supports searching for objects on a MinIO deployment.
You can also use the command to search for files on a filesystem.
.. end-mc-find-desc
@ -46,6 +46,7 @@ deployment. You can also use the command to search for files on a filesystem.
[--ignore "string"] \
[--larger "string"] \
[--maxdepth "string"] \
[--metadata "string"] \
[--name "string"] \
[--newer-than "string"] \
[--older-than "string"] \
@ -53,6 +54,7 @@ deployment. You can also use the command to search for files on a filesystem.
[--print "string"] \
[--regex "string"] \
[--smaller "string"] \
[--tags "string"]` \
[--versions] \
[--watch] \
ALIAS
@ -75,7 +77,7 @@ Parameters
mc find play/mydata/
For objects on a filesyste, specify the full path to search.
For objects on a filesystem, specify the full path to search.
For example:
.. code-block:: shell
@ -106,6 +108,22 @@ Parameters
Limits directory navigation to the specified depth.
.. mc-cmd:: --metadata
:optional:
.. versionadded:: mc RELEASE.2023-04-12T02-21-51Z
**For use with MinIO deployments only.**
Return objects with metadata that matches a specified ``key=value``.
Use the format ``--metadata="KEY=value"``.
You can pass a key with an empty value.
In that case, ``mc find`` matches objects that do not have the metadata key or where the metadata key's value is empty.
You can use the flag multiple times to match objects for additional metadata keys.
To return, an object must have matching values for all metadata keys.
.. mc-cmd:: --name
:optional:
@ -144,10 +162,26 @@ Parameters
Returns objects or the contents of directories whose names match
the specified PCRE regex pattern.
.. mc-cmd:: --tags
:optional:
.. versionadded:: mc RELEASE.2023-04-12T02-21-51Z
**For use with MinIO deployments only.**
Return objects with a tag that matches a specified `RE2 RegEx pattern <https://github.com/google/re2/wiki/Syntax>`__.
Use the format ``--tag="KEY=regexValue"``.
You can pass a key with an empty value.
In that case, ``mc find`` matches objects that do not have the metadata key or where the metadata key's value is empty.
You can use the flag multiple times to match objects for additional tags.
To return, an object must have matching values for all tags.
.. mc-cmd:: --smaller
:optional:
Match all objects smaller than the specifized size in
Match all objects smaller than the specified size in
:ref:`units <mc-find-units>`.
.. mc-cmd:: --versions
@ -187,7 +221,7 @@ Find a Specific Object in a Bucket
- Replace :mc-cmd:`NAME <mc find --name>` with the object.
Find Objects with File Extention in Bucket
Find Objects with File Extension in Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
@ -201,8 +235,7 @@ Find Objects with File Extention in Bucket
- Replace :mc-cmd:`PATH <mc find ALIAS>` with the path to a bucket on the
S3-compatible host.
- Replace :mc-cmd:`EXTENSION <mc find --name>` with the file extention of the
object.
- Replace :mc-cmd:`EXTENSION <mc find --name>` with the file extension of the object.
Find All Matching Files and Copy To S3 Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -220,8 +253,7 @@ output of :mc:`mc find` to an S3-compatible host.
- Replace :mc-cmd:`FILEPATH <mc find ALIAS>` with the full file path to the
directory to search.
- Replace :mc-cmd:`EXTENSION <mc find --name>` with the file extention of the
object.
- Replace :mc-cmd:`EXTENSION <mc find --name>` with the file extension of the object.
- Replace :mc-cmd:`ALIAS <mc find ALIAS>` with the
:mc:`alias <mc alias>` of the S3-compatible host.
@ -237,6 +269,50 @@ include the :mc-cmd:`~mc find --watch` argument:
mc find --watch FILEPATH --name "*.EXTENSION" --exec "mc cp {} ALIAS/PATH"
Find Objects with a Matching Tag
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
Tag matching is only available for use on MinIO deployments.
.. code-block:: shell
:class: copyable
mc find --tags="key=v*" ALIAS/BUCKET/
- Replace ``key`` with the name of a tag key to match.
- Replace ``v*`` with the RE2 Regular Expression to evaluate against.
- Replace ``ALIAS`` with the :mc:`alias <mc alias>` of the MinIO deployment.
- Replace ``BUCKET`` with the bucket or prefix to search.
You can add additional ``--tags="key=RegExpression"`` flags to match.
Matching objects must match all included tags.
Find Objects with Matching Metadata
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
Metadata matching is only available for use on MinIO deployments.
.. code-block:: shell
:class: copyable
mc find --json --metadata="content-type=text/csv" ALIAS/BUCKET/
- Replace ``content-type=text/csv`` with the a key-value pair of the metadata field and value to match.
- Replace ``ALIAS`` with the :mc:`alias <mc alias>` of the MinIO deployment.
- Replace ``BUCKET`` with the bucket or prefix to search.
You can add additional ``--tags="metadata=value"`` flags to match.
Matching objects must match all included metadata fields.
Behavior
--------
@ -267,7 +343,7 @@ specified size value:
- GB (Gigabyte, 1000 Megabytes)
* - ``t``
- TB (Terrabyte, 1000 Gigabytes)
- TB (Terabyte, 1000 Gigabytes)
* - ``ki``
- KiB (Kibibyte, 1024 Bites)

5
source/reference/minio-mc/mc-ilm-restore.rst
View File

@ -26,6 +26,11 @@ Use this command to allow applications to access a tiered object through the
MinIO deployment (e.g. "hot tier"). The archived object remains on the remote
tier, while the temporary copy becomes ``HEAD`` for that object.
.. versionadded:: mc RELEASE.2023-04-12T02-21-51Z
Use :mc:`mc stat` to display whether a restored object reads from the local temporary copy or the remote tier.
Restored objects read from the local copy show a status of ``Ongoing : true``.
.. tab-set::
.. tab-item:: EXAMPLE