From a210da5f611eae2b749d0595163e8a0f8f2f8630 Mon Sep 17 00:00:00 2001 From: Daryl White <53910321+djwfyi@users.noreply.github.com> Date: Tue, 30 Jan 2024 12:45:04 -0500 Subject: [PATCH] Adding mc version info for license add or update (#1111) Per internal discussion, this adds some admonitions for mc license commands and the SUBNET registration section of the troubleshooting page. Also adds information about Client and Server version alignment. --- source/operations/troubleshooting.rst | 7 +++++ source/reference/minio-mc.rst | 14 +++++++++ .../minio-mc/mc-license-register.rst | 30 ++++--------------- .../reference/minio-mc/mc-license-update.rst | 7 +++++ 4 files changed, 33 insertions(+), 25 deletions(-) diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index c95d45b7..fc46cd3c 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -79,6 +79,13 @@ You can restart through the Console by selecting :guilabel:`Restart` in the top 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. diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 21bbd599..3318a988 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -44,6 +44,20 @@ See :ref:`minio-mc-commands` for a list of supported commands. is the best option for applications which trigger AGPLv3 obligations where open-sourcing the application is not an option. +.. _mc-client-versioning: + +Version Alignment with MinIO Server +----------------------------------- + +The MinIO Client releases separately from the MinIO Server. + +For best functionality and compatibility, use a MinIO Client version released closely to your MinIO Server version. +For example, a MinIO Client released the same day or later than your MinIO Server version. + +You can install a version of the MinIO Client that is more recent than the MinIO Server version. +However, if the MinIO Client version skews too far from the MinIO Server version, you may see increased warnings or errors as a result of the differences. +For example, while core S3 APIs around copying (:mc:`mc cp`) may remain unchanged, some features or flags may only be available or stable if the client and server versions are aligned. + .. _mc-install: Quickstart diff --git a/source/reference/minio-mc/mc-license-register.rst b/source/reference/minio-mc/mc-license-register.rst index 3dd215e5..719d1f47 100644 --- a/source/reference/minio-mc/mc-license-register.rst +++ b/source/reference/minio-mc/mc-license-register.rst @@ -11,32 +11,12 @@ .. mc:: mc support register .. mc:: mc license register -Command History ---------------- - -The command used to register a deployment with SUBNET has changed over time. - -.. list-table:: - :header-rows: 1 - :widths: 40 30 30 - :width: 100% - - * - MinIO Client Release - - Command - - Notes - - * - RELEASE.2021-11-05T10-05-06Z - - ``mc admin subnet register`` - - First available - - * - RELEASE.2022-02-13T23-26-13Z - - ``mc support register`` - - Command moved to an ``mc support`` function - - * - RELEASE.2022-07-15T09-20-55Z - - ``mc license register`` - - Command moved to an ``mc license`` function +.. 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 for any reason you cannot upgrade your MinIO Client to the required version or later for the purpose of registering to SUBNET, register using the :ref:`MinIO Console ` instead. Description ----------- diff --git a/source/reference/minio-mc/mc-license-update.rst b/source/reference/minio-mc/mc-license-update.rst index 1b5dbf95..5a504d71 100644 --- a/source/reference/minio-mc/mc-license-update.rst +++ b/source/reference/minio-mc/mc-license-update.rst @@ -10,6 +10,13 @@ .. mc:: mc license update +.. important:: + + ``mc license update`` requires :ref:`MinIO Client ` version ``RELEASE.2023-11-20T16-30-59Z``. + While not strictly required, best practice keeps the :ref:`MinIO Client version ` in alignment with the MinIO Server version. + + If for any reason you cannot upgrade your MinIO Client to the required version or later for the purpose of registering to SUBNET, register using the :ref:`MinIO Console ` instead. + Description -----------