From 12a916091e6ed98fda1ce0c4a00e98a561a1cb2c Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Sat, 9 Jun 2018 01:30:11 -0700 Subject: [PATCH] Convert federation doc as quickstart guide (#6030) --- docs/federation/lookup/Corefile.example | 2 +- docs/federation/lookup/README.md | 23 +++++++++++++++++++---- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/federation/lookup/Corefile.example b/docs/federation/lookup/Corefile.example index 5b64fadcf..2168e1172 100644 --- a/docs/federation/lookup/Corefile.example +++ b/docs/federation/lookup/Corefile.example @@ -5,7 +5,7 @@ } debug prometheus - cache 160 churchofminio.com + cache 160 mydomain.com loadbalance proxy . /etc/resolv.conf } \ No newline at end of file diff --git a/docs/federation/lookup/README.md b/docs/federation/lookup/README.md index 94f086185..9ad4db42a 100644 --- a/docs/federation/lookup/README.md +++ b/docs/federation/lookup/README.md @@ -1,11 +1,16 @@ -# Federation +# Federation Quickstart Guide [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) This document explains how to configure Minio with `Bucket lookup from DNS` style federation. -## Dependencies +## Get started + +### 1. Prerequisites +Install Minio - [Minio Quickstart Guide](https://docs.minio.io/docs/minio). + +### 2. Run Minio in federated mode Bucket lookup from DNS federation requires two dependencies - etcd (for config, bucket SRV records) -- coredns (for DNS management based on populated bucket SRV records) +- coredns (for DNS management based on populated bucket SRV records, optional) ## Architecture @@ -36,7 +41,7 @@ a bucket `bucket1` created on current Minio instance will be accessible as `buck - This field is mandatory for standalone and erasure code Minio server deployments, to enable federated mode. - This field is optional for distributed deployments. If you don't set this field in a federated setup, we use the IP addresses of -hosts passed to the Minio server startup and use that to make DNS entries. +hosts passed to the Minio server startup and use them for DNS entries. ### Run Multiple Clusters @@ -67,3 +72,13 @@ points to the public IP address where each cluster might be accessible, this is NOTE: `mybucket` only exists on one cluster either `cluster1` or `cluster2` this is random and is decided by how `domain.com` gets resolved, if there is a round-robin DNS on `domain.com` then it is randomized which cluster might provision the bucket. + +### 3. Test your setup +To test this setup, access the Minio server via browser or [`mc`](https://docs.minio.io/docs/minio-client-quickstart-guide). You’ll see the uploaded files are accessible from the all the Minio endpoints. + +# Explore Further +- [Use `mc` with Minio Server](https://docs.minio.io/docs/minio-client-quickstart-guide) +- [Use `aws-cli` with Minio Server](https://docs.minio.io/docs/aws-cli-with-minio) +- [Use `s3cmd` with Minio Server](https://docs.minio.io/docs/s3cmd-with-minio) +- [Use `minio-go` SDK with Minio Server](https://docs.minio.io/docs/golang-client-quickstart-guide) +- [The Minio documentation website](https://docs.minio.io)