minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

mc updates for RELEASE.2022-12-02T23-48-47Z (#667)

Browse Source 
Updates mc docs for
[RELEASE.2022-12-02T23-48-47Z](623de88abd)
and closes several issues:

- Adds `mc support callhome`
- Simplifies and moves `mc support logs` to `mc admin logs`
- Adds `mc support proxy` command
- Adds `mc admin replicate resync` command

Closes #655 
Closes #663
Closes #644
This commit is contained in:
Daryl White
2022-12-08 14:09:36 -06:00
committed by GitHub
parent d3e40ff232
commit 348758b807
13 changed files with 430 additions and 281 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/includes/common-mc-support.rst
View File

@ -11,6 +11,6 @@
.. start-support-logs-opt-in
The uploading feature remains disabled by default until explicitly enabled for a deployment on an opt-in only basis.
If enabled, you can disable the feature at any time with :mc-cmd:`mc support logs disable`.
If enabled, you can disable the feature at any time with :mc-cmd:`mc support callhome disable`.
.. end-support-logs-opt-in

5
source/operations/install-deploy-manage/multi-site-replication.rst
View File

@ -83,6 +83,11 @@ Any MinIO deployment in the site replication configuration can resynchronize dam
Failed or pending replications requeue automatically when performing any ``GET`` or ``HEAD`` API method.
For example, using :mc:`mc stat`, :mc:`mc cat`, or :mc:`mc ls` commands after a site comes back online prompts healing to requeue.
.. versionchanged:: RELEASE.2022-12-02T23-48-47Z
If one site loses data for any reason, resynchronize the data from another healthy site with :mc:`mc admin replicate resync`.
This launches an active process that resynchronizes the data without waiting for the passive MinIO scanner to recognize the missing data.
Prerequisites
-------------

9
source/operations/troubleshooting.rst
View File

@ -164,11 +164,12 @@ For more details about encrypting or decrypting such files, see :ref:`Encrypting
Logs
----
Use the subcommands for ``mc support logs`` to :mc:`~mc support logs enable` or :mc:`~mc support logs disable` the submission of MinIO logs to SUBNET.
You can also use :mc:`mc support logs status` to check if a log submission is in progress.
Use :mc:`mc support callhome enable` to start automatically uploading deployment logs to SUBNET for analysis.
Use :mc:`mc support callhome status` to check the status of log upload.
You can disable upload at any time using :mc:`mc support callhome disable`.
Use :mc:`mc support logs show` command to display logs from the command line.
Use the parameter flags for the :mc:`mc support logs show` command to limit the displayed logs by type or quantity.
Use :mc:`mc admin logs` command to display logs from the command line.
The command supports type and quantity filters for further limiting logs output.
.. toctree::
:titlesonly:

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

@ -85,6 +85,11 @@ The following table lists :mc:`mc admin` commands:
:start-after: start-mc-admin-kms-key-desc
:end-before: end-mc-admin-kms-key-desc
* - :mc-cmd:`mc admin logs`
- .. include:: /reference/minio-mc-admin/mc-admin-logs.rst
: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

118
source/reference/minio-mc-admin/mc-admin-logs.rst Normal file
View File

@ -0,0 +1,118 @@
=================
``mc admin logs``
=================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs show
.. mc:: mc admin logs
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only
:end-before: end-minio-only
.. versionchanged:: RELEASE.2022-12-02T23-48-47Z
``mc support logs`` moved to ``mc admin logs`` and provide a simpler command interface for displaying server logs for the MinIO deployment.
The output is similar to what is available via ``journalctl -uf minio`` for systemd-controlled deployments.
Description
-----------
.. start-mc-admin-logs-desc
Use the :mc-cmd:`mc admin logs` command to show MinIO server logs.
.. end-mc-admin-logs-desc
To enable or disable the sending of logs to SUBNET for support, use :mc:`mc support callhome`.
.. include:: /includes/common-mc-support.rst
:start-after: start-support-logs-opt-in
:end-before: end-support-logs-opt-in
Examples
--------
Show Logs for a Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command displays the most recent ten server logs of any type for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc admin logs minio1
Show Last 5 Log Entries for a Node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows the most recent five log entries for a ``node1`` on the deployment with alias ``minio1``.
.. code-block:: shell
:class: copyable
mc admin logs --last 5 myminio node1
Show Application Type Log Entires for a Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows log entries of the type ``application`` for all nodes on the deployment with alias ``minio1``.
.. code-block:: shell
:class: copyable
mc admin logs --type application minio1
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc admin logs [GLOBAL FLAGS] \
[--last, -l value] \
[--type, -t value] \
ALIAS \
[NODE]
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` of the MinIO deployment.
.. mc-cmd:: --last, -l
:optional:
Show only the most recent specified number of log entries.
If this flag is not included, up to the last 10 log entries show.
.. mc-cmd:: --type, --type
:optional:
List log entries of a specified type.
Valid types are ``minio``, ``application``, or ``all``.
If not specified, all log entry types show.
.. mc-cmd:: NODE
:optional:
In distributed deployments, specify which node's logs to show by entering the node's name.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

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

@ -62,6 +62,9 @@ The :mc-cmd:`mc admin replicate` command has the following subcommands:
* - :mc-cmd:`mc admin replicate remove`
- Removes an entire site replication configuration or one or more peer sites from participating in site replication.
* - :mc-cmd:`mc admin replicate resync`
- Resynchronizes content from one site to a second site if the second site has lost data.
* - :mc-cmd:`mc admin replicate status`
- Displays the status for :ref:`replicable data <minio-site-replication-what-replicates>` across participating sites.
@ -364,6 +367,65 @@ Syntax
Display the replication status of a specific user by including the user name after the flag.
.. mc-cmd:: resync
:fullpath:
Resynchronizes data from one site in the replication configuration to a second site in the replication configuration in the event of lost data.
.. tab-set::
.. tab-item:: EXAMPLES
The following command starts a resynchronization process to restore ``minio2`` from ``minio1``
.. code-block:: shell
:class: copyable
mc admin replicate resync start minio1 minio2
The following command shows the status of a resynchronization currently in progress.
.. code-block:: shell
:class: copyable
mc admin replicate resync status minio1 minio2
The following command stops a resynchronization that is in progress.
.. code-block:: shell
:class: copyable
mc admin replicate resync cancel minio1 minio2
.. tab-item:: SYNTAX
.. code-block:: shell
mc [GLOBALFLAGS] admin replicate resync start|status|cancel ALIAS1 ALIAS2
- Replace ``ALIAS1`` with the alias for the site that has the data to restore.
- Replace ``ALIAS2`` with the alias for the site that needs resynched data.
.. mc-cmd:: start
Launches a new resynchronization process from one site with data to a second site that needs synchronization.
.. mc-cmd:: status
Shows the status of an existing resynchronization process between two sites configured for site replication.
.. mc-cmd:: cancel
Ends a resynchronization process currently in progress between two sites configured for site replication.
.. mc-cmd:: alias1
The :ref:`alias <alias>` of an active MinIO deployment in the site replication configuration with the data you want to resync to another site.
.. mc-cmd:: alias2
The :ref:`alias <alias>` of an active MinIO deployment in the site replication configuration that needs data resynced from another site.
Global Flags
------------

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

@ -338,13 +338,16 @@ The following table lists :mc-cmd:`mc` commands:
:start-after: start-mc-stat-desc
:end-before: end-mc-stat-desc
* - | :mc:`mc support diag`
* - | :mc:`mc support callhome`
| :mc:`mc support diag`
| :mc:`mc support inspect`
| :mc:`mc support perf`
| :mc:`mc support profile`
| :mc:`mc support proxy`
| :mc:`mc support top`
- The MinIO Client ``mc support`` commands provides tools for analyzing deployment health or performance and for running diagnostics.
You can also upload generated health reports for further analysis by MinIO engineering.
The ``mc support`` commands require an active |SUBNET| registration.
* - | :mc:`mc tag set`
| :mc:`mc tag remove`
@ -538,14 +541,12 @@ All :ref:`commands <minio-mc-commands>` support the following global options:
/reference/minio-mc/mc-share-list
/reference/minio-mc/mc-sql
/reference/minio-mc/mc-stat
/reference/minio-mc/mc-support-callhome
/reference/minio-mc/mc-support-diag
/reference/minio-mc/mc-support-inspect
/reference/minio-mc/mc-support-logs-disable
/reference/minio-mc/mc-support-logs-enable
/reference/minio-mc/mc-support-logs-show
/reference/minio-mc/mc-support-logs-status
/reference/minio-mc/mc-support-perf
/reference/minio-mc/mc-support-profile
/reference/minio-mc/mc-support-proxy
/reference/minio-mc/mc-support-top
/reference/minio-mc/mc-tag-set
/reference/minio-mc/mc-tag-list

139
source/reference/minio-mc/mc-support-callhome.rst Normal file
View File

@ -0,0 +1,139 @@
=======================
``mc support callhome``
=======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs disable
.. mc:: mc support logs enable
.. mc:: mc support logs status
.. mc:: mc support callhome
Description
-----------
The :mc-cmd:`mc support callhome` command allows the enabling or disabling of reports from a deployment to |SUBNET|.
All ``mc support`` commands require an active SUBNET subscription.
When enabled, MinIO can send logs to SUBNET in real time, diagnostics every 24 hours, or both.
MinIO disables this functionality by default, regardless of registration status.
You must explicitly enable the ``callhome`` function to begin real time log upload.
Syntax
------
.. mc-cmd:: enable
:fullpath:
Begin sending a deployment's diagnostics, logs, or both to SUBNET.
.. code-block:: shell
mc support callhome enable \
ALIAS \
[--logs] \
[--diag]
.. mc-cmd:: disable
:fullpath:
Stop sending a deployment's diagnostics, logs, or both to SUBNET.
.. code-block:: shell
mc support callhome disable \
ALIAS \
[--logs] \
[--diag]
.. mc-cmd:: status
:fullpath:
Output whether a deployment currently sends diagnostics, logs, or both to SUBNET.
.. code-block:: shell
mc support callhome status \
ALIAS \
[--logs] \
[--diag]
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` of the MinIO deployment.
.. mc-cmd:: --logs
:optional:
Send or stop sending log information to SUBNET in real time.
.. mc-cmd:: --diag
:optional:
Send or stop sending deployment diagnostic information to SUBNET every 24 hours.
If you do not pass either ``--logs`` or ``--diag``, the command applies to both logs and diagnostics.
Examples
--------
Enable ``callhome`` Reporting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enable the sending of data for deployment with the alias ``minio1``.
When enabled for a deployment registered to SUBNET, MinIO sends logs and diagnostics to SUBNET.
.. code-block:: shell
:class: copyable
mc support callhome enable minio1
Enable ``callhome`` Reporting for Logs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enable logs callhome for a deployment with the alias ``minio1``.
When enabled for a deployment registered to SUBNET, MinIO sends logs to SUBNET in real time.
.. code-block:: shell
:class: copyable
mc support callhome enable minio1 --logs
Disable ``callhome`` Logs
~~~~~~~~~~~~~~~~~~~~~~~~~
Disable sending real time information to SUBNET for a deployment registered to SUBNET with an :ref:`alias <alias>` of ``minio1``.
.. code-block:: shell
:class: copyable
mc support callhome disable minio1
Display Current ``callhome`` Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Display whether a deployment with the alias ``minio1`` sends diagnostics or logs to SUBNET.
.. code-block:: shell
:class: copyable
mc support callhome status minio1
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

53
source/reference/minio-mc/mc-support-logs-disable.rst
View File

@ -1,53 +0,0 @@
===========================
``mc support logs disable``
===========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs disable
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only
:end-before: end-minio-only
Description
-----------
Use the :mc-cmd:`mc support logs disable` command to disable the uploading of real-time MinIO logs to |subnet|.
.. include:: /includes/common-mc-support.rst
:start-after: start-support-logs-opt-in
:end-before: end-support-logs-opt-in
Example
-------
Disable Logs from Uploading to SUBNET
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command disables console logs from uploading to SUBNET for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support logs disable minio1
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc [GLOBAL FLAGS] support logs disable ALIAS
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

64
source/reference/minio-mc/mc-support-logs-enable.rst
View File

@ -1,64 +0,0 @@
==========================
``mc support logs enable``
==========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs enable
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only
:end-before: end-minio-only
Description
-----------
Use the :mc-cmd:`mc support logs enable` command to allow real-time MinIO logs to upload to |subnet|.
.. include:: /includes/common-mc-support.rst
:start-after: start-support-logs-opt-in
:end-before: end-support-logs-opt-in
.. admonition:: Sensitive Data
:class: important
By default, MinIO does not scrub the logs uploaded to SUBNET.
To hide sensitive information in the logs, start the server with the :mc-cmd:`~minio server --anonymous` flag.
MinIO employs an aggressive scrubbing algorithm which may produce logs with reduced visibility into the deployment.
MinIO Engineering may later request unredacted logs if required for ongoing support cases.
Example
-------
Enable Automatic Upload of MinIO Logs to SUBNET
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command starts sending the MinIO deployment's server logs to SUBNET for the alias ``minio1``.
.. code-block::
:class: copyable
mc support logs enable minio1
Syntax
------
The command has the following syntax:
.. code-block::
mc [GLOBAL FLAGS] support logs enable ALIAS
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
.. default-domain:: minio

100
source/reference/minio-mc/mc-support-logs-show.rst
View File

@ -1,100 +0,0 @@
========================
``mc support logs show``
========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs show
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only
:end-before: end-minio-only
Description
-----------
Use the :mc-cmd:`mc support logs show` command to display MinIO server logs.
Examples
--------
Show Logs for the Alias ``minio1``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows logs for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support logs show minio1
Show Last Five Log Entries for a Specific Node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows the last five log entries on the node ``node1`` for a MinIO server with the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support logs show --last 5 minio1 node1
Show Application Log Entries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows the application logs for a MinIO server with the alias ``minio1``.
.. include:: /includes/common-mc-support.rst
:start-after: start-support-logs-opt-in
:end-before: end-support-logs-opt-in
.. code-block:: shell
:class: copyable
mc support logs show --type application minio1
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc [GLOBALFLAGS] support logs show \
[--last] \
[--type] \
ALIAS
Parameters
~~~~~~~~~~
.. mc-cmd:: --last
:optional:
Show the most recent log entries to a specified number.
Takes an integer value.
If not specified, the command shows the last 10 log entries.
.. mc-cmd:: --type
:optional:
List error logs by type.
Valid types:
- ``application``
- ``minio``
- ``all``
Defaults to ``all``.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

54
source/reference/minio-mc/mc-support-logs-status.rst
View File

@ -1,54 +0,0 @@
==========================
``mc support logs status``
==========================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support logs status
.. include:: /includes/common-mc-support.rst
:start-after: start-minio-only
:end-before: end-minio-only
Description
-----------
Use the :mc-cmd:`mc support logs status` command to output whether the specified ALIAS is set to automatically upload logs to |subnet|.
.. include:: /includes/common-mc-support.rst
:start-after: start-support-logs-opt-in
:end-before: end-support-logs-opt-in
Example
-------
Display Whether Logs Are Currently Uploading to SUBNET
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command outputs whether logs are currently uploading to SUBNET for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support logs status minio1
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc [GLOBAL FLAGS] support logs enable ALIAS
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals

89
source/reference/minio-mc/mc-support-proxy.rst Normal file
View File

@ -0,0 +1,89 @@
====================
``mc support proxy``
====================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc support proxy
Description
-----------
Use the :mc-cmd:`mc support proxy` command to configure a proxy to use to communicate with |SUBNET|.
Examples
--------
Set a Proxy URL
~~~~~~~~~~~~~~~
Define the proxy URL to use when the deployment ``minio1`` communicates to SUBNET.
The proxy URL in the example is ``http://my.proxy``.
.. code-block:: shell
:class: copyable
mc support proxy set minio1 http://my.proxy
Remove the Proxy URL Congifugred for a Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command removes the URL configured as the proxy for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support proxy remove minio1
Disable ``callhome`` Logs
~~~~~~~~~~~~~~~~~~~~~~~~~
The following command shows the URL configured as the proxy for the alias ``minio1``.
.. code-block:: shell
:class: copyable
mc support proxy show minio1
Syntax
------
.. mc-cmd:: set
:fullpath:
Create a proxy URL for the MinIO deployment to use when communicating with |SUBNET|.
.. code-block:: shell
mc support proxy set ALIAS PROXY_URL
.. mc-cmd:: show
:fullpath:
Display the current proxy URL configured for communicating with |SUBNET|.
.. code-block:: shell
mc support proxy show ALIAS
.. mc-cmd:: remove
:fullpath:
Remove the proxy URL configured for communicating with |SUBNET|.
.. code-block:: shell
mc support proxy remove ALIAS
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals