diff --git a/doc/install-guide/source/environment-networking.rst b/doc/install-guide/source/environment-networking.rst index 643fa363a1..fd82011925 100644 --- a/doc/install-guide/source/environment-networking.rst +++ b/doc/install-guide/source/environment-networking.rst @@ -10,7 +10,7 @@ Host networking recommend that you disable any automated network management tools and manually edit the appropriate configuration files for your distribution. For more information on how to configure networking on your - distribution, see the `documentation `__ . + distribution, see the `documentation `_. .. endonly @@ -21,7 +21,8 @@ Host networking recommend that you disable any automated network management tools and manually edit the appropriate configuration files for your distribution. For more information on how to configure networking on your - distribution, see the `documentation `__ . + distribution, see the `documentation + `__ . .. endonly @@ -32,7 +33,8 @@ Host networking recommend that you disable any automated network management tools and manually edit the appropriate configuration files for your distribution. For more information on how to configure networking on your - distribution, see the `documentation `__ . + distribution, see the `documentation + `__ . .. endonly @@ -43,19 +45,23 @@ Host networking recommend that you disable any automated network management tools and manually edit the appropriate configuration files for your distribution. For more information on how to configure networking on your - distribution, see the `SLES 12 `__ or `openSUSE `__ documentation. + distribution, see the `SLES 12 + `__ + or `openSUSE + `__ + documentation. .. endonly All nodes require Internet access for administrative purposes such as package installation, security updates, :term:`DNS `, and :term:`NTP `. In most cases, nodes should obtain -internet access through the management network interface. +Internet access through the management network interface. To highlight the importance of network separation, the example architectures use `private address space `__ for the management network and assume that the physical network infrastructure provides Internet access via :term:`NAT ` -or other method. The example architectures use routable IP address space for +or other methods. The example architectures use routable IP address space for the provider (external) network and assume that the physical network infrastructure provides direct Internet access. @@ -89,14 +95,14 @@ You can modify these ranges and gateways to work with your particular network infrastructure. Network interface names vary by distribution. Traditionally, -interfaces use "eth" followed by a sequential number. To cover all -variations, this guide simply refers to the first interface as the +interfaces use ``eth`` followed by a sequential number. To cover all +variations, this guide refers to the first interface as the interface with the lowest number and the second interface as the interface with the highest number. Unless you intend to use the exact configuration provided in this example architecture, you must modify the networks in this procedure to -match your environment. Also, each node must resolve the other nodes by +match your environment. Each node must resolve the other nodes by name in addition to IP address. For example, the ``controller`` name must resolve to ``10.0.0.11``, the IP address of the management interface on the controller node. diff --git a/doc/install-guide/source/environment-ntp-verify.rst b/doc/install-guide/source/environment-ntp-verify.rst index b14d26c131..67b7db3a84 100644 --- a/doc/install-guide/source/environment-ntp-verify.rst +++ b/doc/install-guide/source/environment-ntp-verify.rst @@ -22,7 +22,7 @@ node, can take several minutes to synchronize. .. end Contents in the *Name/IP address* column should indicate the hostname or IP - address of one or more NTP servers. Contents in the *S* column should indicate + address of one or more NTP servers. Contents in the *MS* column should indicate *\** for the server to which the NTP service is currently synchronized. #. Run the same command on *all other* nodes: diff --git a/doc/install-guide/source/environment-security.rst b/doc/install-guide/source/environment-security.rst index 843c203f40..2f70b91d2a 100644 --- a/doc/install-guide/source/environment-security.rst +++ b/doc/install-guide/source/environment-security.rst @@ -3,12 +3,12 @@ Security OpenStack services support various security methods including password, policy, and encryption. Additionally, supporting services including the -database server and message broker support at least password security. +database server and message broker support password security. To ease the installation process, this guide only covers password security where applicable. You can create secure passwords manually, generate them using a tool such as -`pwgen `__, or by running the +`pwgen `_, or by running the following command: .. code-block:: console @@ -22,7 +22,7 @@ service account passwords and ``SERVICE_DBPASS`` to reference database passwords. The following table provides a list of services that require passwords -and their associated references in the guide: +and their associated references in the guide. .. list-table:: **Passwords** :widths: 50 60 @@ -39,7 +39,7 @@ and their associated references in the guide: * - ``CINDER_PASS`` - Password of Block Storage service user ``cinder`` * - ``DASH_DBPASS`` - - Database password for the dashboard + - Database password for the Dashboard * - ``DEMO_PASS`` - Password of user ``demo`` * - ``GLANCE_DBPASS`` @@ -68,7 +68,7 @@ policies. See the `OpenStack Administrator Guide `__ for more information. -Also, the Networking service assumes default values for kernel network +The Networking service assumes default values for kernel network parameters and modifies firewall rules. To avoid most issues during your initial installation, we recommend using a stock deployment of a supported distribution on your hosts. However, if you choose to automate deployment diff --git a/doc/install-guide/source/environment-sql-database.rst b/doc/install-guide/source/environment-sql-database.rst index b30e0fec30..aa35b6fd13 100644 --- a/doc/install-guide/source/environment-sql-database.rst +++ b/doc/install-guide/source/environment-sql-database.rst @@ -190,7 +190,7 @@ Finalize installation 2. Secure the database service by running the ``mysql_secure_installation`` script. In particular, choose a suitable password for the database - ``root`` account. + ``root`` account: .. code-block:: console diff --git a/doc/install-guide/source/shared/edit_hosts_file.txt b/doc/install-guide/source/shared/edit_hosts_file.txt index 86ae2ba936..e6cdbdf80d 100644 --- a/doc/install-guide/source/shared/edit_hosts_file.txt +++ b/doc/install-guide/source/shared/edit_hosts_file.txt @@ -25,10 +25,10 @@ Edit the ``/etc/hosts`` file to contain the following: Some distributions add an extraneous entry in the ``/etc/hosts`` file that resolves the actual hostname to another loopback IP address such as ``127.0.1.1``. You must comment out or remove this - entry to prevent name resolution problems. **Do not remove the - 127.0.0.1 entry.** + entry to prevent name resolution problems. + **Do not remove the 127.0.0.1 entry.** .. note:: - To reduce complexity of this guide, we add host entries for optional - services regardless of whether you choose to deploy them. + This guide includes host entries for optional services in order to reduce + complexity should you choose to deploy them.