From 380ef25f93a32b102c9b7ed76cbfa4ac94193e93 Mon Sep 17 00:00:00 2001
From: mattray <matthewhray@gmail.com>
Date: Mon, 25 Jun 2012 17:01:45 -0700
Subject: [PATCH] initial Role documentation for Glance, Horizon, Keystone and
 Nova (Swift will come later)

---
 documentation/glance.md   | 36 +++++++++++++++++
 documentation/horizon.md  | 28 +++++++++++++
 documentation/keystone.md | 28 +++++++++++++
 documentation/nova.md     | 84 ++++++++++++++++++++++++++++-----------
 4 files changed, 152 insertions(+), 24 deletions(-)
 create mode 100644 documentation/glance.md
 create mode 100644 documentation/horizon.md
 create mode 100644 documentation/keystone.md

diff --git a/documentation/glance.md b/documentation/glance.md
new file mode 100644
index 0000000..5224829
--- /dev/null
+++ b/documentation/glance.md
@@ -0,0 +1,36 @@
+Description
+===========
+The following roles are used in the deployment of the OpenStack Image Service **Glance** as part of the OpenStack **Essex** reference deployment using Chef.
+
+Dependency Roles
+================
+
+base
+----
+Every Glance role depends on the `base` role included in the repository to ensure essential services (ntp, openssh, etc.).
+
+mysql-master
+------------
+roles and underlying recipes providing database services through MySQL required for glance (and Keystone, Nova and Horizon).
+
+rabbitmq-server
+---------------
+roles and underlying recipes providing messaging services through RabbitMQ required for Glance (and Nova).
+
+os-database
+-----------
+expose and provide the attributes used for configuring glance's database.
+
+os-network
+----------
+expose and provide the attributes used for configuring and defining glance's network.
+
+Glance Roles
+============
+
+glance-api
+----------
+
+
+glance-registry
+---------------
diff --git a/documentation/horizon.md b/documentation/horizon.md
new file mode 100644
index 0000000..17000b9
--- /dev/null
+++ b/documentation/horizon.md
@@ -0,0 +1,28 @@
+Description
+===========
+The following roles are used in the deployment of the OpenStack Dashboard service **Horizon** as part of the OpenStack **Essex** reference deployment using Chef.
+
+Dependency Roles
+================
+
+base
+----
+Every Horizon role depends on the `base` role included in the repository to ensure essential services (ntp, openssh, etc.).
+
+mysql-master
+------------
+roles and underlying recipes providing database services through MySQL required for Horizon (and Keystone, Glance and Nova).
+
+os-database
+-----------
+expose and provide the attributes used for configuring Horizon's database.
+
+os-network
+----------
+expose and provide the attributes used for configuring and defining Horizon's network.
+
+Horizon Roles
+=============
+
+horizon-server
+--------------
diff --git a/documentation/keystone.md b/documentation/keystone.md
new file mode 100644
index 0000000..14f6a36
--- /dev/null
+++ b/documentation/keystone.md
@@ -0,0 +1,28 @@
+Description
+===========
+The following roles are used in the deployment of the OpenStack Identity Service **Keystone** as part of the OpenStack **Essex** reference deployment using Chef.
+
+Dependency Roles
+================
+
+base
+----
+Every Keystone role depends on the `base` role included in the repository to ensure essential services (ntp, openssh, etc.).
+
+mysql-master
+------------
+roles and underlying recipes providing database services through MySQL required for Keystone (and Nova, Glance and Horizon).
+
+os-database
+-----------
+expose and provide the attributes used for configuring Keystone's database.
+
+os-network
+----------
+expose and provide the attributes used for configuring and defining Keystone's network.
+
+Keystone Roles
+==============
+
+keystone
+--------
diff --git a/documentation/nova.md b/documentation/nova.md
index 818dbde..3e9ef39 100644
--- a/documentation/nova.md
+++ b/documentation/nova.md
@@ -1,25 +1,61 @@
-base
-database
-rabbitmq
-keystone
-glance
-nova::setup
-    nova::common : packages, /etc/nova/ nova.conf .novarc
-    configure DB connection, create networks
-nova::scheduler
-nova::api
-nova::volume
-nova::vncproxy
-horizon
+Description
+===========
+The following roles are used in the deployment of the OpenStack Compute service **Nova** as part of the OpenStack **Essex** reference deployment using Chef.
+
+Dependency Roles
+================
+
+base
+----
+Every Nova role depends on the `base` role included in the repository to ensure essential services (ntp, openssh, etc.).
+
+mysql-master
+------------
+roles and underlying recipes providing database services through MySQL required for Nova (and Keystone, Glance and Horizon).
+
+rabbitmq-server
+---------------
+roles and underlying recipes providing messaging services through RabbitMQ required for Nova (and Glance).
+
+os-database
+-----------
+expose and provide the attributes used for configuring Nova's database.
+
+os-network
+----------
+expose and provide the attributes used for configuring and defining Nova's network.
+
+Nova Roles
+==========
+
+allinone
+--------
+
+
+single-compute
+--------------
+
+
+single-controller
+-----------------
+
+
+nova-scheduler
+--------------
+
+
+nova-api-ec2
+------------
+
+
+nova-os-compute
+---------------
+
+
+nova-vncproxy
+-------------
+
+
+nova-volume
+-----------
 
-     "recipe[nova::config]",
-     "recipe[nova::mysql]",
-          "recipe[rabbitmq]",
-         "recipe[nova::rabbit]",
-         "recipe[nova::api]",
-         "recipe[nova::network]",
-         "recipe[nova::scheduler]",
-         "recipe[nova::vncproxy]",
-         "recipe[nova::volume]",
-         "recipe[nova::project]",
-         "recipe[nova::monitor]"