minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2026-01-04 02:44:36 +03:00
Code Activity

Deprecated command cleanup (#1166)

Browse Source 
- removes `mc admin obd` command
- moves `mc admin profile` to deprecated list

closes #1164

- Moves wildcard matching from `mc mirror` to `minio-mc.rst` page and
adds ref links throughout as needed.
This commit is contained in:
Daryl White
2024-03-28 17:13:35 -04:00
committed by GitHub
parent ef81b3d357
commit 8b5be57ee3
10 changed files with 95 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/administration/identity-access-management/policy-based-access-control.rst
View File

@@ -188,7 +188,7 @@ There is no limit to the number of policy documents that can be attached to a us
- For the ``Statement.Resource`` key, specify the bucket or bucket prefix to which to restrict the policy.
You can use ``*`` and ``?`` wildcard characters as per the :s3-docs:`S3 Resource Spec <s3-arn-format.html>`.
The ``*`` wildcard may result in unintended application of a policy to multiple buckets or prefixes based on the pattern match.
The ``*`` wildcard may result in unintended application of a policy to multiple buckets or prefixes based on the :ref:`pattern match <minio-wildcard-matching>`.
For example, ``arn:aws:s3:::data*`` would match the buckets ``data``, ``data_private``, and ``data_internal``.
Specifying only ``*`` as the resource key applies the policy to all buckets and prefixes on the deployment.

4
source/reference/minio-mc-admin/mc-admin-profile.rst → source/reference/deprecated/mc-admin-profile.rst
View File

@@ -10,6 +10,10 @@
.. mc:: mc admin profile
.. note::
This command has been replaced by :mc:`mc support profile` as of `mc` RELEASE.2023-04-06T16-51-10Z.
Description
-----------

12
source/reference/minio-mc-admin.rst
View File

@@ -85,21 +85,11 @@ The following table lists :mc:`mc admin` commands:
:start-after: start-mc-admin-logs-desc
:end-before: end-mc-admin-logs-desc
* - :mc-cmd:`mc admin obd`
- .. include:: /reference/minio-mc-admin/mc-admin-obd.rst
:start-after: start-mc-admin-obd-desc
:end-before: end-mc-admin-obd-desc
* - :mc:`mc admin policy`
- .. include:: /reference/minio-mc-admin/mc-admin-policy.rst
:start-after: start-mc-admin-policy-desc
:end-before: end-mc-admin-policy-desc
* - :mc-cmd:`mc admin profile`
- .. include:: /reference/minio-mc-admin/mc-admin-profile.rst
:start-after: start-mc-admin-profile-desc
:end-before: end-mc-admin-profile-desc
* - :mc-cmd:`mc admin prometheus`
- .. include:: /reference/minio-mc-admin/mc-admin-prometheus.rst
:start-after: start-mc-admin-prometheus-desc
@@ -200,9 +190,7 @@ See :ref:`minio-mc-global-options`.
/reference/minio-mc-admin/mc-admin-info
/reference/minio-mc-admin/mc-admin-kms-key
/reference/minio-mc-admin/mc-admin-logs
/reference/minio-mc-admin/mc-admin-obd
/reference/minio-mc-admin/mc-admin-policy
/reference/minio-mc-admin/mc-admin-profile
/reference/minio-mc-admin/mc-admin-prometheus
/reference/minio-mc-admin/mc-admin-rebalance
/reference/minio-mc-admin/mc-admin-replicate

69
source/reference/minio-mc-admin/mc-admin-obd.rst
View File

@@ -1,69 +0,0 @@
================
``mc admin obd``
================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin obd
Description
-----------
.. start-mc-admin-obd-desc
The :mc-cmd:`mc admin obd` command generates detailed diagnostics for the
target MinIO deployment as a ``GZIP`` compressed ``JSON`` file. MinIO Support
may request the output of :mc-cmd:`mc admin obd` as part of troubleshooting
and diagnostics.
.. end-mc-admin-obd-desc
:mc-cmd:`mc admin obd` names the file using the following pattern:
.. code-block:: none
alias-health_YYYYMMDDHHMMSS.json.gzip
The ``alias`` is the :mc-cmd:`~mc admin obd TARGET` MinIO deployment from which
:mc-cmd:`mc admin obd` returned the diagnostics.
The :mc-cmd:`mc admin obd` output may contain sensitive information about your
environment. Exercise all possible precautions, such as redacting sensitive
fields, prior to sharing the data on any public forum.
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note
.. include:: /includes/facts-mc-admin.rst
:start-after: start-minio-only
:end-before: end-minio-only
Syntax
------
:mc-cmd:`mc admin obd` has the following syntax:
.. code-block:: shell
:class: copyable
mc admin obd [FLAGS] TARGET
:mc-cmd:`mc admin obd` supports the following arguments:
.. mc-cmd:: TARGET
*Required*
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
the command retrieves the diagnostic data.
.. mc-cmd:: --deadline
The maximum duration the command can run. Specify a string as
``##h##m##s``. Defaults to ``1h0m0s``.

5
source/reference/minio-mc-deprecated.rst
View File

@@ -164,6 +164,10 @@ Table of Deprecated Admin Commands
- :mc-cmd:`mc admin policy attach` or :mc-cmd:`mc admin policy detach`
- mc RELEASE.2023-03-20T17-17-53Z
* - ``mc admin profile``
- :mc:`mc support profile`
- mc RELEASE.2023-04-06T16-51-10Z
* - ``mc admin replicate edit``
- :mc:`mc admin replicate update`
- mc RELEASE.2023-01-11T03-14-16Z
@@ -206,6 +210,7 @@ Table of Deprecated Admin Commands
/reference/deprecated/mc-admin-idp-ldap
/reference/deprecated/mc-admin-idp-ldap-policy
/reference/deprecated/mc-admin-idp-openid
/reference/deprecated/mc-admin-profile
/reference/deprecated/mc-admin-speedtest
/reference/deprecated/mc-admin-tier
/reference/deprecated/mc-admin-top

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

@@ -498,6 +498,60 @@ If you decide to trust the certificate, the MinIO Client adds the certificate to
In testing environments, you can bypass the certificate check for selected MinIO Client commands by passing the ``--insecure`` flag.
.. _minio-wildcard-matching:
Pattern Matching
----------------
Some commands and flags allow for pattern matching.
When enabled, a pattern can include either of these wildcards for character replacement:
- ``*`` to represent a string of characters to match, either in the middle or end.
- ``?`` to represent a single character.
For example, refer to the following examples for wildcard uses and their results.
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
* - Pattern
- Text
- Match Result
* - ``abc*``
- ab
- Match
* - ``abc*``
- abd
- Not a match
* - ``abc*c``
- abcd
- Match
* - ``ab*??d``
- abxxc
- Match
* - ``ab*??d``
- abxc
- Match
* - ``ab??d``
- abxc
- Match
* - ``ab??d``
- abc
- Match
* - ``ab??d``
- abcxdd
- Not a match
.. _minio-mc-global-options:
Global Options

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

@@ -96,7 +96,7 @@ Parameters
.. mc-cmd:: --ignore
:optional:
Exclude objects whose names match the specified wildcard pattern.
Exclude objects whose names match the specified :ref:`wildcard pattern <minio-wildcard-matching>`.
.. mc-cmd:: --larger
:optional:
@@ -127,7 +127,7 @@ Parameters
.. mc-cmd:: --name
:optional:
Return objects whose names match the specified wildcard pattern.
Return objects whose names match the specified :ref:`wildcard pattern <minio-wildcard-matching>`.
.. mc-cmd:: --newer-than
:optional:
@@ -148,7 +148,7 @@ Parameters
.. mc-cmd:: --path
:optional:
Return the contents of directories whose names match the specified wildcard pattern.
Return the contents of directories whose names match the specified :ref:`wildcard pattern <minio-wildcard-matching>`.
.. mc-cmd:: --print
:optional:

55
source/reference/minio-mc/mc-mirror.rst
View File

@@ -376,61 +376,6 @@ Use :mc:`mc mirror` with :mc-cmd:`~mc mirror --exclude-storageclass` to mirror o
Behavior
--------
.. _minio-wildcard-matching:
Wildcard Matching
~~~~~~~~~~~~~~~~~
Some flags allow for name pattern matching.
When enabled, a pattern can include include either of two wildcards for character replacement.
- ``*`` to represent a string of characters to match, either in the middle or end.
- ``?`` to represent a single character.
For example, refer to the following examples for wildcard uses and their results.
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
* - Pattern
- Text
- Match Result
* - ``abc*``
- ab
- Match
* - ``abc*``
- abd
- Not a match
* - ``abc*c``
- abcd
- Match
* - ``ab*??d``
- abxxc
- Match
* - ``ab*??d``
- abxc
- Match
* - ``ab??d``
- abxc
- Match
* - ``ab??d``
- abc
- Match
* - ``ab??d``
- abcxdd
- Not a match
Mirror Continues on Failed Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

@@ -14,31 +14,35 @@
:start-after: start-minio-only
:end-before: end-minio-only
Command History
---------------
The command used to create the diagnostic report has changed over time.
.. dropdown:: Command History
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
The command used to create the diagnostic report has changed over time.
* - MinIO Client Release
- Command
- Notes
* - RELEASE.2020-10-03T02-54-56Z
- ``mc admin health``
- First available
* - RELEASE.2020-11-17T00-39-14Z
- ``mc admin subnet health``
- Command made a SUBNET subcommand
* - RELEASE.2022-02-13T23-26-13Z
- ``mc support diag``
- Command moved to ``mc support``
.. list-table::
:header-rows: 1
:widths: 40 30 30
:width: 100%
* - MinIO Client Release
- Command
- Notes
* - RELEASE.2022-02-13T23-26-13Z
- ``mc support diag``
- Command moved to ``mc support``
* - RELEASE.2020-11-17T00-39-14Z
- ``mc admin subnet health``
- Command made a SUBNET subcommand
* - RELEASE.2020-10-03T02-54-56Z
- ``mc admin health``
- Command renamed to health
* - Original Command
- ``mc admin obd``
- Command renamed ``mc admin health``
Description

3
source/reference/minio-mc/mc-support-inspect.rst
View File

@@ -46,7 +46,8 @@ Exercise caution before sending a report to a third party or posting the report
Wildcards
---------
The command supports wildcard ``*`` pattern matching for prefixes or objects.
The command supports wildcard ``*`` pattern matching for prefixes or objects when using the Bash shell.
For non-Bash shells, a message displays indicating that wildcard patterns are only supported in Bash.
.. code-block:: shell
:class: copyable