mirror of
https://github.com/minio/docs.git
synced 2025-08-09 13:02:53 +03:00
mc updates for RELEASE.2022-12-02T23-48-47Z (#667)
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
GitHub
139
source/reference/minio-mc/mc-support-callhome.rst
Normal file
139
source/reference/minio-mc/mc-support-callhome.rst
Normal 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
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
89
source/reference/minio-mc/mc-support-proxy.rst
Normal 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
|
||||
|
||||
Reference in New Issue
Block a user