docs/source/administration/console/managing-deployment.rst

Managing Your Deployment

minio

Table of Contents

You can use the MinIO Console to perform many of the deployment monitoring and management functions available in MinIO, such as:

• 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 notification target <minio-console-notifications>.
• Set up site replication <minio-console-site-replication> to synchronize datacenters for timely access across geographically dispersed workforces or for disaster preparedness.
• Configure deployment settings <minio-console-settings>.

Monitoring

The 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 required administrative permissions <minio-policy-mc-admin-actions>.

Metrics

The Console 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 <prometheus/latest/getting_started/> service configured to scrape data from the MinIO deployment. Specifically, the MinIO Console uses Prometheus query API <prometheus/latest/querying/api/> to retrieve stored metrics data and display historical metrics:

See minio-console-metrics for more information on the historical metric visualization.

Logs

The Console Logs section displays server logs <minio-logging> generated by the MinIO Deployment.

• Use the Nodes dropdown to filter logs to a subset of server nodes in the MinIO deployment.
• Use the Log Types dropdown to filter logs to a subset of log types.
• Use the Filter to apply text filters to the log results

Select the 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 audit logs <minio-logging-publish-audit-logs> from the Tenant.

The Audit Log section provides an interface for viewing 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 MinIO Operator Console <minio-operator-console>.

Trace

The Trace section provides HTTP trace functionality for a bucket or buckets on the deployment. This section provides similar functionality to mc admin trace.

You can modify the trace to show only specific trace calls. The default is to show only S3 related HTTP traces.

Select Filters to open additional filters to apply to trace output, such as restricting the Path on which the trace applies to a specific bucket or bucket prefix.

Watch

The Watch section displays S3 events as they occur on the selected bucket. This section provides similar functionality to mc watch.

Drives

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

Events

Console 0.23.1

Notifications section renamed to Events.

The Events section provides an interface to view, add, or remove 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 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.

Site Replication

The Site Replication section provides an interface for adding and managing the 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).

Encryption

The Encryption setting provides an interface for listing, creating, and deleting keys for use with MinIO Server-Side Encryption <minio-sse>.

You can use keys created or listed in this view for object encryption operations, including setting a 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 minio-encryption-sse-secure-erasure-locking for more information.

Settings

The Settings section provides an interface for viewing and retrieving configuration settings <minio-server-configuration-settings> for all MinIO Servers in the deployment. Use the buttons to Export and Import the settings between deployments.

This section contains the following subsections.

• Region
• Compression
• API
• Heal
• Scanner
• Etcd
• Logger Webhook
• Audit Webhook <minio-bucket-notifications-publish-webhook>
• Audit Kafka <minio-bucket-notifications-publish-kafka>

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 required administrative permissions <minio-policy-mc-admin-actions>.

The interface functionality mimics that of using mc admin config get or 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.