openstack/openstack-ansible
Code Issues Proposed changes

Merge "[Docs] Add explicit warnings on common mistake"

Browse Source
This commit is contained in:
Zuul
2018-02-24 17:31:13 +00:00
committed by Gerrit Code Review
parent c8f559e300 41bd98385b
commit 4df082315f
2 changed files with 12 additions and 1 deletions
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 To understand how the dynamic inventory works, see
:ref:`inventory-in-depth`. :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 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 the directory specified with the ``--config`` argument. This is used as the
source of truth for repeated runs. source of truth for repeated runs.
.. note:: .. warning::
The ``openstack_inventory.json`` file is the source of truth for the The ``openstack_inventory.json`` file is the source of truth for the
environment. Deleting this in a production environment means that the UUID environment. Deleting this in a production environment means that the UUID
portion of container names will be regenerated, which then results in new portion of container names will be regenerated, which then results in new