aboutsummaryrefslogtreecommitdiff
path: root/doc/vagrant-dev-env.rst
diff options
context:
space:
mode:
authorSwapnil Kulkarni (coolsvap) <me@coolsvap.net>2016-05-16 20:37:35 +0530
committerSwapnil Kulkarni (coolsvap) <me@coolsvap.net>2016-05-16 23:55:35 +0530
commitd87b4f63a2a4bd7017a94677e5310051689bb03d (patch)
treef0f9b403b64e5a7b0479161beece5e7baa7233a9 /doc/vagrant-dev-env.rst
parent460ebbe02141f9aefbaaf00c67c4cde134525513 (diff)
downloadkolla-d87b4f63a2a4bd7017a94677e5310051689bb03d.tar.gz
kolla-d87b4f63a2a4bd7017a94677e5310051689bb03d.zip
Structuring the documentation
Restructured the documenation to 1. Add reference at the top 2. Updated the title formatting 3. Updated the heading formatting 4. Updated the links formatting Change-Id: Ie3786e92fee674da1fa39cf07f1bf0a3badd5b92
Diffstat (limited to 'doc/vagrant-dev-env.rst')
-rw-r--r--doc/vagrant-dev-env.rst17
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/vagrant-dev-env.rst b/doc/vagrant-dev-env.rst
index 4bd6bf97c..1d861156e 100644
--- a/doc/vagrant-dev-env.rst
+++ b/doc/vagrant-dev-env.rst
@@ -1,3 +1,6 @@
+.. vagrant-dev-env:
+
+====================================
Development Environment with Vagrant
====================================
@@ -9,7 +12,7 @@ takes care of setting up CentOS-based VMs for Kolla development, each with
proper hardware like memory amount and number of network interfaces.
Getting Started
----------------
+===============
The Vagrant script implements All-in-One (AIO) or multi-node deployments. AIO
is the default.
@@ -91,7 +94,7 @@ The command ``vagrant status`` provides a quick overview of the VMs composing
the environment.
Vagrant Up
-----------
+==========
Once Vagrant has completed deploying all nodes, the next step is to launch
Kolla. First, connect with the *operator* node::
@@ -110,9 +113,8 @@ a different docker binary to the cluster. The shared folder is also used to
store the docker-registry files, so they are save from destructive operations
like ``vagrant destroy``.
-
Building images
-^^^^^^^^^^^^^^^
+---------------
Once logged on the *operator* VM call the ``kolla-build`` utility::
@@ -122,10 +124,8 @@ Once logged on the *operator* VM call the ``kolla-build`` utility::
builds Docker images and pushes them to the local registry if the *push*
option is enabled (in Vagrant this is the default behaviour).
-
-
Deploying OpenStack with Kolla
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------
Deploy AIO with::
@@ -143,9 +143,8 @@ Validate OpenStack is operational::
Or navigate to http://10.10.10.254/ with a web browser.
-
Further Reading
----------------
+===============
All Vagrant documentation can be found at
`docs.vagrantup.com <http://docs.vagrantup.com>`__.