github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/docs/federation/lookup/README.md (about)

     1  # Federation Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) *Federation feature is deprecated and should be avoided for future deployments*
     2  
     3  This document explains how to configure MinIO with `Bucket lookup from DNS` style federation.
     4  
     5  ## Get started
     6  
     7  ### 1. Prerequisites
     8  
     9  Install MinIO - [MinIO Quickstart Guide](https://min.io/docs/minio/linux/index.html#quickstart-for-linux).
    10  
    11  ### 2. Run MinIO in federated mode
    12  
    13  Bucket lookup from DNS federation requires two dependencies
    14  
    15  - etcd (for bucket DNS service records)
    16  - CoreDNS (for DNS management based on populated bucket DNS service records, optional)
    17  
    18  ## Architecture
    19  
    20  ![bucket-lookup](https://github.com/minio/minio/blob/master/docs/federation/lookup/bucket-lookup.png?raw=true)
    21  
    22  ### Environment variables
    23  
    24  #### MINIO_ETCD_ENDPOINTS
    25  
    26  This is comma separated list of etcd servers that you want to use as the MinIO federation back-end. This should
    27  be same across the federated deployment, i.e. all the MinIO instances within a federated deployment should use same
    28  etcd back-end.
    29  
    30  #### MINIO_DOMAIN
    31  
    32  This is the top level domain name used for the federated setup. This domain name should ideally resolve to a load-balancer
    33  running in front of all the federated MinIO instances. The domain name is used to create sub domain entries to etcd. For
    34  example, if the domain is set to `domain.com`, the buckets `bucket1`, `bucket2` will be accessible as `bucket1.domain.com`
    35  and `bucket2.domain.com`.
    36  
    37  #### MINIO_PUBLIC_IPS
    38  
    39  This is comma separated list of IP addresses to which buckets created on this MinIO instance will resolve to. For example,
    40  a bucket `bucket1` created on current MinIO instance will be accessible as `bucket1.domain.com`, and the DNS entry for
    41  `bucket1.domain.com` will point to IP address set in `MINIO_PUBLIC_IPS`.
    42  
    43  - This field is mandatory for standalone and erasure code MinIO server deployments, to enable federated mode.
    44  - This field is optional for distributed deployments. If you don't set this field in a federated setup, we use the IP addresses of
    45  hosts passed to the MinIO server startup and use them for DNS entries.
    46  
    47  ### Run Multiple Clusters
    48  
    49  > cluster1
    50  
    51  ```sh
    52  export MINIO_ETCD_ENDPOINTS="http://remote-etcd1:2379,http://remote-etcd2:4001"
    53  export MINIO_DOMAIN=domain.com
    54  export MINIO_PUBLIC_IPS=44.35.2.1,44.35.2.2,44.35.2.3,44.35.2.4
    55  minio server http://rack{1...4}.host{1...4}.domain.com/mnt/export{1...32}
    56  ```
    57  
    58  > cluster2
    59  
    60  ```sh
    61  export MINIO_ETCD_ENDPOINTS="http://remote-etcd1:2379,http://remote-etcd2:4001"
    62  export MINIO_DOMAIN=domain.com
    63  export MINIO_PUBLIC_IPS=44.35.1.1,44.35.1.2,44.35.1.3,44.35.1.4
    64  minio server http://rack{5...8}.host{5...8}.domain.com/mnt/export{1...32}
    65  ```
    66  
    67  In this configuration you can see `MINIO_ETCD_ENDPOINTS` points to the etcd backend which manages MinIO's
    68  `config.json` and bucket DNS SRV records. `MINIO_DOMAIN` indicates the domain suffix for the bucket which
    69  will be used to resolve bucket through DNS. For example if you have a bucket such as `mybucket`, the
    70  client can use now `mybucket.domain.com` to directly resolve itself to the right cluster. `MINIO_PUBLIC_IPS`
    71  points to the public IP address where each cluster might be accessible, this is unique for each cluster.
    72  
    73  NOTE: `mybucket` only exists on one cluster either `cluster1` or `cluster2` this is random and
    74  is decided by how `domain.com` gets resolved, if there is a round-robin DNS on `domain.com` then
    75  it is randomized which cluster might provision the bucket.
    76  
    77  ### 3. Test your setup
    78  
    79  To test this setup, access the MinIO server via browser or [`mc`](https://min.io/docs/minio/linux/reference/minio-mc.html#quickstart). You’ll see the uploaded files are accessible from the all the MinIO endpoints.
    80  
    81  ## Explore Further
    82  
    83  - [Use `mc` with MinIO Server](https://min.io/docs/minio/linux/reference/minio-mc.html)
    84  - [Use `aws-cli` with MinIO Server](https://min.io/docs/minio/linux/integrations/aws-cli-with-minio.html)
    85  - [Use `minio-go` SDK with MinIO Server](https://min.io/docs/minio/linux/developers/go/minio-go.html)
    86  - [The MinIO documentation website](https://min.io/docs/minio/linux/index.html)