minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity

Adding load balancing content for site replication (#622)

Browse Source 
Closes #618

- Adds recommendation for pointing to a load balancer, reverse proxy, or similar for multi-node environments when creating aliases for site replication. 
- Explains that this recommendation avoids a single point of failure risk.
- Updates tabs on site replication page to be in sync when a reader selects Command Line or Console instructions.
- Adds :sync: option example to the design doc.
This commit is contained in:
Daryl White
2022-10-27 13:10:02 -05:00
committed by GitHub
parent e306783abc
commit 1735b77d8f
3 changed files with 76 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
source/operations/install-deploy-manage/multi-site-replication.rst
View File

@ -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 <minio-encryption-sse-s3>` or :ref:`SSE-KMS <minio-encryption-s
You can achieve this with a central KES server or multiple KES servers (say one per site) connected via a central supported :ref:`key vault server <minio-sse>`.
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 <deploy-minio-distributed>` two or more separate MinIO sites, using the same Identity Provider for each site
@ -141,7 +148,7 @@ Configure Site Replication
For example, ``https://<addressforsite>:9000``
Replace ``<addressforsite>`` with the IP address or URL for the MinIO deployment.
Replace ``<addressforsite>`` 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 <deploy-minio-distributed>`.
One of the sites contains :ref:`replicable data <minio-site-replication-what-replicates>`.
@ -193,10 +205,14 @@ Configure Site Replication
Start with empty sites *or* have no more than one site with any :ref:`replicable data <minio-site-replication-what-replicates>`.
#. 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`