openstack/openstack-ansible
Code Issues Proposed changes

[Docs] Add explicit warnings on common mistake

Browse Source 
This adds a warning to express, in many places, that the details
of the inventory shouldn't be deleted.

I hope it would be clearer and prevent user mistakes.

Change-Id: I9589f6efc9fa43a31382d4729dcaf4bfc53ba2ca
This commit is contained in:
Jean-Philippe Evrard 2018-02-23 10:13:15 +00:00 committed by Jesse Pretorius (odyssey4me)
parent 99f4f17751
commit 41bd98385b
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/reference/inventory/configure-inventory.rst
View File

@ -19,6 +19,16 @@ defaults defined in the ``inventory/env.d`` directory.
To understand how the dynamic inventory works, see
:ref:`inventory-in-depth`.
.. warning::
Never edit or delete the files
``/etc/openstack_deploy/openstack_inventory.json`` or
``/etc/openstack_deploy/openstack_hostnames_ips.yml``. This can
lead to file corruptions, and problems with the inventory: hosts
and container could disappear and new ones would appear,
breaking your existing deployment.
Configuration constraints
~~~~~~~~~~~~~~~~~~~~~~~~~

3
doc/source/reference/inventory/generate-inventory.rst
View File

@ -87,7 +87,8 @@ Once executed, the script will output an ``openstack_inventory.json`` file into
the directory specified with the ``--config`` argument. This is used as the
source of truth for repeated runs.
.. note::
.. warning::
The ``openstack_inventory.json`` file is the source of truth for the
environment. Deleting this in a production environment means that the UUID
portion of container names will be regenerated, which then results in new