From 5f381fe25a028a7c8a114d89032d30f70b814fcc Mon Sep 17 00:00:00 2001
From: Ryan Hallisey <rhallise@redhat.com>
Date: Wed, 25 Mar 2015 16:01:21 -0400
Subject: [PATCH] Add doc for the minimal environment vars required per
container
Each container requires a set of environment variables be declared
so that it can function in a minimal setting. This doc will
provide a list of those environment var for each container.
Change-Id: I225f53c869e5830d680792fd0a38f6622ba9b04b
---
docs/integration-guide.md | 3 +-
docs/minimal-environment-vars.md | 218 +++++++++++++++++++++++++++++++
2 files changed, 219 insertions(+), 2 deletions(-)
create mode 100644 docs/minimal-environment-vars.md
diff --git a/docs/integration-guide.md b/docs/integration-guide.md
index 118728d9b7..860ec5f23a 100644
--- a/docs/integration-guide.md
+++ b/docs/integration-guide.md
@@ -83,8 +83,7 @@ all containers. This allows a simple method of ensuring every type of node
RABBIT_PASSWORD=<password> - The RabbitMQ password
RABBIT_USERID=<rabbit> - The RabbitMQ user id on the host
-
-
+[Minimum environment variable setup guide.](https://github.com/stackforge/kolla/blob/master/docs/minimal-environment-vars.md)
## Launching a container set
diff --git a/docs/minimal-environment-vars.md b/docs/minimal-environment-vars.md
new file mode 100644
index 0000000000..f610f6cc35
--- /dev/null
+++ b/docs/minimal-environment-vars.md
@@ -0,0 +1,218 @@
+# Environment Variables
+
+In order for each service to function, there is a minimum set of required variables that need to be plugged into the environment. Below is the list of variables that is needed for each service to run in a minimal setting.
+
+# Mariadb
+
+ MARIADB_SERVICE_HOST
+ MYSQL_ROOT_PASSWORD
+
+# Keystone
+
+ MYSQL_ROOT_PASSWORD
+ GLANCE_KEYSTONE_PASSWORD
+ GLANCE_KEYSTONE_USER
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+
+# Glance-api
+
+ MYSQL_ROOT_PASSWORD
+ GLANCE_KEYSTONE_PASSWORD
+ GLANCE_KEYSTONE_USER
+ GLANCE_DB_USER
+ GLANCE_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ GLANCE_REGISTRY_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ PUBLIC_IP
+
+# Glance-registry
+
+ MYSQL_ROOT_PASSWORD
+ GLANCE_KEYSTONE_PASSWORD
+ GLANCE_KEYSTONE_USER
+ GLANCE_DB_USER
+ GLANCE_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ GLANCE_REGISTRY_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ PUBLIC_IP
+
+# Nova-conductor
+
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ PUBLIC_INTERFACE
+ FLAT_INTERFACE
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ RABBITMQ_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ NOVA_CONDUCTOR_SERVICE_HOST
+ NOVA_EC2_API_SERVICE_HOST
+ NOVA_EC2_SERVICE_HOST
+ PUBLIC_IP
+
+# Nova-api
+
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ PUBLIC_INTERFACE
+ FLAT_INTERFACE
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ RABBITMQ_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ NOVA_API_SERVICE_HOST
+ NOVA_EC2_API_SERVICE_HOST
+ NOVA_EC2_SERVICE_HOST
+ PUBLIC_IP
+
+# Nova-compute
+
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ PUBLIC_INTERFACE
+ FLAT_INTERFACE
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ RABBITMQ_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ NOVA_COMPUTE_SERVICE_HOST
+ NOVA_EC2_COMPUTE_SERVICE_HOST
+ NOVA_EC2_SERVICE_HOST
+ PUBLIC_IP
+
+# Nova-libvirt
+
+ None
+
+# Nova-scheduler
+
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ PUBLIC_INTERFACE
+ FLAT_INTERFACE
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ RABBITMQ_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ NOVA_SCHEDULER_SERVICE_HOST
+ NOVA_EC2_SCHEDULER_SERVICE_HOST
+ NOVA_EC2_SERVICE_HOST
+ PUBLIC_IP
+
+# Nova-network
+
+ MYSQL_ROOT_PASSWORD
+ NOVA_KEYSTONE_PASSWORD
+ NOVA_KEYSTONE_USER
+ NOVA_DB_USER
+ NOVA_DB_NAME
+ KEYSTONE_ADMIN_PASSWORD
+ KEYSTONE_ADMIN_SERVICE_PORT
+ KEYSTONE_ADMIN_TOKEN
+ KEYSTONE_AUTH_PROTOCOL
+ KEYSTONE_DB_PASSWORD
+ ADMIN_TENANT_NAME
+ DB_ROOT_PASSWORD
+ PUBLIC_INTERFACE
+ FLAT_INTERFACE
+ KEYSTONE_ADMIN_SERVICE_HOST
+ KEYSTONE_PUBLIC_SERVICE_HOST
+ MARIADB_SERVICE_HOST
+ RABBITMQ_SERVICE_HOST
+ GLANCE_API_SERVICE_HOST
+ NOVA_NETWORK_SERVICE_HOST
+ NOVA_EC2_NETWORK_SERVICE_HOST
+ NOVA_EC2_SERVICE_HOST
+ PUBLIC_IP
--
GitLab