Commit Graph

19 Commits

Author SHA1 Message Date
Matthew Kassawara
c3025ed093 Update documentation for multiple VLAN ranges
Update example configuration file and installation guide to
mention support for multiple VLAN ranges on a particular
network and provide examples. Also address other minor
issues with networking content in the installation guide.

Change-Id: Idca97092f326cfbd83a018e853d3e7655d20e491
Partial-Bug: #1475436
2015-08-21 16:42:24 +00:00
Nolan Brubaker
a6548e4f11 Move developer documentation to its own subtree
Prior to this change, all files at the root of the doc/source/ directory
were implied to be developer documentation. This commit moves them into
an explicit subdirectory, and re-words the section headings to be less
repetitive.

No changes to formatting or content were introduced.

Change-Id: Id00116ad2146f11df52dd8a331834719e1b8bd03
Closes-Bug: #1486789
2015-08-19 21:27:46 -04:00
Jenkins
94a45122a4 Merge "Invalid link "deployment-os.html" in Install Guide" 2015-08-15 07:22:13 +00:00
Jenkins
6c81e82edc Merge "Cinder_volumes_containers are automatically tagged with is_metal" 2015-08-13 15:12:51 +00:00
Yoshitaka Tahara
b337269193 Invalid link "deployment-os.html" in Install Guide
FIX Invalid Link in Install Guide
  /doc/source/install-guide/navigation.txt Line 18
   <deploymentos.html> -> deploymenthostos.html

Change-Id: Ibe22ad32a9c9ce90a8aa7003bb04f6bb45fe9b38
Closes-Bug: #1483271
2015-08-13 12:10:47 +00:00
Jenkins
788f742179 Merge "Document required repository hosts config info" 2015-08-13 11:58:00 +00:00
Nolan Brubaker
7431aafa86 Document required repository hosts config info
Installs must have either the repo-infra_hosts list, or the
openstack_repo_url defined. Otherwise, greenfield installations
following our installation docs will fail.

Change-Id: I116040302e846530895836dd8aab9d4136b110af
Closes-Bug: #1475000
2015-08-13 12:45:57 +01:00
Jean-Philippe Evrard
e7036b8e8d Documentation of the static-route feature
This documents the change Id5a74db2399166af2d6ac289b71ebb0de04f5679.

DocImpact
Change-Id: I0977fb5c8372b42fbd62c52c62f6a5162fc6962b
2015-08-13 12:43:22 +01:00
Jean-Philippe Evrard
4bf2a1f37c Cinder_volumes_containers are automatically tagged with is_metal
In env.d/cinder.yml there is is_metal:true. 
But there was no mention of it in the documentation.
Therefore, if an user wants to use a cinder volume container with 
netapp/ceph/whatever, the container will be (by default) 
considered as metal.
This should be documented somewhere.

Change-Id: I65e9d0654d50d8c8825f858e89fdf4595134dddb
2015-08-13 12:00:49 +01:00
David Stanek
ed6ebcca03 Adds ceilometer link in configure.rst
This gets rid of the warning message saying that nothing is actually
linking to the document.

To get rid of the chicken-egg problem:

The -infra templated job for docs requires that a venv be created using
tox. It will actually run this command to build the documentation:

  tox -evenv -- python setup.py build_sphinx

Change-Id: I0f03ad6efe2a997c9cecac6240e1e8be8e85ccf6
2015-08-12 17:20:52 +00:00
David Stanek
0ec3ce3d31 Uses tox for automating documentation builds
Change-Id: I8012889aa6938378b5e5e85fb443cf13be460d61
Closes-Bug: #1469870
2015-08-12 06:32:40 +01:00
Jenkins
3d1fade039 Merge "Implement Ceilometer" 2015-07-09 17:50:10 +00:00
Miguel Cantu
653f184733 Implement Ceilometer
This patch implements the implement-ceilometer blueprint.
It addes the necessary role/variables to deploy ceilometer
with a Mongodb backend. The Monogdb backend is assumed to
be up and configured and the playbooks only require a few
values to be set in user_variables to establish a connection.

Change-Id: I2164a1f27f632ce254cc2711ada2c449a9961fed
Implements: blueprint implement-ceilometer
2015-07-07 19:31:04 +00:00
Jenkins
2218e3fd98 Merge "Document some of the common scripts" 2015-07-06 17:31:22 +00:00
Nolan Brubaker
0a1df8400b Document some of the common scripts
This commit adds some documentation around the scripts that developers
will commonly encounter when working with os-a-d. It is intentionally
high level, so that only major modifications should require changing the
docs.

Change-Id: I6d8f72b418e041a956a3267bfee30d563bf35e34
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
Implements: blueprint developer-docs
2015-07-06 11:42:05 -05:00
Marc Gariepy
cc48c5256d Fix link to OSAD configuration files page.
Change-Id: I26fcb77b3c203519da8747d21b67e6f5a643929f
2015-07-02 13:21:29 -04:00
kevin
f9f907732e Port basic installation guide
Convert RPC installation guide from DocBook to RST,
remove content specific to Rackspace, and create initial
OSAD installation guide.

Change-Id: I3eedadc8ba441b4d931720dd6e3f7f3489302a9c
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
2015-06-11 09:17:56 -05:00
Nolan Brubaker
0ec7f7d850 Add an extension section to the developer docs.
This extension section provides guidance for deployers wanting to add
their own services and configuration to os-ansible-deployment.

This documentation also includes some recommendations for how projects
sourcing os-ansible-deployment might be structured.

Change-Id: I7ddac9ff2cab8b5a7cb9af1ba6bb3bdde64d60ea
Implements: blueprint developer-docs
2015-06-01 13:56:33 -04:00
Nolan Brubaker
9012a748d3 Add Sphinx machinery and initial docs.
This commit gets the doc directory and Sphinx configuration started.

Further documentation will depend on the Sphinx files and the index.rst
file at the very least.

The dev-requirements were updated to install Sphinx, and a gating script
was added to do the building for when we move to actually do gating on
the docs. The docs gate script is currently set to treat warning as
errors.

Change-Id: I977a2e53f1b0981cbc702ac53f2198d9f6a9da9d
Implements: blueprint developer-docs
2015-05-14 10:50:05 -04:00