From d02a712c728f41979e82f72edc3bd034d3f3865b Mon Sep 17 00:00:00 2001
From: Elizabeth Krumbach Joseph <lyz@princessleia.com>
Date: Mon, 7 Oct 2013 16:23:32 -0700
Subject: [PATCH] Add basic nodepool documentation page

This initial basic nodepool document provides links to the manifests and
configuration for nodepool so people have a starting point to figure out
how it works, as well as a simple description of its purpose.

Change-Id: I3cc4e59e1e5ba4d62fd16c0da79d75352e9d78f0
---
 doc/source/nodepool.rst | 34 ++++++++++++++++++++++++++++++++++
 doc/source/systems.rst  |  1 +
 2 files changed, 35 insertions(+)
 create mode 100644 doc/source/nodepool.rst

diff --git a/doc/source/nodepool.rst b/doc/source/nodepool.rst
new file mode 100644
index 0000000000..106a08650d
--- /dev/null
+++ b/doc/source/nodepool.rst
@@ -0,0 +1,34 @@
+:title: Nodepool
+
+.. _nodepool:
+
+Nodepool
+########
+
+Nodepool is a service used by the OpenStack CI team to deploy and manage a pool
+of devstack images on a cloud server for use in OpenStack project testing.
+
+At a Glance
+===========
+
+:Hosts:
+  * nodepool.openstack.org
+:Puppet:
+  * :file:`modules/nodepool/`
+  * :file:`modules/openstack_project/manifests/dev_slave_template.pp`
+:Configuration:
+  * :file:`modules/openstack_project/templates/nodepool/nodepool.yaml.erb`
+  * :file:`modules/openstack_project/files/nodepool/scripts/`
+:Projects:
+  * https://git.openstack.org/openstack-infra/nodepool
+:Bugs:
+  * http://bugs.launchpad.net/openstack-ci
+
+Overview
+========
+
+Once per day, for every image type (and provider) configured by nodepool, a new
+image with cached data for use by devstack.  Nodepool spins up new instances
+and tears down old as tests are queued up and completed, always maintaining a
+consistant number of available instances for tests up to the set limits of the
+CI infrastructure.
diff --git a/doc/source/systems.rst b/doc/source/systems.rst
index c0816bdf14..b191e086dd 100644
--- a/doc/source/systems.rst
+++ b/doc/source/systems.rst
@@ -13,6 +13,7 @@ Major Systems
    jjb
    logstash
    devstack-gate
+   nodepool
    jeepyb
    irc
    etherpad