minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-22 19:02:57 +03:00
Code
docs/source/operations/troubleshooting.rst
Daryl White 6e7444c812
Updates documentation for Console release 0.20.0 (#601) 
Closes #535

- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
2022-10-11 16:31:04 -05:00

6.6 KiB
Raw Blame History

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, , provides either 24 hour or 1 hour SLA (Service Level Agreement) depending on subscription level.

    For current licensing levels and pricing, refer to the 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 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

You can register MinIO deployments for SUBNET even if they exists an airgap, firewall, or otherwise no direct Internet access. From the Console:

  1. Go to your MinIO cluster's URL, then sign in
  2. Select the Support option
  3. Select Register
  4. Select the Offline Activation link at the bottom of the screen
  5. Copy the registration token for your cluster from item 1
  6. Go to https://subnet.min.io/cluster/register and enter the registration token when prompted
  7. Copy the generated API key and paste it in item 3 of the Offline Registration window in the MinIO Console
  8. 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.

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.

MinIO SUBNET with the Issues section displaying a list of an organization's issues

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

A example MinIO SUBNET issue conversation

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.

MinIO SUBNET displaying the deployments overview

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.

MinIO SUBNET displaying health summary information for a myminio 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.

MinIO SUBNET's health report for a deployment showing a failed Health Report with details expanded

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 the subcommands for mc support logs to ~mc support logs enable or ~mc support logs disable the submission of MinIO logs to SUBNET. You can also use mc support logs status to check if a log submission is in progress.

Use mc support logs show command to display logs from the command line. Use the parameter flags for the mc support logs show command to limit the displayed logs by type or quantity.

/operations/troubleshooting/encrypting-files