openstack
/
charm-deployment-guide
Code Issues Proposed changes

Review deploy guide front page 

This is the first of an intended comprehensive series
of reviews for the deploy guide.

Change-Id: I334332c9b4a4c5990e8b15c90add265efdb238ac
This commit is contained in:
Peter Matulis 2019-11-28 19:10:07 -05:00
parent 0cb06a019e
commit 94a3d7dc4d
1 changed files with 38 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
deploy-guide/source/index.rst
View File

@ -3,24 +3,44 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=================================
OpenStack Charms Deployment Guide
=================================
Overview
++++++++
--------
The purpose of this guide is to document the steps necessary to build a
multi-node OpenStack cluster using `Juju <https://jaas.ai/>`__,
`MAAS <https://maas.io/>`__, and
`OpenStack Charms <https://docs.openstack.org/charm-guide/latest/>`__.
Specific use cases and customization scenarios are documented in the
appendices.
The main purpose of the OpenStack Charms Deployment Guide is to demonstrate how
to build a multi-node OpenStack cloud with `MAAS`_, `Juju`_, and `OpenStack
Charms`_. For accessibility reasons, the cloud will be minimal, while remaining
capable of both performing some real work and scaling to fit more ambitious
projects.
Software versions used in this guide are as follows:
* **Ubuntu 18.04 LTS** (Bionic) for the MAAS system, its cluster nodes, and all
cloud nodes
* **MAAS 2.6.2**
* **Juju 2.7.0**
.. note::
For OpenStack Charms project information, development guidelines, release
notes, and release schedules, please refer to the
`charm guide <https://docs.openstack.org/charm-guide/latest/>`__.
For OpenStack Charms project information, development guidelines, release
notes, and release schedules, please refer to the `OpenStack Charm Guide`_.
Appendices
----------
The guide also includes a wealth of information in the form of appendices.
These cover a wide variety of subjects, such as an elaboration of a specific
charm feature, how to upgrade an OpenStack cloud, or how to manage power events
in a cloud.
Help improve this guide
-----------------------
To help improve this guide you may `file an issue`_ or `submit a
contribution`_.
.. toctree::
:maxdepth: 2
@ -33,3 +53,11 @@ appendices.
app.rst
* :ref:`search`
.. LINKS
.. _MAAS: https://maas.io
.. _Juju: https://jaas.ai
.. _OpenStack Charms: https://docs.openstack.org/charm-guide
.. _OpenStack Charm Guide: https://docs.openstack.org/charm-guide
.. _file an issue: https://bugs.launchpad.net/charm-deployment-guide/+filebug
.. _submit a contribution: https://opendev.org/openstack/charm-deployment-guide