Skip to content

Commit f54d142

Browse files
authored
Deprecates logs for mc support callhome (#1395)
SUBNET no longer supports the uploading of logs. The flags still exist in the MinIO Client, but no longer function. Opportunistic fix to clarify that s3v4 is a signature type, not an API. No issue to link.
1 parent 801bd33 commit f54d142

File tree

2 files changed

+31
-23
lines changed

2 files changed

+31
-23
lines changed

source/reference/minio-mc/mc-support-callhome.rst

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ Description
1919

2020
.. start-mc-support-callhome-desc
2121
22-
The :mc-cmd:`mc support callhome` command allows the enabling or disabling of reports from a deployment to |SUBNET|.
22+
The :mc-cmd:`mc support callhome` command allows the enabling or disabling of diagnostic information from a deployment to |SUBNET|.
2323

2424
.. end-mc-support-callhome-desc
2525
2626
All ``mc support`` commands require an active SUBNET subscription.
2727

28-
When enabled, MinIO can send logs to SUBNET in real time, diagnostics every 24 hours, or both.
28+
When enabled, MinIO sends diagnostic information to SUBNET.
2929

3030
MinIO disables this functionality by default, regardless of registration status.
31-
You must explicitly enable the ``callhome`` function to begin real time log upload.
31+
You must explicitly enable the ``callhome`` function to begin information upload.
3232

3333
.. include:: /includes/common-mc-support.rst
3434
:start-after: start-minio-only
@@ -49,6 +49,10 @@ Syntax
4949
[--logs] \
5050
[--diag]
5151
52+
.. note::
53+
54+
The ``--logs`` and ``--diag`` flags are no longer supported in SUBNET and will be removed in a future release.
55+
5256
.. mc-cmd:: disable
5357
:fullpath:
5458

@@ -61,6 +65,10 @@ Syntax
6165
[--logs] \
6266
[--diag]
6367
68+
.. note::
69+
70+
The ``--logs`` and ``--diag`` flags are no longer supported in SUBNET and will be removed in a future release.
71+
6472
.. mc-cmd:: status
6573
:fullpath:
6674

@@ -72,6 +80,10 @@ Syntax
7280
ALIAS \
7381
[--logs] \
7482
[--diag]
83+
84+
.. note::
85+
86+
The ``--logs`` and ``--diag`` flags are no longer supported in SUBNET and will be removed in a future release.
7587

7688
Parameters
7789
~~~~~~~~~~
@@ -84,55 +96,51 @@ Parameters
8496
.. mc-cmd:: --logs
8597
:optional:
8698

99+
.. note::
100+
101+
This option is no longer supported in SUBNET and will be removed in a future release.
102+
87103
Send or stop sending log information to SUBNET in real time.
88104

89105
.. mc-cmd:: --diag
90106
:optional:
91107

108+
.. note::
109+
110+
This option is no longer supported in SUBNET and will be removed in a future release.
111+
92112
Send or stop sending deployment diagnostic information to SUBNET every 24 hours.
93113

94114
If you do not pass either ``--logs`` or ``--diag``, the command applies to both logs and diagnostics.
95115

96116
Examples
97117
--------
98118

99-
Enable ``callhome`` Reporting
119+
Enable ``callhome`` reporting
100120
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101121

102-
Enable the sending of data for deployment with the alias ``minio1``.
103-
When enabled for a deployment registered to SUBNET, MinIO sends logs and diagnostics to SUBNET.
122+
Enable sending diagnostic information to SUBNET for a deployment registered to SUBNET with an :ref:`alias <alias>` of ``minio1``.
104123

105124
.. code-block:: shell
106125
:class: copyable
107126
108127
mc support callhome enable minio1
109128
110-
Enable ``callhome`` Reporting for Logs
111-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112-
113-
Enable logs callhome for a deployment with the alias ``minio1``.
114-
When enabled for a deployment registered to SUBNET, MinIO sends logs to SUBNET in real time.
115-
116-
.. code-block:: shell
117-
:class: copyable
118-
119-
mc support callhome enable minio1 --logs
120-
121-
Disable ``callhome`` Logs
122-
~~~~~~~~~~~~~~~~~~~~~~~~~
129+
Disable ``callhome`` reporting
130+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123131

124-
Disable sending real time information to SUBNET for a deployment registered to SUBNET with an :ref:`alias <alias>` of ``minio1``.
132+
Disable sending diagnostic information to SUBNET for a deployment registered to SUBNET with an :ref:`alias <alias>` of ``minio1``.
125133

126134
.. code-block:: shell
127135
:class: copyable
128136
129137
mc support callhome disable minio1
130138
131139
132-
Display Current ``callhome`` Settings
140+
Display Current ``callhome`` settings
133141
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134142

135-
Display whether a deployment with the alias ``minio1`` sends diagnostics or logs to SUBNET.
143+
Display whether a deployment with the alias ``minio1`` sends information to SUBNET.
136144

137145
.. code-block:: shell
138146
:class: copyable

source/reference/minio-mc/minio-client-settings.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Host Credentials
2525
Use this setting to add a temporary alias to use for `mc` commands.
2626
For example, for use with scripting.
2727

28-
The temporary alias uses the :aws-docs:`AWS s3v4 API <AmazonS3/latest/API/sig-v4-authenticating-requests.html>`.
28+
The temporary alias uses the :aws-docs:`AWS s3v4 signature <AmazonS3/latest/API/sig-v4-authenticating-requests.html>`.
2929

3030
.. tab-set::
3131

0 commit comments

Comments
 (0)