diff --git a/source/design.rst b/source/design.rst index 86f61778..abf64e9d 100644 --- a/source/design.rst +++ b/source/design.rst @@ -82,6 +82,27 @@ MinIO uses the ExecutableBooks mc admin info ALIAS +You can keep tabs in sync. For example, if you have several procedures on a page that have Console and CLI tabs. +Use the `:sync: key1` option on teach `tab-item`. +When someone selects a tab for one or the other, all of the other tabs available on the page with the same key change to that tab, too. + +.. tab-set:: + + .. tab-item:: Console + :sync: gui + + This is plain text content + + .. tab-item:: Command Line + :sync: cli + + This is plain text content with code: + + .. code-block:: shell + :class: copyable + + mc admin info ALIAS + Cards ~~~~~ diff --git a/source/includes/common-replication.rst b/source/includes/common-replication.rst index b4834ed8..079a5350 100644 --- a/source/includes/common-replication.rst +++ b/source/includes/common-replication.rst @@ -73,7 +73,6 @@ Bucket replication requires specific permissions on the source and destination d mc admin policy add TARGET ReplicationAdminPolicy /dev/stdin mc admin user add TARGET ReplicationAdmin LongRandomSecretKey mc admin policy set TARGET ReplicationAdminPolicy user=ReplicationAdmin - MinIO deployments configured for :ref:`Active Directory/LDAP ` or :ref:`OpenID Connect ` user management should instead create a dedicated :ref:`service account ` for bucket replication. .. tab-item:: Replication Remote User @@ -135,4 +134,12 @@ MinIO deployments in a site replication configuration do *not* replicate the cre - :ref:`Lifecycle management (ILM) configurations ` - :ref:`Site configuration settings ` -.. end-mc-admin-replicate-what-does-not-replicate \ No newline at end of file +.. end-mc-admin-replicate-what-does-not-replicate + +.. start-mc-admin-replicate-load-balancing + +When replicating to multi-node sites, use the URL or IP address of the site's load balancer, reverse proxy, or similar network control plane component which automatically routes requests to nodes in the deployment. + +Using a single node for configuring site replication creates a single point of failure, where that node being offline results in replication failure. + +.. end-mc-admin-replicate-load-balancing \ No newline at end of file diff --git a/source/operations/install-deploy-manage/multi-site-replication.rst b/source/operations/install-deploy-manage/multi-site-replication.rst index 02e7ef30..fe9facba 100644 --- a/source/operations/install-deploy-manage/multi-site-replication.rst +++ b/source/operations/install-deploy-manage/multi-site-replication.rst @@ -94,7 +94,6 @@ The other sites must be empty of buckets and objects. After configuring site replication, any data on the first deployment replicates to the other sites. - All Sites Must Use the Same IDP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -108,6 +107,13 @@ For :ref:`SSE-S3 ` or :ref:`SSE-KMS `. +Load Balancers Installed on Each Multi-Node Site +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/common-replication.rst + :start-after: start-mc-admin-replicate-load-balancing + :end-before: end-mc-admin-replicate-load-balancing + Switch to Site Replication from Bucket Replication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -131,6 +137,7 @@ 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 @@ -141,7 +148,7 @@ Configure Site Replication For example, ``https://:9000`` - Replace ```` with the IP address or URL for the MinIO deployment. + 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** @@ -165,7 +172,11 @@ Configure Site Replication :Site Name: A name or other identifying text to associate to the site. - :Endpoint: `(required)` The URL or IP address and port to use to access the site. + :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 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. @@ -182,6 +193,7 @@ Configure Site Replication .. tab-item:: Command Line + :sync: cli The following steps create a new site replication configuration for three :ref:`distributed deployments `. One of the sites contains :ref:`replicable data `. @@ -193,10 +205,14 @@ Configure Site Replication Start with empty sites *or* have no more than one site with any :ref:`replicable data `. #. Configure an alias for each site + + .. 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` + Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the site. .. code-block:: shell @@ -276,6 +292,7 @@ The new site must meet the following requirements: .. tab-set:: .. tab-item:: Console + :sync: gui #. Deploy a new, empty MinIO site @@ -305,13 +322,18 @@ The new site must meet the following requirements: :Site Name: An alias to use for the site name. - :Endpoint: `(required)` The URL or IP address and port to use to access the site. + :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 To add additional sites beyond two, select the ``+`` button to the side of the last Site entry. #. Select :guilabel:`Save` .. tab-item:: Command Line + :sync: cli #. Deploy three or more separate MinIO sites, using the same external IDP @@ -320,11 +342,15 @@ The new site must meet the following requirements: #. Configure an alias for each site + .. include:: /includes/common-replication.rst + :start-after: start-mc-admin-replicate-load-balancing + :end-before: end-mc-admin-replicate-load-balancing + To check the existing aliases, use :mc:`mc alias list`. For example, for three MinIO sites, you might create aliases ``minio1``, ``minio2``, and ``minio3``. - Use :mc:`mc alias set` + Use :mc:`mc alias set` to define the hostname or IP of the load balancer managing connections to the site. .. code-block:: shell @@ -365,6 +391,7 @@ If a peer site changes its hostname, you can modify the replication configuratio .. tab-set:: .. tab-item:: Console + :sync: gui #. In a browser, access the Console for one of the replicated sites @@ -383,6 +410,10 @@ If a peer site changes its hostname, you can modify the replication configuratio :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 + .. image:: /images/minio-console/console-settings-site-replication-edit-endpoint.png :width: 600px :alt: Example of the MinIO Console's Edit Replication Endpoint screen @@ -391,6 +422,7 @@ If a peer site changes its hostname, you can modify the replication configuratio #. Select **Update** .. tab-item:: Command Line + :sync: cli #. Obtain the site's Deployment ID with :mc-cmd:`mc admin replicate info` @@ -409,6 +441,10 @@ If a peer site changes its hostname, you can modify the replication configuratio 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 + Remove a Site from Replication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -418,6 +454,7 @@ You can re-add the site at a later date, but you must first completely wipe buck .. tab-set:: .. tab-item:: Console + :sync: gui #. In a browser, access the Console for one of the replicated sites @@ -440,6 +477,7 @@ You can re-add the site at a later date, but you must first completely wipe buck :align: center .. tab-item:: Command Line + :sync: cli Use :mc-cmd:`mc admin replicate remove` @@ -463,6 +501,7 @@ The summary information includes the number of **Synced** and **Failed** items f .. tab-set:: .. tab-item:: Console + :sync: gui #. In a browser, access the Console for one of the replicated sites @@ -491,6 +530,7 @@ The summary information includes the number of **Synced** and **Failed** items f #. `(Optional)` Update the information by selecting :guilabel:`Refresh` .. tab-item:: Command Line + :sync: cli Use :mc-cmd:`mc admin replicate status`