1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +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
2022-12-08 14:09:36 -06:00
committed by GitHub
parent d3e40ff232
commit 348758b807
13 changed files with 430 additions and 281 deletions

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

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
------------