From 48feb40740f5709169e9805ce6d8592bd1d1ec60 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Tue, 26 Nov 2024 14:17:12 -0700 Subject: [PATCH] Remove references to various ex MinIO Console features (#1373) UI for the following has been removed from MinIO Console: - Lifecycle and tiering - Site replication - SUBNET Waiting for merge of https://github.com/minio/console/pull/3472 Staged: http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/minio-console.html http://192.241.195.202:9000/staging/DOCS-1372/linux/administration/bucket-replication.html http://192.241.195.202:9000/staging/DOCS-1372/linux/operations/install-deploy-manage/multi-site-replication.html#id4 fixes https://github.com/minio/docs/issues/1372 --------- Co-authored-by: Jennifer Rondeau --- ...ver-side-multi-site-bucket-replication.rst | 37 +- ...server-side-one-way-bucket-replication.rst | 25 - ...server-side-two-way-bucket-replication.rst | 38 +- .../console/managing-deployment.rst | 12 +- .../console/managing-objects.rst | 21 +- .../console/subnet-registration.rst | 95 ---- source/administration/minio-console.rst | 10 +- source/includes/common/bucket-replication.rst | 115 +--- .../multi-site-replication.rst | 500 +++++------------- .../minio-mc/mc-license-register.rst | 5 +- 10 files changed, 151 insertions(+), 707 deletions(-) delete mode 100644 source/administration/console/subnet-registration.rst diff --git a/source/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.rst b/source/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.rst index 062bf4b30..c958adb98 100644 --- a/source/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.rst +++ b/source/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.rst @@ -48,9 +48,9 @@ Access to All Clusters You must have network access and log in credentials with correct permissions to all deployments to set up multi-site active-active bucket replication. -You can access the deployments by logging in to the :ref:`MinIO Console ` for each deployment or by installing :mc:`mc` and using the command line. +You can access the deployments by installing :mc:`mc` and using the command line. +Use the :mc:`mc alias set` command to create an alias for each MinIO deployment. -If using the command line, use the :mc:`mc alias set` command to create an alias for each MinIO deployment. Alias creation requires specifying an access key for a user on the deployment. This user **must** have permission to create and manage users and policies on the deployment. @@ -110,44 +110,11 @@ Procedure This procedure requires repeating steps for each MinIO deployment participating in the multi-site replication configuration. Depending on the number of deployments, this procedure may require significant time and care in implementation. MinIO recommends reading through the procedure *before* attempting to implement the documented steps. -- :ref:`Configure Multi-Site Bucket Replication Using the MinIO Console ` - - :ref:`Create the Replication Rules ` - - :ref:`Validate the Replication Configuration ` - :ref:`Configure Multi-Site Bucket Replication Using the Command Line ` - :ref:`Create Replication Remote Targets ` - :ref:`Create New Bucket Replication Rules ` - :ref:`Validate the Replication Configuration ` -.. _minio-bucket-replication-multi-site-minio-console-procedure: - -Configure Multi-Site Bucket Replication Using the MinIO Console -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _minio-bucket-replication-multi-site-minio-console-create-replication-rules: - -1) Create the Replication Rules -+++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-create-bucket-replication-rule-console-desc - :end-before: end-create-bucket-replication-rule-console-desc - -Repeat the above steps to create a rule from this deployment to each of the other target deployments. - -Then, repeat the above steps on each of the other deployments in the multi-site setup so that each deployment has a separate replication rule for all of the other deployments. - -.. _minio-bucket-replication-multi-site-minio-console-validate-replication-config: - -2) Validate the Replication Configuration -+++++++++++++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-validate-bucket-replication-console-desc - :end-before: end-validate-bucket-replication-console-desc - -Repeat this test on each deployment by copying a new unique file and checking that the file replicates to each of the other deployments. - -.. _minio-bucket-replication-multi-site-minio-cli-procedure: Configure Multi-Site Bucket Replication Using the Command Line ``mc`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/administration/bucket-replication/enable-server-side-one-way-bucket-replication.rst b/source/administration/bucket-replication/enable-server-side-one-way-bucket-replication.rst index 6e05549d2..67fb75403 100644 --- a/source/administration/bucket-replication/enable-server-side-one-way-bucket-replication.rst +++ b/source/administration/bucket-replication/enable-server-side-one-way-bucket-replication.rst @@ -80,36 +80,11 @@ Click to expand any of the following: Procedure --------- -- :ref:`Configure One-Way Bucket Replication Using the MinIO Console ` - - :ref:`Create a New Bucket Replication Rule ` - - :ref:`Validate the Replication Configuration ` - :ref:`Configure One-Way Bucket Replication Using the Command Line ` - :ref:`Create a Replication Remote Target ` - :ref:`Create a New Bucket Replication Rule ` - :ref:`Validate the Replication Configuration ` -.. _minio-bucket-replication-one-way-minio-console-procedure: - -Configure One-Way Bucket Replication Using the MinIO Console -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _minio-bucket-replication-one-way-minio-console-create-replication-rules: - -1) Create a New Bucket Replication Rule -+++++++++++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-create-bucket-replication-rule-console-desc - :end-before: end-create-bucket-replication-rule-console-desc - -.. _minio-bucket-replication-one-way-minio-console-validate-replication-config: - -2) Validate the Replication Configuration -+++++++++++++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-validate-bucket-replication-console-desc - :end-before: end-validate-bucket-replication-console-desc .. _minio-bucket-replication-one-way-minio-cli-procedure: diff --git a/source/administration/bucket-replication/enable-server-side-two-way-bucket-replication.rst b/source/administration/bucket-replication/enable-server-side-two-way-bucket-replication.rst index da2cbab29..dce2b62b2 100644 --- a/source/administration/bucket-replication/enable-server-side-two-way-bucket-replication.rst +++ b/source/administration/bucket-replication/enable-server-side-two-way-bucket-replication.rst @@ -42,9 +42,9 @@ Access to Both Clusters You must have network access and login credentials with required permissions to both deployment to set up active-active bucket replication. -You can access the deployments by logging in to the :ref:`MinIO Console ` for each deployment or by installing :mc:`mc` and using the command line. +You can access the deployments by installing :mc:`mc` and using the command line. +Use the :mc:`mc alias set` command to create an alias for both MinIO deployments. -If using the command line, use the :mc:`mc alias set` command to create an alias for both MinIO deployments. Alias creation requires specifying an access key for a user on the deployment. This user **must** have permission to create and manage users and policies on the deployment. @@ -111,43 +111,11 @@ Considerations Procedure --------- -- :ref:`Configure Two-Way Bucket Replication Using the MinIO Console ` - - :ref:`Create a New Bucket Replication Rule on Each Deployment ` - - :ref:`Validate the Replication Configuration ` - :ref:`Configure Two-Way Bucket Replication Using the Command Line ` - :ref:`Create Replication Remote Targets ` - :ref:`Create a New Bucket Replication Rule on Each Deployment ` - :ref:`Validate the Replication Configuration ` -.. _minio-bucket-replication-two-way-minio-console-procedure: - -Configure Two-Way Bucket Replication Using the MinIO Console -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _minio-bucket-replication-two-way-minio-console-create-replication-rules: - -1) Create a New Bucket Replication Rule on Each Deployment -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-create-bucket-replication-rule-console-desc - :end-before: end-create-bucket-replication-rule-console-desc - -Repeat the above steps to create a rule in the other direction. - -A) Go to the Console for the destination deployment used above. -B) Create a replication rule from the second deployment back to the first deployment. - The first deployment becomes the target deployment for the rule on the second deployment. - -.. _minio-bucket-replication-two-way-minio-console-validate-replication-config: - -2) Validate the Replication Configuration -+++++++++++++++++++++++++++++++++++++++++ - -.. include:: /includes/common/bucket-replication.rst - :start-after: start-validate-bucket-replication-console-desc - :end-before: end-validate-bucket-replication-console-desc - .. _minio-bucket-replication-two-way-minio-cli-procedure: Configure Two-Way Bucket Replication Using the Command Line ``mc`` @@ -199,4 +167,4 @@ Once both objects exist on both deployments, you have successfully set up two-wa - Use the :mc:`mc replicate update` command with the :mc-cmd:`--state "disable" ` flag to disable an existing replication rule. - - Use the :mc:`mc replicate rm` command to remove an existing replication rule. \ No newline at end of file + - Use the :mc:`mc replicate rm` command to remove an existing replication rule. diff --git a/source/administration/console/managing-deployment.rst b/source/administration/console/managing-deployment.rst index 78454efb9..e2c10fde1 100644 --- a/source/administration/console/managing-deployment.rst +++ b/source/administration/console/managing-deployment.rst @@ -15,7 +15,6 @@ You can use the MinIO Console to perform many of the deployment monitoring and m - :ref:`Monitor ` 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 :ref:`notification target `. -- Set up :ref:`site replication ` to synchronize datacenters for timely access across geographically dispersed workforces or for disaster preparedness. - Configure deployment :ref:`settings `. .. important:: @@ -106,15 +105,6 @@ Select the :guilabel:`Add Event Destination +` button to add a new event target You can select an existing notification target from the list to view its details or delete the target. -.. _minio-console-site-replication: - -Site Replication ----------------- - -The :guilabel:`Site Replication` section provides an interface for adding and managing the :ref:`site replication ` configuration for the deployment. - -Configuring site replication requires that only a single site have existing buckets or objects (if any). - .. _minio-console-encryption: Encryption @@ -160,4 +150,4 @@ Some subsections may not be visible if the authenticated user does not have the The interface functionality mimics that of using :mc-cmd:`mc admin config get` or :mc-cmd:`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. \ No newline at end of file +Some configuration settings may require restarting the MinIO deployment to apply changes. diff --git a/source/administration/console/managing-objects.rst b/source/administration/console/managing-objects.rst index 5e88bab3f..870741795 100644 --- a/source/administration/console/managing-objects.rst +++ b/source/administration/console/managing-objects.rst @@ -16,7 +16,6 @@ Depending on the permissions and IAM policies for the authenticated user, you ca - :ref:`Browse, upload, revert, manage, and interact with objects `. - :ref:`Browse, create, and manage buckets `. -- :ref:`Create or monitor remote tiers ` for object transition rules. .. _minio-console-object-browser: @@ -84,7 +83,7 @@ While creating a bucket, you can enable :ref:`versioning ` when a user uploads, accesses, or deletes matching objects. -- Copy objects to remote locations in the :guilabel:`Replication` section with :ref:`Server Side Bucket Replication Rules `. - -- Expire or transition objects in the bucket from the :guilabel:`Lifecycle` section by setting up :ref:`Object Lifecycle Management Rules `. - - Review security in the :guilabel:`Access` section by listing the :ref:`policies ` and :ref:`users ` with access to that bucket. - Properly secure unauthenticated access with the :guilabel:`Anonymous` section by managing rules for prefixes that unauthenticated users can use to read or write objects. - -.. _minio-console-tiers: - -Tiers ------ - -The :guilabel:`Tiering` section provides an interface for adding and managing :ref:`remote tiers ` to support lifecycle management transition rules. -MinIO tiering supports moving objects from the deployment to the remote storage, but does not support automatically restoring them to the deployment. - -The tiering tab allows users with the appropriate permissions to: - -- Review the status and summary information for all configured remote tiers. -- Create a tier for a new remote target to storage on another MinIO deployment, Google Cloud Storage, Amazon's AWS S3, or Azure. -- Cycle the access credentials for any of the configured tiers with the tier's :octicon:`pencil` icon. \ No newline at end of file diff --git a/source/administration/console/subnet-registration.rst b/source/administration/console/subnet-registration.rst deleted file mode 100644 index 98bcf2e92..000000000 --- a/source/administration/console/subnet-registration.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. _minio-console-subscription: - -====== -SUBNET -====== - -.. default-domain:: minio - -.. contents:: Table of Contents - :local: - :depth: 2 - - -You can use the MinIO Console to perform several of the license and subscription related functions available in MinIO, such as: - -- View the license you are currently using for your MinIO deployment. -- Subscribe to a commercial license, which includes access to |SUBNET|. -- Manage the deployment's Enterprise license. -- Access Support tools for sharing with MinIO Engineering. -- Review differences between license options. - -License -------- - -MinIO offers three licensing options: - -#. Open source with the :minio-git:`GNU AGPLv3 license ` -#. Enterprise Lite, a `commercial license `__ with included support direct from MinIO Engineers -#. Enterprise Plus, a `commercial license `__ with included support direct from MinIO Engineers, longer release cycle, shorter SLA, and other benefits - -The :guilabel:`License` page shows the current license status of the deployment. -You can also begin the registration process to sign up for a paid subscription or add the deployment to an existing subscription. - -Deployments licensed under AGPLv3 must comply to the terms of the license. -MinIO cannot make the determination as to whether your application's usage of MinIO is in compliance with the AGPLv3 license requirements. -You should instead rely on your own legal counsel or licensing specialists to audit and ensure your application is in compliance with the licenses of MinIO and all other open-source projects with which your application integrates or interacts. - -MinIO Commercial Licensing is the best option for applications which trigger AGPLv3 obligations (for example, open sourcing your application). -Applications using MinIO—or any other OSS-licensed code—without validating their usage do so at their own risk. - -Health ------- - -The :guilabel:`Health` section provides an interface for running a health diagnostic for the MinIO Deployment. -For clusters connected to the Internet, the report uploads automatically to SUBNET. - -The resulting health report is intended for use by MinIO Engineering via |subnet| and may contain internal or private data points such as hostnames. -Exercise caution before sending a health report to a third party or posting the health report in a public forum. - -If desired, you can download the latest report from the page. - -Performance ------------ - -The :guilabel:`Performance` section provides an interface for running a performance test of the deployment. -The resulting test can provide a general guideline of deployment performance under S3 ``GET`` and ``PUT`` requests. - -For more complete performance testing, consider using a combination of load-testing using your staging application environments and the MinIO :minio-git:`WARP ` tool. - -Profile -------- - -The :guilabel:`Profile` section provides an interface for running system profiling of the deployment. -The results can provide insight into the MinIO server process running on a given node. - -The resulting report is intended for use by MinIO Engineering via |subnet|. -Independent or third-party use of these profiles for diagnostics and remediation is done at your own risk. - -Inspect -------- - -The :guilabel:`Inspect` section provides an interface for capturing the erasure-coded metadata associated to an object or objects. -MinIO Engineering may request this output as part of diagnostics in |subnet|. - -The resulting object may be read using MinIO's :minio-git:`debugging tool `. -Independent or third-party use of the output for diagnostics or remediation is done at your own risk. -You can optionally encrypt the object such that it can only be read if the generated encryption key is included as part of the debugging toolchain. - -Call Home ---------- - -.. versionadded:: Console v0.24.0 - -Call Home is an optional feature where a deployment registered for |SUBNET| can automatically send daily health diagnostic reports or real-time error logs to SUBNET. -Having these reports equips engineering support with a record of diagnostics, logs, or both when responding to support requests. - -MinIO installs with Call Home options disabled by default. - -.. important:: - - Call Home requires an active Enterprise license. - -Use the :guilabel:`Call Home` section to enable or disable uploading either once-per-day health diagnostic reports or real-time error logs to SUBNET. -The health reports and real-time logs are separate functions you can enable or disable separately. -You can enable both diagnostics and logs at the same time, if desired. \ No newline at end of file diff --git a/source/administration/minio-console.rst b/source/administration/minio-console.rst index 6885b43b4..2bd07f75b 100644 --- a/source/administration/minio-console.rst +++ b/source/administration/minio-console.rst @@ -13,11 +13,6 @@ MinIO Console The MinIO Console is a rich graphical user interface that provides similar functionality to the :mc:`mc` command line tool. -.. image:: /images/minio-console/minio-console.png - :width: 600px - :alt: MinIO Console Landing Page provides a view of the Object Browser for the authenticated user - :align: center - This page provides an overview of the MinIO Console and describes configuration options and instructions for logging in. Overview @@ -153,9 +148,9 @@ Available Tasks Once logged in to the MinIO Console, users can perform many kinds of tasks. -- :ref:`Manage objects ` by browsing or uploading objects, managing bucket settings, or creating tiers. +- :ref:`Manage objects ` by browsing existing objects, uploading objects, or modifying bucket settings. - :ref:`Review or modify identity and security ` with access keys, policies, and Identity Provider settings. -- :ref:`Monitor the health and activities ` with metrics, notifications, or site replication +- :ref:`Monitor the health and activities ` with metrics and notifications. - :ref:`Manage your deployment's license ` .. toctree:: @@ -165,4 +160,3 @@ Once logged in to the MinIO Console, users can perform many kinds of tasks. /administration/console/managing-deployment /administration/console/managing-objects /administration/console/security-and-access - /administration/console/subnet-registration diff --git a/source/includes/common/bucket-replication.rst b/source/includes/common/bucket-replication.rst index d4ef2ea57..bba7e963f 100644 --- a/source/includes/common/bucket-replication.rst +++ b/source/includes/common/bucket-replication.rst @@ -1,94 +1,3 @@ -.. start-create-bucket-replication-rule-console-desc - -A) Log in to the MinIO Console for the deployment -B) Select the :guilabel:`Manage` button for the bucket to replicate - - .. image:: /images/minio-console/console-bucket.png - :width: 600px - :alt: After a successful log in, the MinIO Console shows a list of buckets with options to manage or explore each bucket. - :align: center - -C) Select the :guilabel:`Replication` section - - .. image:: /images/minio-console/console-iam.png - :width: 600px - :alt: After selecting a bucket to manage, MinIO shows summary information about the bucket as well as a navigation list of pages for adjusting the bucket configuration. - :align: center - -D) Select :guilabel:`Add Replication Rule +` -E) Complete the requested information: - - .. list-table:: - :header-rows: 1 - :widths: 25 75 - :width: 100% - - * - Field - - Description - - * - Priority - - Enter a number value to indicate the order in which to process replication rules for the bucket. - `1` indicates the highest importance. - - * - Target URL - - The URL of the deployment to replicate data to. - - * - Use TLS - - Leave the toggle in the :guilabel:`ON` position if the destination deployment uses TLS. - Otherwise, move the toggle to the :guilabel:`OFF` position. - - * - Access Key - - The user name to use on the destination deployment. - The user must have write access to the bucket to replicate to. - - * - Secret Key - - The password for the provided **Access Key**. - - * - Target Bucket - - The bucket at the destination to write the data to. - The target bucket may have the same name as the origin bucket, depending on the destination bucket location. - - * - Region - - The AWS resource region location of the destination deployment. - - * - Replication mode - - Leave the default selection of **Asynchronous** to allow MinIO to replicate data after the write operation completes on the origin ment. - Select **Synchronous** to attempt to complete the replication of the object during its write operation. - - While synchronous replication may result in more reliable synchronization between the origin and destination buckets, it may also increase the time of each write operation. - - * - Bandwidth - - Specify the maximum amount of bandwidth the replication process can use while replicating data. - Enter a number and select a data unit. - - * - Health Check Duration - - The maximum length of time in seconds MinIO should spend verifying the health of the replicated data on the destination bucket. - - * - Storage Class - - The class of storage to use on the destination deployment for the replicated data. - Valid values are either ``STANDARD`` or ``REDUCED_REDUNDANCY``. - - * - Object Filters - - Limit which objects to replicate from the bucket by :term:`Prefix` or **tags**. - If you enter multiple tags, the objects must match all tag values. - - * - Metadata Sync - - Leave selected to also replicate the object's metadata file. - Otherwise, move the toggle to the :guilabel:`Off` position. - - * - Delete Markers - - Leave selected to also replicate MinIO's indication that an object has been deleted and should also be marked deleted at the action bucket. - Otherwise, move the toggle to the :guilabel:`Off` position to prevent marking the object as deleted in the destination bucket. - - * - Deletes - - Leave selected to allow replication of the deletion of versions of an object. - Otherwise, move the toggle to the :guilabel:`Off` position to not replicate deletion of object versions. - -F) Select :guilabel:`Save` to finish adding the replication rule - -.. end-create-bucket-replication-rule-console-desc - - .. start-create-bucket-replication-rule-cli-desc Use the :mc:`mc replicate add` command to add a new replication rule to each MinIO deployment. @@ -124,28 +33,6 @@ Specify any other supported optional arguments for :mc:`mc replicate add`. .. end-create-bucket-replication-rule-cli-desc -.. start-validate-bucket-replication-console-desc - -A) Go to the :guilabel:`Buckets` section of the MinIO Console - - .. image:: /images/minio-console/console-bucket.png - :width: 600px - :alt: The default screen when logging into the MinIO Console. The screen shows a list of the buckets available in the Deployment with options to Manage or Browse the bucket contents. - :align: center - -B) Select the :guilabel:`Browse` button for the bucket you added replication to - - .. image:: /images/minio-console/console-object-browser.png - :width: 600px - :alt: The contents of a bucket display after selecting to Browse the MinIO bucket. Options including to Rewind, Refresh, or Upload contents. - -C) Select the :guilabel:`Upload` button to add a new object to the bucket -D) Select :guilabel:`Upload File` -E) Use the interface to add a new object to the bucket -F) Go to the other deployment's console and select the destination bucket defined in the replication - -.. end-validate-bucket-replication-console-desc - .. start-validate-bucket-replication-cli-desc Use :mc:`mc cp` to copy a new object to the replicated bucket on one of the deployments. @@ -162,4 +49,4 @@ Use :mc:`mc ls` to verify the object exists on the destination bucket: mc ls ALIAS/BUCKET -.. end-validate-bucket-replication-cli-desc \ No newline at end of file +.. end-validate-bucket-replication-cli-desc diff --git a/source/operations/install-deploy-manage/multi-site-replication.rst b/source/operations/install-deploy-manage/multi-site-replication.rst index eb5b3a2e3..c6bc2f660 100644 --- a/source/operations/install-deploy-manage/multi-site-replication.rst +++ b/source/operations/install-deploy-manage/multi-site-replication.rst @@ -203,7 +203,7 @@ Switch to Site Replication from Bucket Replication You cannot use both replication methods on the same deployments. If you previously set up bucket replication and wish to now use site replication, you must first delete all of the bucket replication rules on the deployment that has data when initializing site replication. -Use :mc:`mc replicate rm` on the command line or the MinIO Console to remove bucket replication rules. +Use :mc:`mc replicate rm` on the command line to remove bucket replication rules. Only one site can have data when setting up site replication. All other sites must be empty. @@ -216,153 +216,84 @@ Tutorials Configure Site Replication ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. tab-set:: - - .. tab-item:: Console - :sync: gui - - #. :ref:`Deploy ` two or more separate MinIO sites, using the same Identity Provider for each site - - Only one site can have any buckets or objects on it. - The other site(s) must be empty. - - #. In a browser, access the Console for the site with data (if any) - - For example, ``https://:9000`` - - Replace ```` with the hostname or IP address of the load balancer, reverse proxy, or similar control plane that manages connections to the MinIO deployment. - - #. Select **Settings**, then **Site Replication** - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication.png - :width: 400px - :alt: MinIO Console menu with the Settings heading expanded to show Site Replication - :align: center - - #. Select :guilabel:`Add Sites +` - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-add.png - :width: 600px - :alt: MinIO Console's Add Sites for Replication screen - :align: center - - #. Complete the requested information: - - This Site: - - - :Site Name: A name or other identifying text to associate to the site. - - :Endpoint: `(required)` The hostname or IP of the load balancer managing connections to the site. - - :Access Key: `(required)` The user name for ``root`` to use for signing in to the site. - - :Secret Key: `(required)` The password for ``root`` to use for signing in to the site. +The following steps create a new site replication configuration for three :ref:`distributed deployments `. +One of the sites contains :ref:`replicable data `. - Peer Sites: +The three sites use aliases, ``minio1``, ``minio2``, and ``minio3``, and only ``minio1`` contains any data. - - :Site Name: A name or other identifying text to associate to the site. - - :Endpoint: `(required)` The hostname or IP of the load balancer managing connections to the site. - - :Access Key: `(required)` The user name for ``root`` for the peer site to use for signing in to the site. - - :Secret Key: `(required)` The password for ``root`` for the peer site to use for signing in to the site. +#. :ref:`Deploy ` three or more separate MinIO sites, using the same :ref:`IDP ` - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing + Start with empty sites *or* have no more than one site with any :ref:`replicable data `. - To add additional sites beyond two, select the ``+`` button to the side of one of the Site entries. - To remove a site previously added, select the ``-`` button to the side of the site. +#. Configure an alias for each site - Site replication adds a :mc:`~mc admin user svcacct` under the ``root`` user of each site to perform replication activities. + .. include:: /includes/common-replication.rst + :start-after: start-mc-admin-replicate-load-balancing + :end-before: end-mc-admin-replicate-load-balancing - #. Select **Save** + For example, for three MinIO sites, you might create aliases ``minio1``, ``minio2``, and ``minio3``. - #. Select :guilabel:`Replication Status` button to verify replication has completed across peer sites. + Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the site. - Any :ref:`replicable data ` that exists should show as successfully synced. - - For more on reviewing site replication, see the :ref:`Site Replication Status tutorial `. + .. code-block:: shell + mc alias set minio1 https://minio1.example.com:9000 adminuser adminpassword + mc alias set minio2 https://minio2.example.com:9000 adminuser adminpassword + mc alias set minio3 https://minio3.example.com:9000 adminuser adminpassword + + or define environment variables - .. tab-item:: Command Line - :sync: cli + .. code-block:: shell + + export MC_HOST_minio1=https://adminuser:adminpassword@minio1.example.com + export MC_HOST_minio2=https://adminuser:adminpassword@minio2.example.com + export MC_HOST_minio3=https://adminuser:adminpassword@minio3.example.com - The following steps create a new site replication configuration for three :ref:`distributed deployments `. - One of the sites contains :ref:`replicable data `. +#. Add site replication configuration - The three sites use aliases, ``minio1``, ``minio2``, and ``minio3``, and only ``minio1`` contains any data. + .. code-block:: shell + + mc admin replicate add minio1 minio2 minio3 - #. :ref:`Deploy ` three or more separate MinIO sites, using the same :ref:`IDP ` + If all sites are empty, the order of the aliases does not matter. + If one of the sites contains any :ref:`replicable data `, you must list it first. - Start with empty sites *or* have no more than one site with any :ref:`replicable data `. + No more than one site can contain any replicable data. - #. Configure an alias for each site +#. Query the site replication configuration to verify - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing - - For example, for three MinIO sites, you might create aliases ``minio1``, ``minio2``, and ``minio3``. - - Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the site. - - .. code-block:: shell - - mc alias set minio1 https://minio1.example.com:9000 adminuser adminpassword - mc alias set minio2 https://minio2.example.com:9000 adminuser adminpassword - mc alias set minio3 https://minio3.example.com:9000 adminuser adminpassword - - or define environment variables - - .. code-block:: shell - - export MC_HOST_minio1=https://adminuser:adminpassword@minio1.example.com - export MC_HOST_minio2=https://adminuser:adminpassword@minio2.example.com - export MC_HOST_minio3=https://adminuser:adminpassword@minio3.example.com - - #. Add site replication configuration - - .. code-block:: shell - - mc admin replicate add minio1 minio2 minio3 + .. code-block:: shell + + mc admin replicate info minio1 - If all sites are empty, the order of the aliases does not matter. - If one of the sites contains any :ref:`replicable data `, you must list it first. + You can use the alias for any peer site in the site replication configuration. - No more than one site can contain any replicable data. - - #. Query the site replication configuration to verify - - .. code-block:: shell - - mc admin replicate info minio1 - - You can use the alias for any peer site in the site replication configuration. +#. Query the site replication status to confirm any initial data has replicated to all peer sites. - #. Query the site replication status to confirm any initial data has replicated to all peer sites. - - .. code-block:: shell + .. code-block:: shell - mc admin replicate status minio1 + mc admin replicate status minio1 - You can use the alias for any of the peer sites in the site replication configuration. - The output should say that all :ref:`replicable data ` is in sync. + You can use the alias for any of the peer sites in the site replication configuration. + The output should say that all :ref:`replicable data ` is in sync. - The output could resemble the following: + The output could resemble the following: - .. code-block:: shell + .. code-block:: shell - Bucket replication status: - ● 1/1 Buckets in sync + Bucket replication status: + ● 1/1 Buckets in sync - Policy replication status: - ● 5/5 Policies in sync + Policy replication status: + ● 5/5 Policies in sync - User replication status: - No Users present + User replication status: + No Users present - Group replication status: - No Groups present + Group replication status: + No Groups present - For more on reviewing site replication, see the :ref:`Site Replication Status tutorial `. + For more on reviewing site replication, see the :ref:`Site Replication Status tutorial `. .. _minio-expand-site-replication: @@ -379,161 +310,74 @@ The new site must meet the following requirements: - Uses the same root user credentials as other configured sites - Contains no bucket or object data -.. tab-set:: - - .. tab-item:: Console - :sync: gui - - #. Deploy a new, empty MinIO site - - #. In a browser, access the Console for one of the existing replicated sites - - For example, ``https://:9000`` - - #. Select **Settings**, then **Site Replication** +#. Deploy the new MinIO peer site(s) following the stated requirements - .. screenshot temporarily removed - .. image:: /images/minio-console/console-site-replication-list-of-sites.png - :width: 600px - :alt: MinIO Console Site Replication with three sites listed - :align: center - - #. Select :guilabel:`Add Sites +` - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-add.png - :width: 600px - :alt: MinIO Console's Add Sites for Replication screen - :align: center +#. Configure an alias for the new site - #. Make the following entries: + .. include:: /includes/common-replication.rst + :start-after: start-mc-admin-replicate-load-balancing + :end-before: end-mc-admin-replicate-load-balancing - :Access Key: `(required)` The user name to use for signing in to each site. Should be the same across all sites. + To check the existing aliases, use :mc:`mc alias list`. - :Secret Key: `(required)` The password for the user name to use for signing in to each site. Should be the same across all sites. + Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the new site(s). - :Site Name: An alias to use for the site name. - - :Endpoint: `(required)` The hostname or IP of the load balancer managing connections to the site. - - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing + .. code-block:: shell - To add additional sites beyond two, select the ``+`` button to the side of the last Site entry. + mc alias set minio4 https://minio4.example.com:9000 adminuser adminpassword - #. Select :guilabel:`Save` + or define environment variables - .. tab-item:: Command Line - :sync: cli - - #. Deploy the new MinIO peer site(s) following the stated requirements + .. code-block:: shell + + export MC_HOST_minio4=https://adminuser:adminpassword@minio4.example.com +#. Add site replication configuration - #. Configure an alias for the new site + Use the :mc-cmd:`mc admin replicate add` command to expand the site replication configuration with the new peer site. + Specify the alias of *all* existing peer sites, then the alias of the new site to add. - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing + For example, the following command adds the new peer site ``minio4`` to an existing site replication configuration that includes the existing sites ``minio1``, ``minio2``, and ``minio3``. - To check the existing aliases, use :mc:`mc alias list`. - - Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the new site(s). - - .. code-block:: shell - - mc alias set minio4 https://minio4.example.com:9000 adminuser adminpassword - - or define environment variables - - .. code-block:: shell - - export MC_HOST_minio4=https://adminuser:adminpassword@minio4.example.com - - #. Add site replication configuration + .. code-block:: shell + + mc admin replicate add minio1 minio2 minio3 minio4 - Use the :mc-cmd:`mc admin replicate add` command to expand the site replication configuration with the new peer site. - Specify the alias of *all* existing peer sites, then the alias of the new site to add. + .. note:: - For example, the following command adds the new peer site ``minio4`` to an existing site replication configuration that includes the existing sites ``minio1``, ``minio2``, and ``minio3``. - - .. code-block:: shell - - mc admin replicate add minio1 minio2 minio3 minio4 + If any of the sites are unreachable or permanently lost, you **must** first remove the unreachable site(s) with :mc-cmd:`mc admin replicate rm` before expanding with the new site. - .. note:: +#. Query the site replication configuration to verify - If any of the sites are unreachable or permanently lost, you **must** first remove the unreachable site(s) with :mc-cmd:`mc admin replicate rm` before expanding with the new site. - - #. Query the site replication configuration to verify - - .. code-block:: shell - - mc admin replicate info minio1 + .. code-block:: shell + + mc admin replicate info minio1 Modify a Site's Endpoint ~~~~~~~~~~~~~~~~~~~~~~~~ If a peer site changes its hostname, you can modify the replication configuration to reflect the new hostname. -.. tab-set:: - - .. tab-item:: Console - :sync: gui - - #. In a browser, access the Console for one of the replicated sites - - For example, ``https://:9000`` - - #. Select **Settings**, then **Site Replication** - - #. Select the pencil **Edit** icon to the side of the site to update - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-site-replication-edit-button.png - :width: 600px - :alt: MinIO Console's List of Replicated Sites screen with the edit buttons highlighted - :align: center - - #. Make the following entries: - - :New Endpoint: `(required)` The new endpoint address and port to use. - - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing +#. Obtain the site's Deployment ID with :mc-cmd:`mc admin replicate info` - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-edit-endpoint.png - :width: 600px - :alt: Example of the MinIO Console's Edit Replication Endpoint screen - :align: center + .. code-block:: shell - #. Select **Update** + mc admin replicate info + - .. tab-item:: Command Line - :sync: cli +#. Update the site's endpoint with :mc-cmd:`mc admin replicate update` - #. Obtain the site's Deployment ID with :mc-cmd:`mc admin replicate info` + .. code-block:: shell - .. code-block:: shell + mc admin replicate update ALIAS --deployment-id [DEPLOYMENT-ID] --endpoint [NEW-ENDPOINT] - mc admin replicate info - - - #. Update the site's endpoint with :mc-cmd:`mc admin replicate update` - - .. code-block:: shell - - mc admin replicate update ALIAS --deployment-id [DEPLOYMENT-ID] --endpoint [NEW-ENDPOINT] - - Replace [DEPLOYMENT-ID] with the deployment ID of the site to update. - - Replace [NEW-ENDPOINT] with the new endpoint for the site. + Replace [DEPLOYMENT-ID] with the deployment ID of the site to update. + + Replace [NEW-ENDPOINT] with the new endpoint for the site. - .. include:: /includes/common-replication.rst - :start-after: start-mc-admin-replicate-load-balancing - :end-before: end-mc-admin-replicate-load-balancing + .. include:: /includes/common-replication.rst + :start-after: start-mc-admin-replicate-load-balancing + :end-before: end-mc-admin-replicate-load-balancing Remove a Site from Replication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -541,49 +385,19 @@ Remove a Site from Replication You can remove a site from replication at any time. You can re-add the site at a later date, but you must first completely wipe bucket and object data from the site. -.. tab-set:: - - .. tab-item:: Console - :sync: gui - - #. In a browser, access the Console for one of the replicated sites - - For example, ``https://:9000`` - - #. Select **Settings**, then **Site Replication** - - #. Select the trash can Delete icon to the side of the site to update - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-site-replication-delete-button.png - :width: 600px - :alt: MinIO Console's List of Replicated Sites screen with the delete buttons highlighted - :align: center - - #. Confirm the site deletion at the prompt by selecting **Delete** +Use :mc-cmd:`mc admin replicate rm`: - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-confirm-delete.png - :width: 600px - :alt: Example of the MinIO Console's Edit Replication Endpoint screen - :align: center +.. code-block:: shell - .. tab-item:: Command Line - :sync: cli + mc admin replicate rm ALIAS PEER_TO_REMOVE --force - Use :mc-cmd:`mc admin replicate rm` +- Replace ``ALIAS`` with the :ref:`alias ` of any peer site in the replication configuration. - .. code-block:: shell +- Replace ``PEER_TO_REMOVE`` with the alias of the peer site to remove. - mc admin replicate rm ALIAS PEER_TO_REMOVE --force +All healthy peers in the site replication configuration update to remove the specified peer automatically. - - Replace ``ALIAS`` with the :ref:`alias ` of any peer site in the replication configuration. - - - Replace ``PEER_TO_REMOVE`` with the alias of the peer site to remove. - - All healthy peers in the site replication configuration update to remove the specified peer automatically. - - MinIO requires the ``--force`` flag to remove the peer from the site replication configuration. +MinIO requires the ``--force`` flag to remove the peer from the site replication configuration. .. _minio-site-replication-status-tutorial: @@ -594,89 +408,53 @@ MinIO provides information on replication across the sites for users, groups, po The summary information includes the number of **Synced** and **Failed** items for each category. -.. tab-set:: - - .. tab-item:: Console - :sync: gui - - #. In a browser, access the Console for one of the replicated sites +Use :mc-cmd:`mc admin replicate status`: - For example, ``https://:9000`` +.. code-block:: shell - #. Select **Settings**, then **Site Replication** - - #. Select :guilabel:`Replication Status` - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-status-summary.png - :width: 600px - :alt: MinIO Console's Replication status from all Sites screen - :align: center - - #. `(Optional)` View the replication status for a specific item - - Select the type of item to view in the :guilabel:`View Replication Status for a:` dropdown - - Specify the name of the specific Bucket, Group, Policy, or User to view - - .. screenshot temporarily removed - .. image:: /images/minio-console/console-settings-site-replication-status-item.png - :width: 600px - :alt: Example of replication status for a particular bucket item - :align: center - - #. `(Optional)` Update the information by selecting :guilabel:`Refresh` + mc admin replicate status -- - .. tab-item:: Command Line - :sync: cli - - Use :mc-cmd:`mc admin replicate status` - - .. code-block:: shell - - mc admin replicate status -- - - For example: +For example: - - ``mc admin replicate status minio3 --bucket images`` +- ``mc admin replicate status minio3 --bucket images`` - Displays the replication status for the ``images`` bucket on the ``minio3`` site. - - The output resembles the following: + Displays the replication status for the ``images`` bucket on the ``minio3`` site. + + The output resembles the following: - .. code-block:: + .. code-block:: + + ● Bucket config replication summary for: images - ● Bucket config replication summary for: images + Bucket | MINIO2 | MINIO3 | MINIO4 + Tags | | | + Policy | | | + Quota | | | + Retention | | | + Encryption | | | + Replication | ✔ | ✔ | ✔ + +- ``mc admin replicate status minio3 --all`` + + Displays the replication status summary for all replication sites of which ``minio3`` is part. + + The output resembles the following: + + .. code-block:: + + Bucket replication status: + ● 1/1 Buckets in sync + + Policy replication status: + ● 5/5 Policies in sync + + User replication status: + ● 1/1 Users in sync + + Group replication status: + ● 0/2 Groups in sync + + Group | MINIO2 | MINIO3 | MINIO4 + ittechs | ✗ in-sync | | ✗ in-sync + managers | ✗ in-sync | | ✗ in-sync - Bucket | MINIO2 | MINIO3 | MINIO4 - Tags | | | - Policy | | | - Quota | | | - Retention | | | - Encryption | | | - Replication | ✔ | ✔ | ✔ - - - ``mc admin replicate status minio3 --all`` - - Displays the replication status summary for all replication sites of which ``minio3`` is part. - - The output resembles the following: - - .. code-block:: - - Bucket replication status: - ● 1/1 Buckets in sync - - Policy replication status: - ● 5/5 Policies in sync - - User replication status: - ● 1/1 Users in sync - - Group replication status: - ● 0/2 Groups in sync - - Group | MINIO2 | MINIO3 | MINIO4 - ittechs | ✗ in-sync | | ✗ in-sync - managers | ✗ in-sync | | ✗ in-sync - diff --git a/source/reference/minio-mc/mc-license-register.rst b/source/reference/minio-mc/mc-license-register.rst index 719d1f474..b003f107f 100644 --- a/source/reference/minio-mc/mc-license-register.rst +++ b/source/reference/minio-mc/mc-license-register.rst @@ -15,8 +15,7 @@ ``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 ----------- @@ -197,4 +196,4 @@ Automatic License Updates Once registered for |SUBNET|, MinIO automatically checks for and updates the license every month. -In airgapped or other environments where the server does not have direct access to the internet, use :mc-cmd:`mc license update` with the path to the file to update the registration. \ No newline at end of file +In airgapped or other environments where the server does not have direct access to the internet, use :mc-cmd:`mc license update` with the path to the file to update the registration.