From 6b7af5f867f412984cbef607b64ad9af4dbfe258 Mon Sep 17 00:00:00 2001
From: Przemyslaw Kaminski <pkaminski@mirantis.com>
Date: Thu, 16 Jul 2015 09:04:59 +0200
Subject: [PATCH] Add some README's to couple of resources

---
 resources/haproxy_config/README.md         | 11 +++++++++++
 resources/haproxy_service/README.md        |  8 ++++++++
 resources/haproxy_service_config/README.md |  5 +++++
 resources/keystone_service/README.md       | 11 +++++++++++
 4 files changed, 35 insertions(+)
 create mode 100644 resources/haproxy_config/README.md
 create mode 100644 resources/haproxy_service/README.md
 create mode 100644 resources/haproxy_service_config/README.md
 create mode 100644 resources/keystone_service/README.md

diff --git a/resources/haproxy_config/README.md b/resources/haproxy_config/README.md
new file mode 100644
index 00000000..c0ee178a
--- /dev/null
+++ b/resources/haproxy_config/README.md
@@ -0,0 +1,11 @@
+# `haproxy_config` resource
+
+This resource represents configuration for the `haproxy_service` resource.
+Each service represented by Haproxy is connected to this resource via
+`haproxy_service_config` resource. This is because in Haproxy there is no
+support for something like `/etc/haproxy/conf.d` directory where you put
+each config in a separate file, but instead you must collect all configuration
+in one file.
+
+So this resource renders this file from data provided by collecting individual
+`haproxy_service_config` data.
diff --git a/resources/haproxy_service/README.md b/resources/haproxy_service/README.md
new file mode 100644
index 00000000..348cd1e4
--- /dev/null
+++ b/resources/haproxy_service/README.md
@@ -0,0 +1,8 @@
+# `haproxy_service` resource
+
+This resource sets up a Docker container with Haproxy code. It requires
+config to be provided by the `haproxy_config` resource (mounted under
+`/etc/haproxy`).
+
+About container philosophy, see the `README.md` file in `keystone_service`
+resource.
diff --git a/resources/haproxy_service_config/README.md b/resources/haproxy_service_config/README.md
new file mode 100644
index 00000000..fdbf60d4
--- /dev/null
+++ b/resources/haproxy_service_config/README.md
@@ -0,0 +1,5 @@
+# `haproxy_service_config` resource
+
+This resource represents config for a single service handled by Haproxy.
+It connects into `haproxy_config`. It collects all services which are to
+be load-balanced by Haproxy.
diff --git a/resources/keystone_service/README.md b/resources/keystone_service/README.md
new file mode 100644
index 00000000..aac0b259
--- /dev/null
+++ b/resources/keystone_service/README.md
@@ -0,0 +1,11 @@
+# `keystone_service` resource
+
+This resource sets up a Docker container with Keystone code. It requires
+config to be provided by the `keystone_config` resource (mounted under
+`/etc/keystone`).
+
+Basically, the philosophy behind containers in Solar is to have stateless
+containers with service code and mount stateful resources with config,
+volumes, etc. to that container. Upgrade of code then would be just about
+replacing the stateless container with new one and remounting state to that
+new container.