From 1e1c4c73f8c7ccafb97fe0385cf62d7f3c59dac2 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Thu, 18 Jan 2024 16:14:24 -0700 Subject: [PATCH] Doc updates for mc RELEASE.2024-01-11T05-49-32Z (#1110) Doc updates for the following: - Document alias naming requirements, including new minimum length rules - `mc tag set --exclude-folders` modifies the behavior of `--recursive` Staged: http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-alias-set.html#mc.alias.set.ALIAS http://192.241.195.202:9000/staging/DOCS-1106/linux/reference/minio-mc/mc-tag-set.html#mc.tag.set.-exclude-folders Fixes https://github.com/minio/docs/issues/1106 --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com> --- source/reference/minio-mc/mc-alias-set.rst | 18 +++++++++++++++++- source/reference/minio-mc/mc-tag-set.rst | 17 +++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/source/reference/minio-mc/mc-alias-set.rst b/source/reference/minio-mc/mc-alias-set.rst index e6c4592c..67198fae 100644 --- a/source/reference/minio-mc/mc-alias-set.rst +++ b/source/reference/minio-mc/mc-alias-set.rst @@ -68,6 +68,22 @@ Parameters .. mc-cmd:: ALIAS *Required* The name to associate to the S3-compatible service. + Aliases are case-sensitive and must meet the following requirements: + + - Contain only `ASCII `__ lower case letters (``a-z``), upper case letters (``A-Z``), numbers (``[0-9]``), hyphen (``-``), or underscore (``_``). + - 2 or more characters in length. + - The first character must be a letter. + + .. versionchanged:: RELEASE.2024-01-11T05-49-32Z + + An alias may also be a single letter (``a-z`` or ``A-Z``). + + Examples of some valid alias values include: + + - ``myminio`` + - ``Test-1`` + - ``A`` + - ``a`` .. mc-cmd:: URL @@ -208,4 +224,4 @@ The MinIO Client fetches the peer certificate, computes the public key fingerpri If trusted, the MinIO Client automatically adds the certificate authority to: - ``~/.mc/certs/CAs/`` on Linux and other Unix-like systems. -- ``C:\Users\[username]\mc\certs\CAs\`` on Windows systems. \ No newline at end of file +- ``C:\Users\[username]\mc\certs\CAs\`` on Windows systems. diff --git a/source/reference/minio-mc/mc-tag-set.rst b/source/reference/minio-mc/mc-tag-set.rst index 995fa8b9..476bcfb8 100644 --- a/source/reference/minio-mc/mc-tag-set.rst +++ b/source/reference/minio-mc/mc-tag-set.rst @@ -86,6 +86,23 @@ Parameters mc tag set myminio/mybucket/object.txt "key1=value1&key2=value2" +.. mc-cmd:: --exclude-folders + :optional: + + .. versionadded:: RELEASE.2024-01-11T05-49-32Z + + When used with :mc-cmd:`~mc tag set --recursive`, causes :mc:`mc tag set` to **not** traverse child prefixes. + Tags are only applied to objects at the specified path. + Requires :mc-cmd:`~mc tag set --recursive`. + + The following example applies the tag ``destination=international`` to objects at ``vacation-photos/cancun/`` but not ``vacation-photos/cancun/ocean/`` or other prefixes. + + For example, the above would add the tags to the object at``vacation-photos/cancun/pretty-beach.jpg`` but not to the object at``vacation-photos/cancun/ocean/tropical-fish.jpg``. + + .. code-block:: shell + + mc tag set myminio/vacation-photos/cancun "destination=international" --exclude-folders --recursive + .. mc-cmd:: --recursive, r :optional: