openstack/openstack-ansible
Code Issues Proposed changes

Documentation: Syntax checking before running playbooks

Browse Source 
This brings:
1) A new page to explain how can a deployer test its
configuration files.

2) Links on the pages mentionning the playbooks that
traditionally has errors because of the deployer's config.

Change-Id: I434152a14de806e24e5886969dfa15e3ff1c4928
This commit is contained in:
Jean-Philippe Evrard 2015-10-07 10:35:15 +02:00 committed by Jesse Pretorius
parent 949adfd2d5
commit 8edf7fe90c
4 changed files with 38 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/install-guide/configure-configurationintegrity.rst Normal file
View File

@ -0,0 +1,29 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
Checking the integrity of your configuration files
--------------------------------------------------
Here are a few steps to execute before running any playbook:
#. Make sure all the files edited in ``/etc/`` are ansible
YAML compliant. Guidelines can be found here:
`<http://docs.ansible.com/ansible/YAMLSyntax.html>`_
#. Check the integrity of your yaml files using a yaml linter.
.. note:: Here is an online linter: `<http://www.yamllint.com/>`_
#. Run your command with syntax-check, for example,
in the playbooks directory:
.. code-block:: bash
$ openstack-ansible setup-infrastructure.yml --syntax-check
#. Recheck that all indentation seems correct: the syntax of the
configuration files can be correct while not being meaningful
for openstack-ansible.
--------------
.. include:: navigation.txt

1
doc/source/install-guide/configure.rst
View File

@ -20,6 +20,7 @@ Chapter 5. Deployment configuration
configure-keystone.rst
configure-openstack.rst
configure-sslcertificates.rst
configure-configurationintegrity.rst
**Figure 5.1. Installation work flow**

5
doc/source/install-guide/install-foundation-run.rst
View File

@ -3,6 +3,10 @@
Running the foundation playbook
-------------------------------
.. seealso:: Before continuing, the configuration files may be validated using the guidance in "`Checking the integrity of your configuration files`_".
.. _Checking the integrity of your configuration files: ../install-guide/configure-configurationintegrity.html
#. Change to the ``/opt/openstack-ansible/playbooks`` directory.
#. Run the host setup playbook, which runs a series of sub-playbooks:
@ -10,7 +14,6 @@ Running the foundation playbook
.. code-block:: bash
$ openstack-ansible setup-hosts.yml
Confirm satisfactory completion with zero items unreachable or
failed:

5
doc/source/install-guide/install-infrastructure-run.rst
View File

@ -3,6 +3,10 @@
Running the infrastructure playbook
-----------------------------------
.. seealso:: Before continuing, the configuration files may be validated using the guidance in "`Checking the integrity of your configuration files`_".
.. _Checking the integrity of your configuration files: ../install-guide/configure-configurationintegrity.html
#. Change to the ``/opt/openstack-ansible/playbooks`` directory.
#. Run the infrastructure setup playbook, which runs a series of
@ -11,7 +15,6 @@ Running the infrastructure playbook
.. code-block:: bash
$ openstack-ansible setup-infrastructure.yml
Confirm satisfactory completion with zero items unreachable or
failed: