mirror of
https://github.com/minio/docs.git
synced 2025-04-25 17:22:39 +03:00
f05c657e99
- Adds Audit Kafka tab to list of settings sections - Adds info about diagnostic report uploading to SUBNET Closes #788
166 lines
6.9 KiB
ReStructuredText
166 lines
6.9 KiB
ReStructuredText
|
|
.. _minio-console-managing-deployment:
|
|
|
|
========================
|
|
Managing Your Deployment
|
|
========================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
You can use the MinIO Console to perform many of the deployment monitoring and management functions available in MinIO, such as:
|
|
|
|
- :ref:`Monitor <minio-console-monitoring>` the deployment activity and health by viewing a dashboard of metrics, server or audit logs, trace history, S3 events, or drive health.
|
|
- Configure alerts by adding or managing a :ref:`notification target <minio-console-notifications>`.
|
|
- Set up :ref:`site replication <minio-console-site-replication>` to synchronize datacenters for timely access across geographically dispersed workforces or for disaster preparedness.
|
|
- Configure deployment :ref:`settings <minio-console-settings>`.
|
|
|
|
.. _minio-console-monitoring:
|
|
|
|
Monitoring
|
|
----------
|
|
|
|
The :guilabel:`Monitoring` section provides an interface for monitoring the MinIO deployment.
|
|
|
|
The section contains the following subsections:
|
|
Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions <minio-policy-mc-admin-actions>`.
|
|
|
|
Metrics
|
|
~~~~~~~
|
|
|
|
The Console :guilabel:`Dashboard` section displays metrics for the MinIO deployment.
|
|
The default view provides a high-level overview of the deployment status, including the uptime and availability of individual servers and drives.
|
|
|
|
The Console also supports displaying time-series and historical data by querying a :prometheus-docs:`Prometheus <prometheus/latest/getting_started/>` service configured to scrape data from the MinIO deployment.
|
|
Specifically, the MinIO Console uses :prometheus-docs:`Prometheus query API <prometheus/latest/querying/api/>` to retrieve stored metrics data and display historical metrics:
|
|
|
|
See :ref:`minio-console-metrics` for more information on the historical metric visualization.
|
|
|
|
Logs
|
|
~~~~
|
|
|
|
The Console :guilabel:`Logs` section displays :ref:`server logs <minio-logging>` generated by the MinIO Deployment.
|
|
|
|
- Use the :guilabel:`Nodes` dropdown to filter logs to a subset of server nodes in the MinIO deployment.
|
|
|
|
- Use the :guilabel:`Log Types` dropdown to filter logs to a subset of log types.
|
|
|
|
- Use the :guilabel:`Filter` to apply text filters to the log results
|
|
|
|
Select the :guilabel:`Start Logs` button to begin collecting logs using the selected filters and settings.
|
|
|
|
Audit
|
|
~~~~~
|
|
|
|
.. important::
|
|
|
|
MinIO plans to deprecate the Tenant Console Audit Log feature and remove it in an upcoming release.
|
|
As an alternative, use any webhook-capable database or logging service to capture :ref:`audit logs <minio-logging-publish-audit-logs>` from the Tenant.
|
|
|
|
The Audit Log section provides an interface for viewing :ref:`audit logs <minio-logging>` collected by a configured PostgreSQL service.
|
|
|
|
The Audit Logging feature is configured and enabled automatically for MinIO deployments created using the :ref:`MinIO Operator Console <minio-operator-console>`.
|
|
|
|
Trace
|
|
~~~~~
|
|
|
|
The :guilabel:`Trace` section provides HTTP trace functionality for a bucket or buckets on the deployment.
|
|
This section provides similar functionality to :mc:`mc admin trace`.
|
|
|
|
You can modify the trace to show only specific trace calls.
|
|
The default is to show only :guilabel:`S3` related HTTP traces.
|
|
|
|
Select :guilabel:`Filters` to open additional filters to apply to trace output, such as restricting the :guilabel:`Path` on which the trace applies to a specific bucket or bucket prefix.
|
|
|
|
Watch
|
|
~~~~~
|
|
|
|
The :guilabel:`Watch` section displays S3 events as they occur on the selected bucket.
|
|
This section provides similar functionality to :mc:`mc watch`.
|
|
|
|
Drives
|
|
~~~~~~
|
|
|
|
The :guilabel:`Drives` section displays the healing status for a bucket.
|
|
MinIO automatically heals objects and drives when it detects problems, such as drive-level corruption or a replacement drive.
|
|
|
|
.. important::
|
|
|
|
MinIO does not recommend performing manual healing unless explicitly directed by support.
|
|
|
|
|
|
.. _minio-console-notifications:
|
|
|
|
Events
|
|
------
|
|
|
|
.. versionchanged:: Console 0.23.1
|
|
|
|
Notifications section renamed to Events.
|
|
|
|
The :guilabel:`Events` section provides an interface to view, add, or remove :ref:`Event Notification <minio-bucket-notifications>` targets.
|
|
|
|
You can use this screen configure MinIO to push notification events to the one or more target destinations, including Redis, MySQL, Kafka, PostgreSQL, AMQP, MQTT, Elastic Search, NATS, NSQ, or a Webhook.
|
|
|
|
Select the :guilabel:`Add Event Destination +` button to add a new event target to the deployment.
|
|
|
|
You can select an existing notification target from the list to view its details or delete the target.
|
|
|
|
.. _minio-console-site-replication:
|
|
|
|
Site Replication
|
|
----------------
|
|
|
|
The :guilabel:`Site Replication` section provides an interface for adding and managing the :ref:`site replication <minio-site-replication-overview>` configuration for the deployment.
|
|
|
|
Configuring site replication requires that only a single site have existing buckets or objects (if any).
|
|
|
|
.. _minio-console-encryption:
|
|
|
|
Encryption
|
|
----------
|
|
|
|
The :guilabel:`Encryption` setting provides an interface for listing, creating, and deleting keys for use with :ref:`MinIO Server-Side Encryption <minio-sse>`.
|
|
|
|
You can use keys created or listed in this view for object encryption operations, including setting a :ref:`bucket-level default key <minio-console-buckets>`.
|
|
|
|
.. important::
|
|
|
|
Deleting a key prevents MinIO from decrypting any objects protected with that key.
|
|
If no backups of that key exist, deleting a key renders objects permanently unreadable.
|
|
See :ref:`minio-encryption-sse-secure-erasure-locking` for more information.
|
|
|
|
.. _minio-console-settings:
|
|
|
|
Settings
|
|
--------
|
|
|
|
The :guilabel:`Settings` section provides an interface for viewing and retrieving :ref:`configuration settings <minio-server-configuration-settings>` for all MinIO Servers in the deployment.
|
|
Use the buttons to :guilabel:`Export` and :guilabel:`Import` the settings between deployments.
|
|
|
|
This section contains the following subsections.
|
|
|
|
- Region
|
|
- Compression
|
|
- API
|
|
- Heal
|
|
- Scanner
|
|
- Etcd
|
|
- Logger Webhook
|
|
- Audit :ref:`Webhook <minio-bucket-notifications-publish-webhook>`
|
|
- Audit :ref:`Kafka <minio-bucket-notifications-publish-kafka>`
|
|
|
|
.. versionadded:: Console v0.24.0
|
|
|
|
Environment variable configuration settings override any customizations added in the MinIO Console.
|
|
Hover your mouse cover over a configuration field to display a tooltip that indicates whether an environment variable controls the setting.
|
|
|
|
Some subsections may not be visible if the authenticated user does not have the :ref:`required administrative permissions <minio-policy-mc-admin-actions>`.
|
|
|
|
The interface functionality mimics that of using :mc-cmd:`mc admin config get` or :mc-cmd:`mc admin config set`.
|
|
Refer to those commands for details on how to define the many options.
|
|
|
|
Some configuration settings may require restarting the MinIO deployment to apply changes. |