From fb4186f6b9057f004bffc26a8f197ced60cb9320 Mon Sep 17 00:00:00 2001 From: ebozduman Date: Mon, 10 Sep 2018 17:14:40 -0700 Subject: [PATCH] Adds missing info to docs for credentials and domain env. vars. (#6447) * Adds missing information to documentation for credentials and domain environment variables for distributed minio server startup. --- docs/distributed/README.md | 3 ++- docs/multi-tenancy/README.md | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/distributed/README.md b/docs/distributed/README.md index f5f637fc3..7b709da10 100644 --- a/docs/distributed/README.md +++ b/docs/distributed/README.md @@ -42,8 +42,9 @@ To start a distributed Minio instance, you just need to pass drive locations as *Note* -- All the nodes running distributed Minio need to have same access key and secret key for the nodes to connect. To achieve this, you need to export access key and secret key as environment variables on all the nodes before executing Minio server command. +- All the nodes running distributed Minio need to have same access key and secret key for the nodes to connect. To achieve this, it is **mandatory** to export access key and secret key as environment variables, `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY`, on all the nodes before executing Minio server command. - All the nodes running distributed Minio need to be on homogenous environments i.e same operating system, same number of disks and same interconnects. +- `MINIO_DOMAIN` environment variable should be defined and exported if domain is needed to be set. - Minio distributed mode requires fresh directories. If required, the drives can be shared with other applications. You can do this by using a sub-directory exclusive to minio. For example, if you have mounted your volume under `/export`, pass `/export/data` as arguments to Minio server. - The IP addresses and drive paths below are for demonstration purposes only, you need to replace these with the actual IP addresses and drive paths/folders. - Servers running distributed Minio instances should be less than 3 seconds apart. You can use [NTP](http://www.ntp.org/) as a best practice to ensure consistent times across servers. diff --git a/docs/multi-tenancy/README.md b/docs/multi-tenancy/README.md index af8019475..3ff47a076 100644 --- a/docs/multi-tenancy/README.md +++ b/docs/multi-tenancy/README.md @@ -47,7 +47,12 @@ minio --config-dir ~/tenant3 server --address :9003 http://192.168.10.11/data/te ![Example-3](https://github.com/minio/minio/blob/master/docs/screenshots/Example-3.jpg?raw=true) +*Note* + +Please remember that defining and exporting credential environment variables, `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY`, is **mandatory** on distributed deployments. It is also required to define and export domain environment variable, `MINIO_DOMAIN`, if domain information is needed to be set. + ## Cloud Scale Deployment + For large scale multi-tenant Minio deployments, we recommend using one of the popular container orchestration platforms, e.g. Kubernetes, DC/OS or Docker Swarm. Refer [this document](https://docs.minio.io/docs/minio-deployment-quickstart-guide) to get started with Minio on orchestration platforms.