diff --git a/source/default-conf.py b/source/default-conf.py index 2c785df3..c07b50d1 100644 --- a/source/default-conf.py +++ b/source/default-conf.py @@ -326,8 +326,8 @@ .. |minio-deb| replace:: DEBURL .. |minio-rpmarm64| replace:: RPMARM64URL .. |minio-debarm64| replace:: DEBARM64URL -.. |subnet| replace:: `MinIO SUBNET `__ -.. |subnet-short| replace:: `SUBNET `__ +.. |subnet| replace:: `MinIO pricing `__ +.. |subnet-short| replace:: `pricing `__ .. |SNSD| replace:: :abbr:`SNSD (Single-Node Single-Drive)` .. |SNMD| replace:: :abbr:`SNMD (Single-Node Multi-Drive)` .. |MNMD| replace:: :abbr:`MNMD (Multi-Node Multi-Drive)` diff --git a/source/glossary.rst b/source/glossary.rst index be5d58ea..8b871087 100644 --- a/source/glossary.rst +++ b/source/glossary.rst @@ -53,7 +53,7 @@ Glossary See also: :term:`tenant`. cluster registration - Cluster registration links a MinIO deployment to a :term:`SUBNET` :ref:`subscription `. + Cluster registration links a MinIO deployment to a :term:`SUBNET` `subscription `__. An organization may have more than one MinIO clusters registered to the same SUBNET subscription. Console diff --git a/source/operations/checklists/hardware.rst b/source/operations/checklists/hardware.rst index 94f4664c..7bedbc8e 100644 --- a/source/operations/checklists/hardware.rst +++ b/source/operations/checklists/hardware.rst @@ -342,58 +342,6 @@ Storage Recommended Hardware Tests -------------------------- -MinIO Diagnostics -~~~~~~~~~~~~~~~~~ - -Run the built in health diagnostic tool. -If you have access to :ref:`SUBNET `, you can upload the results there. - -.. code-block:: shell - :class: copyable - - mc support diag ALIAS --airgap - -Replace ALIAS with the :mc:`~mc alias` defined for the deployment. - -MinIO Support Diagnostic Tools -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For deployments registered with MinIO |subnet-short|, you can run the built-in support diagnostic tools. - -Run the three :mc:`mc support perf` tests. - -These server-side tests validate network, drive, and object throughput. -Run all three tests with default options. - -#. Network test - - Run a network throughput test on a cluster with alias ``minio1``. - - .. code-block:: shell - :class: copyable - - mc support perf net minio1 - -#. Drive test - - Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``. - The command uses the default blocksize of 4MiB. - - .. code-block:: shell - :class: copyable - - mc support perf drive minio1 - -#. Object test - - Measure the performance of S3 read/write of an object on the alias ``minio1``. - MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second). - - .. code-block:: shell - :class: copyable - - mc support perf object minio1 - Operating System Diagnostic Tools ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -513,3 +461,53 @@ Document the performance numbers for each server in your deployment. - Number of threads (:math:`numberOfDrives * 16`) * - ``-F <>`` - list of files (the above command tests with 16 files per drive) + +Recommended tools for MinIO subscriptions +----------------------------------------- + +.. important:: + + The tools noted in this section **require** a MinIO subscription. + MinIO strongly recommends all production deployments use `AIStor Object Store `__ with their SUBNET license. + For more information, see the `MinIO AIStor pricing page `__. + +#. Health diagnostic tool + + Generate a summary of the health status of your deployment. + If you have access to :ref:`SUBNET `, you can upload the results there. + + .. code-block:: shell + :class: copyable + + mc support diag ALIAS --airgap + + Replace ALIAS with the :mc:`~mc alias` defined for the deployment. + +#. Network test + + Run a network throughput test on a cluster with alias ``minio1``. + + .. code-block:: shell + :class: copyable + + mc support perf net minio1 + +#. Drive test + + Run drive read/write performance measurements on all drive on all nodes for a cluster with alias ``minio1``. + The command uses the default blocksize of 4MiB. + + .. code-block:: shell + :class: copyable + + mc support perf drive minio1 + +#. Object test + + Measure the performance of S3 read/write of an object on the alias ``minio1``. + MinIO autotunes concurrency to obtain maximum throughput and IOPS (Input/Output Per Second). + + .. code-block:: shell + :class: copyable + + mc support perf object minio1 diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index bf15e2a0..544887bb 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -16,254 +16,23 @@ MinIO users have two options for support. #. Community support from the `public Slack channel `_. Community support is best-effort only and has no :abbr:`SLA (Service Level Agreement)` or :abbr:`SLO (Service Level Objective)`. -#. The MinIO Subscription Network, |subnet-short|, provides either 48 hour or 1 hour :abbr:`SLA (Service Level Agreement)` depending on subscription level. +#. Paid subscribers have access to the MinIO Subscription Network, |subnet-short|, which provides access to health checks, direct-to-engineering support, and license management. For current licensing levels and pricing, refer to the |SUBNET| page. -.. _minio-docs-subnet: +Tools +----- -SUBNET ------- +The :ref:`MinIO Client ` provides several functions to display information about your MinIO deployment or monitor its activity. -SUBNET delivers 24/7/365 Direct-to-engineer support through a MinIO-built portal that blends the chat features of common communication tools with the support features of standard support platforms. +- For basic information about your MinIO deployment, use :mc-cmd:`mc admin info`. -Features of SUBNET include: +- For deeper investigation of S3 calls and responses, use :mc-cmd:`mc admin trace`. -- Security and architecture reviews (depending on :abbr:`SLA (Service Level Agreement)`) -- Access to Panic Button, which provides immediate response to critical issues (depending on :abbr:`SLA (Service Level Agreement)`) -- Secure communication channel to exchange logs and software binaries -- Unlimited seats for your team -- Unlimited issues +- Use :mc:`mc admin logs` to display logs from the command line. + The command supports type and quantity filters for further limiting logs output. -For more information, see details at the |SUBNET| page. - -Registering Your MinIO Deployment with SUBNET ---------------------------------------------- - -Starting with :minio-release:`RELEASE.2023-04-07T05-28-58Z`, the Console prompts you to restart the deployment after registering with SUBNET. -You can restart through the Console by selecting :guilabel:`Restart` in the top banner or by using :mc-cmd:`mc admin service restart`. - -.. tab-set:: - - .. tab-item:: Console - - You can register for SUBNET from the MinIO Console. - - #. Go to your MinIO cluster's URL, then sign in - #. Select the :guilabel:`Support` option - #. Select :guilabel:`Register` - #. Select the tab with the method to use to register: - - - :guilabel:`Credentials` tab to use your MinIO SUBNET username and password - - :guilabel:`API Key` tab to input an API key you already have or obtain one directly from SUBNET - - :guilabel:`Airgap` tab for a token and instructions to register a deployment that does not have direct connection to the Internet and/or SUBNET - - .. tab-item:: 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: - - #. Go to your MinIO cluster's URL, then sign in - #. Select the :guilabel:`Support` tab, then select :guilabel:`Health` - #. Select :guilabel:`Register your Cluster` - #. Select the :guilabel:`Airgap` tab - #. Copy the provided link, which includes a token value for the deployment - #. Paste the link into a web browser on a device with access to the Internet - #. After successful registration, copy the provided API key - #. In the MinIO Console, select the :guilabel:`API Key` tab - #. Paste the copied API key from SUBNET into the :guilabel:`API Key` field, then select :guilabel:`Register` - - .. tab-item:: Command Line - - You can register for SUBNET from the command line. - - .. important:: - - ``mc license register`` requires :ref:`MinIO Client ` version ``RELEASE.2023-11-20T16-30-59Z`` or later. - While not strictly required, best practice keeps the :ref:`MinIO Client version ` in alignment with the MinIO Server version. - - If you are unable to upgrade the MinIO Client to the required or later version, register using the Console instead. - - Refer to :mc:`mc license register` for instructions. - - For clusters without direct Internet access, refer to the instructions in the :ref:`airgap example ` of the :mc:`mc license register` documentation. - - The airgap registration process works with MinIO Client version ``RELEASE.2022-07-29T19-17-16Z`` or later. - Earlier versions of the MinIO Client cannot register an airgapped deployment. - -.. _minio-subnet-license-file-download: - -Download License File -~~~~~~~~~~~~~~~~~~~~~ - -Download the license file from SUBNET on a machine with access to the Internet. - -#. Log in to |SUBNET| -#. Go to the :guilabel:`Deployments` tab -#. Select the :guilabel:`License` button near the top of the page on the right side of the account statistics information box to display the :guilabel:`Account License` -#. Select :guilabel:`Download` - -SUBNET Issues -------------- - -Use SUBNET issues to engage support from MinIO engineering. - -#. Log in to https://subnet.min.io -#. Select the :guilabel:`Issues` section - -Use the search bar to locate an existing issue or add a new issue. - -.. image:: /images/subnet/issues-section.png - :width: 600px - :alt: MinIO SUBNET with the Issues section displaying a list of an organization's issues - :align: center - -Select an existing issue from the list to expand the conversation or add a response. - -.. image:: /images/subnet/issue-expanded.png - :width: 600px - :alt: A example MinIO SUBNET issue conversation - :align: center - -Reviewing Health Data in SUBNET -------------------------------- - -SUBNET provides health data about the clusters registered to the organization from the :guilabel:`Deployments` section. - -The view shows the total size of the org's MinIO clusters with details for each cluster. - -.. image:: /images/subnet/deployments-overview.png - :width: 600px - :alt: MinIO SUBNET displaying the deployments overview - :align: center - -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 :guilabel:`Upload` to add diagnostic health data obtained from the :mc:`mc support diag` command or the MinIO Console's :guilabel:`Support > Health` page. - -You can also use the :ref:`Call Home ` functionality to automatically run and upload a diagnostic health report. - -If you need support from MinIO Engineering, you can create a :guilabel:`New Issue` for the deployment. - -.. image:: /images/subnet/SUBNET-deployment-health-summary.png - :width: 600px - :alt: MinIO SUBNET displaying health summary information for a myminio deployment - :align: center - -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. - -.. image:: /images/subnet/deployment-health-tls-config-fail.png - :width: 600px - :alt: MinIO SUBNET's health report for a deployment showing a failed Health Report with details expanded - :align: center - -Logs ----- - -Use :mc:`mc admin logs` command to display logs from the command line. -The command supports type and quantity filters for further limiting logs output. - -Optionally, use :ref:`Call Home ` to start automatically uploading real time error logs to SUBNET for analysis. - -.. _minio-troubleshooting-call-home: - -Call Home ---------- - -.. versionadded:: minio RELEASE.2022-11-17T23-20-09Z - and mc RELEASE.2022-12-02T23-48-47Z - -MinIO's opt-in Call Home service automates the collection and uploading of diagnostic data or error logs to SUBNET. -Call Home requires the cluster to have both an active SUBNET registration and reliable access to the internet. - -.. important:: - - Call Home does not work for airgapped deployments. - -When enabled, Call Home can upload one or both of: - -- error logs in real time -- a new diagnostic report every 24 hours - -Once uploaded, you can view the diagnostic report results or logs through SUBNET as described above, but without the need to manually upload the data yourself. -Making these records automatically available in SUBNET simplifies visibility into cluster health and functionality. -If you submit an issue for support help from the MinIO engineers, the engineers have immediate access to the errors and/or logs you have uploaded. - -Diagnostic Report -~~~~~~~~~~~~~~~~~ - -The diagnostic report upload happens every 24 hours from the time you enable Call Home. -If you restart all nodes on the deployment after enabling Call Home, the upload happens every 24 hours from the deployment restart. - -.. important:: - - The diagnostic report does **not** collect or upload any personally identifiable information. - -The report includes information such as: - -- System settings, services, and configurations that might impact performance -- TLS certificate status, validity, expiration, and algorithm type information -- CPU core count and information -- Drive count, status, size, and available space -- Cluster size server count -- File system type -- Memory size and type -- OS symmetry and Linux kernel version -- Internode latency -- NTP synchronization -- Available resources -- MinIO version - -Error Logs -~~~~~~~~~~ - -When the MinIO Server encounters an error, it writes it to a log. -These logs can upload in real time to SUBNET, where you or MinIO engineers can view the errors. - -Enabling or Disabling Call Home -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Call Home is **disabled** by default. -You can :mc-cmd:`~mc support callhome enable` and :mc-cmd:`~mc support callhome disable` Call Home functionality at any time using the MinIO Client's :mc:`mc support callhome` commands. -The command and its subcommands allow you to enable Call Home uploads for only the diagnostics, only the error logs, or both. -Refer to the documentation on the commands for more details. - -Use :mc-cmd:`mc support callhome status` to check the status of an upload. - -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. - -#. Generate the file(s) to upload from the command line with :mc:`mc support diag` or :mc:`mc support inspect` -#. Sign in to `SUBNET `_ -#. Select :guilabel:`Deployments` -#. Select :guilabel:`Diagnostics` -#. Drag and drop the ``.gzip`` file(s) or browse to the file location to upload - -Encrypting Data -~~~~~~~~~~~~~~~ - -Data from the Inspect tool in :ref:`Console ` or the :mc:`mc support inspect` command can be encrypted. -For more details about encrypting or decrypting such files, see :ref:`Encrypting Files `. - -Upgrades and Version Support +Upgrades and version support ---------------------------- MinIO regularly releases updates to introduce features, improve performance, address security concerns, or fix bugs. @@ -271,32 +40,10 @@ These releases can occur very frequently, and vary by product. Always test software releases in a development environment before upgrading on a production deployment. -Active Support Periods -~~~~~~~~~~~~~~~~~~~~~~ - -Version support varies by the `license `_ used for the deployment. - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - :width: 100% - - * - License - - Support length - - * - AGPLv3 - - Most recent release - - * - MinIO Enterprise Lite - - 1 year long term support of any release - - * - MinIO Enterprise Plus - - 5 year long term support of any release, SUBNET support for upgrade guidance and recommendations - -Recommended Upgrade Schedule +Recommended upgrade schedule ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -MinIO recommends always installing the most recent release to obtain the latest features, security enhancements, and performance improvements. +MinIO recommends always installing the most recent release to obtain security enhancements and improvements. We recognize that such a frequent release schedule may make this impractical for some organizations. In such cases, we recommend using MinIO and our related product releases that are no older than six months. diff --git a/source/reference/minio-mc-admin/mc-admin-logs.rst b/source/reference/minio-mc-admin/mc-admin-logs.rst index e86394de..2b8ee3ef 100644 --- a/source/reference/minio-mc-admin/mc-admin-logs.rst +++ b/source/reference/minio-mc-admin/mc-admin-logs.rst @@ -30,8 +30,6 @@ Use the :mc-cmd:`mc admin logs` command to show MinIO server logs. .. end-mc-admin-logs-desc -To enable or disable the sending of logs to SUBNET for support, use :mc:`mc support callhome`. - .. include:: /includes/common-mc-support.rst :start-after: start-support-logs-opt-in :end-before: end-support-logs-opt-in diff --git a/source/reference/minio-mc/mc-license-register.rst b/source/reference/minio-mc/mc-license-register.rst index b003f107..05bcd29b 100644 --- a/source/reference/minio-mc/mc-license-register.rst +++ b/source/reference/minio-mc/mc-license-register.rst @@ -72,7 +72,7 @@ Parameters .. mc-cmd:: --api-key - API of the account on SUBNET. + API key of the account on SUBNET. Corresponds with the ``MC_SUBNET_API_KEY`` environment variable. @@ -88,7 +88,13 @@ Parameters Path to the license file to use for registering the deployment. - You must first :ref:`download the license file ` for the account. + You must first download the license file for the account from |SUBNET|. + + #. Log in to |SUBNET| + #. Go to the :guilabel:`Deployments` tab + #. Select the :guilabel:`License` button near the top of the page on the right side of the account statistics information box + #. Select the copy button to the right of the license field to copy the key value to your clipboard or + select the :guilabel:`Download` button to save a txt file of the license locally .. mc-cmd:: --name :optional: @@ -122,7 +128,13 @@ Register a new MinIO deployment at alias ``minio5`` on SUBNET, using the license mc license register minio5 /path/to/minio.license -If not already downloaded, you can :ref:`download the license file ` from SUBNET. +If not already downloaded, you can download the license file from SUBNET. + +#. Log in to |SUBNET| +#. Go to the :guilabel:`Deployments` tab +#. Select the :guilabel:`License` button near the top of the page on the right side of the account statistics information box +#. Select the :guilabel:`Download` button to save a txt file of the license locally + Register a Deployment with a Different Deployment Name ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/minio-mc/mc-license-update.rst b/source/reference/minio-mc/mc-license-update.rst index 64f52176..693a4a6c 100644 --- a/source/reference/minio-mc/mc-license-update.rst +++ b/source/reference/minio-mc/mc-license-update.rst @@ -57,7 +57,13 @@ Parameters The path (relative to the current working directory) and file name of the key to use to update the deployment's license. - See the :ref:`troubleshooting page ` for instructions on downloading the license file. + To download the API key from SUBNET: + + #. Log in to |SUBNET| + #. Go to the :guilabel:`Deployments` tab + #. Select the :guilabel:`API Key` button near the top of the page on the right side of the account statistics information box + #. Select copy button to the right of the key field to copy the key value to your clipboard + .. mc-cmd:: --airgap :optional: