Skip to content

Commit 781fbf4

Browse files
committed
docs: Add warnings about password selection
Some services fail when using special characters in passwords, add some warnings to our docs. Closes-Bug: 1744985 Change-Id: I601149e2e7362507b38f01719f7197385a27e0a8
1 parent f0ad3e5 commit 781fbf4

3 files changed

Lines changed: 10 additions & 1 deletion

File tree

doc/source/configuration.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@ values that most often need to be set.
181181
If the ``*_PASSWORD`` variables are not set here you will be prompted to
182182
enter values for them by ``stack.sh``.
183183

184+
.. warning:: Only use alphanumeric characters in your passwords, as some
185+
services fail to work when using special characters.
186+
184187
The network ranges must not overlap with any networks in use on the
185188
host. Overlap is not uncommon as RFC-1918 'private' ranges are commonly
186189
used for both the local networking and Nova's fixed and floating ranges.

doc/source/guides/single-machine.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,9 @@ do the following:
106106
- Set the service password. This is used by the OpenStack services
107107
(Nova, Glance, etc) to authenticate with Keystone.
108108

109+
.. warning:: Only use alphanumeric characters in your passwords, as some
110+
services fail to work when using special characters.
111+
109112
``local.conf`` should look something like this:
110113

111114
.. code-block:: ini

doc/source/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,10 @@ devstack git repo.
101101
This is the minimum required config to get started with DevStack.
102102

103103
.. note:: There is a sample :download:`local.conf </assets/local.conf>` file
104-
under the *samples* directory in the devstack repository.
104+
under the *samples* directory in the devstack repository.
105+
106+
.. warning:: Only use alphanumeric characters in your passwords, as some
107+
services fail to work when using special characters.
105108

106109
Start the install
107110
-----------------

0 commit comments

Comments
 (0)