From 0d2625bb5c83c064bedb6ba171e15e2c9fc36a33 Mon Sep 17 00:00:00 2001
From: Alex Kavanagh <alex@ajkavanagh.co.uk>
Date: Fri, 11 Aug 2017 15:38:20 +0100
Subject: [PATCH] Add small section on charm-store

Added a small section on where to find the charms on the
juju charm store.

Change-Id: I0d9e35613c6e8e7d16d160f6cb35098c69447b16
---
 doc/source/charm-store.rst       | 71 ++++++++++++++++++++++++++++++++
 doc/source/creating-charms.rst   |  2 +
 doc/source/deployment.rst        |  1 +
 doc/source/how-to-contribute.rst |  2 +-
 4 files changed, 75 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/charm-store.rst

diff --git a/doc/source/charm-store.rst b/doc/source/charm-store.rst
new file mode 100644
index 00000000..5eed8816
--- /dev/null
+++ b/doc/source/charm-store.rst
@@ -0,0 +1,71 @@
+.. _charm-store:
+
+==============================
+Deploying from the Charm Store
+==============================
+
+All of the OpenStack charms, and related, charms are stored in the `Juju Charm
+Store`_ which is a repository from which to deploy charms.
+
+.. _Juju Charm Store: https://jujucharms.com/q/?text=openstack
+
+Targets in the Charm Store
+==========================
+
+You can deploy from either of the following targets in the charm store.
+
+* For stable charms: ``cs:<charm name>``
+* For development charms: ``cs:~openstack-charmers-next/<charm name>``
+
+Note that OpenStack charms support multiple OpenStack versions *and* multiple
+Ubuntu releases.  The currently supported versions and combinations can be
+found at the `Ubuntu Cloud Archive`_ page and `Ubuntu release end of life`_
+pages.
+
+.. _Ubuntu Cloud Archive: https://wiki.ubuntu.com/OpenStack/CloudArchive
+.. _Ubuntu release end of life: https://www.ubuntu.com/info/release-end-of-life
+
+e.g. ``cs:xenial/keystone`` is the stable charm in the 16.04 Xenial release of
+ubuntu, whereas ``cs:~openstack-charmers-next/keystone`` is the current
+development version (against Xenial).
+
+Note that OpenStack development team develops against the current released LTS
+version of Ubuntu, and the current development release of Ubuntu.
+
+Example Bundle
+~~~~~~~~~~~~~~
+
+.. code-block:: yaml
+
+    # vim: set ts=2 et:
+    # deployer bundle for development ('next') charms
+    openstack-services:
+      series: trusty
+      services:
+        mysql:
+          branch: cs:~openstack-charmers-next/percona-cluster
+          constraints: mem=1G
+          options:
+            dataset-size: 50%
+        rabbitmq-server:
+          branch: cs:~openstack-charmers-next/rabbitmq-server
+          constraints: mem=1G
+        keystone:
+          branch: cs:~openstack-charmers-next/keystone
+          constraints: mem=1G
+          options:
+            admin-password: openstack
+            admin-token: ubuntutesting
+            openstack-origin: cloud:xenial-mitaka
+        barbican:
+          charm: barbican
+          options:
+            openstack-origin: cloud:trusty-kilo
+      relations:
+        - [ keystone, mysql ]
+        - [ barbican, mysql ]
+        - [ barbican, rabbitmq-server ]
+        - [ barbican, keystone ]
+
+In this example the bundle would be used to deploy the 'next' charms (i.e.
+those in development) with a local barbican charm.
diff --git a/doc/source/creating-charms.rst b/doc/source/creating-charms.rst
index 9e8677a4..2763cae4 100644
--- a/doc/source/creating-charms.rst
+++ b/doc/source/creating-charms.rst
@@ -1,3 +1,5 @@
+.. _creating-charms:
+
 ==============
 Create A Charm
 ==============
diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst
index 43747c0f..5c8a2f1d 100644
--- a/doc/source/deployment.rst
+++ b/doc/source/deployment.rst
@@ -15,3 +15,4 @@ managed using MAAS.
    :maxdepth: 1
 
    openstack-on-lxd
+   charm-store
diff --git a/doc/source/how-to-contribute.rst b/doc/source/how-to-contribute.rst
index c09ba76e..163c5fdd 100644
--- a/doc/source/how-to-contribute.rst
+++ b/doc/source/how-to-contribute.rst
@@ -17,6 +17,6 @@ to the OpenStack Charms.
    coding-guidelines
    testing
    making-a-change
-   new-charm
+   creating-charms
    backport-policy
    reviews