docs/source/operations/troubleshooting.rst

Troubleshooting

minio

Table of Contents

Overview

MinIO users have two options for support.

1. Community support from the public Slack channel.

   Community support is best-effort only and has no SLA (Service Level Agreement) or SLO (Service Level Objective).

2. The MinIO Subscription Network, |subnet-short|, provides either 24 hour or 1 hour SLA (Service Level Agreement) depending on subscription level.

   For current licensing levels and pricing, refer to the |SUBNET| page.

SUBNET

SUBNET delivers 24/7/365 Direct-to-engineer support through a MinIO-built portal that blends the best of Slack and Zendesk.

Features of SUBNET include:

• Security and architecture reviews (depending on SLA (Service Level Agreement))
• Access to Panic Button (depending on SLA (Service Level Agreement))
• Secure communication channel to exchange logs and software binaries
• Unlimited seats for your team
• Unlimited issues

For more information, see details at the |SUBNET| page.

Registering Your MinIO Deployment with SUBNET

Console

You can register for SUBNET from the MinIO Console.

1. Go to your MinIO cluster's URL, then sign in
2. Select the Support option
3. Select Register
4. Select the tab with the method to use to register:
   • Credentials tab to use your MinIO SUBNET username and password
   • API Key tab to input an API key you already have or obtain one directly from SUBNET
   • Airgap tab for a token and instructions to register a deployment that does not have direct connection to the Internet and/or SUBNET

Console Airgapped

Use the steps below to register MinIO deployments that do not have direct Internet access. For example, deployments that exist with an airgap, behind a firewall, or in other environments with no direct Internet access. From the Console:

1. Go to your MinIO cluster's URL, then sign in
2. Select the Support tab, then select Health
3. Select Register your Cluster
4. Select the Airgap tab
5. Copy the provided link, which includes a token value for the deployment
6. Paste the link into a web browser on a device with access to the Internet
7. After successful registration, copy the provided API key
8. In the MinIO Console, select the API Key tab
9. Paste the copied API key from SUBNET into the API Key field, then select Register

Command Line

You can register for SUBNET from the command line.

Refer to mc license register for instructions.

For clusters without direct Internet access, refer to the instructions in the airgap example <minio-license-register-airgap> of the mc license register documentation.

Download License File

Download the license file from SUBNET on a machine with access to the Internet.

1. Log in to |SUBNET|
2. Go to the Deployments tab
3. Select the deployment from the list
4. Select the License number near the top of the page to display the Cluster License Key
5. Select Download

SUBNET Issues

Use SUBNET issues to engage support from MinIO engineering.

1. Log in to https://subnet.min.io
2. Select the Issues section

Use the search bar to locate an existing issue or add a new issue.

Select an existing issue from the list to expand the conversation or add a response.

Reviewing Health Data in SUBNET

SUBNET provides health data about the clusters registered to the organization from the Deployments section.

The view shows the total size of the org's MinIO clusters with details for each cluster.

Each of the organization's clusters display below the summary data. Select a deployment row to view additional health details.

Deployment Health

The deployment's details include a summary of the deployment's configuration and the number of checks run and failed. You can select Upload to add diagnostic health data obtained from the mc support diag command or the MinIO Console's Support > Health page.

If you need support from MinIO Engineering, you can create a New Issue for the deployment.

SUBNET displays health checks for data points such as CPU, drives, memory, network, and security.

Failed checks display first. Checks with warnings display after failed checks. Checks that pass display last.

Select any failed or warned checks to display the JSON output for additional details. You can scroll vertically through the output for the selected check.

Uploading Data to SUBNET

If you registered the cluster with SUBNET, Performance and Inspection files can automatically upload to SUBNET.

For clusters with an airgap, firewall, or otherwise blocked from SUBNET directly, you can manually upload files to SUBNET after logging in.

1. Generate the file(s) to upload from the command line with mc support diag or mc support inspect
2. Sign in to SUBNET
3. Select Deployments
4. Select Diagnostics
5. Drag and drop the .gzip file(s) or browse to the file location to upload

Encrypting Data

Data from the Inspect tool in Console <minio-console> or the mc support inspect command can be encrypted. For more details about encrypting or decrypting such files, see Encrypting Files <minio-support-encryption>.

Logs

Use mc support callhome enable to start automatically uploading deployment logs to SUBNET for analysis. Use mc support callhome status to check the status of log upload. You can disable upload at any time using mc support callhome disable.

Use mc admin logs command to display logs from the command line. The command supports type and quantity filters for further limiting logs output.

/operations/troubleshooting/encrypting-files