openstack/openstack-ansible
Code Issues Proposed changes

docs: fix small mistakes in deploy-guide documentation

Browse Source 
Change-Id: I0f5f1e9b9a9dd2827b201cb28f76b0a498ee8dd9
This commit is contained in:
Ivan Anfimov
2025-06-29 16:12:25 +00:00
parent 9da8dc9d5d
commit 79550205ce
6 changed files with 18 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
deploy-guide/source/deploymenthost.rst
View File

@@ -62,8 +62,8 @@ Before you begin, we recommend upgrading your system packages and kernel.
#. Configure NTP to synchronize with a suitable time source.
Configure CentOS / Rocky
~~~~~~~~~~~~~~~~~~~~~~~~
Configure CentOS Stream / Rocky Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install additional software packages and configure Network Time Protocol (NTP).
Before you begin, we recommend upgrading your system packages and kernel.
@@ -91,24 +91,16 @@ Before you begin, we recommend upgrading your system packages and kernel.
# systemctl enable chronyd
# systemctl start chronyd
#. The ``firewalld`` service is enabled on most CentOS systems by default and
its default ruleset prevents OpenStack components from communicating
properly. Stop the ``firewalld`` service and mask it to prevent it from
starting:
#. The ``firewalld`` service is enabled on CentOS Stream and Rocky Linux by
default and its default ruleset prevents OpenStack components from
communicating properly. Stop the ``firewalld`` service and mask it to
prevent it from starting:
.. code-block:: shell-session
# systemctl stop firewalld
# systemctl mask firewalld
.. note::
There is `future work planned <https://bugs.launchpad.net/openstack-ansible/+bug/1657518>`_
to create proper firewall rules for OpenStack services in OpenStack-Ansible
deployments. Until that work is complete, deployers must maintain their
own firewall rulesets or disable the firewall entirely.
Configure SSH keys
==================

13
deploy-guide/source/overview-requirements.rst
View File

@@ -54,7 +54,7 @@ running on each host and the amount of disk space allocated to each instance.
.. tip ::
Consider disks that provide higher I/O throughput with lower latency,
such as SSD drives in a RAID array.
such as SSD or NVMe drives in a RAID array.
Storage hosts
-------------
@@ -92,7 +92,6 @@ container running on the host.
Other technologies leveraging copy-on-write can be used to reduce
the disk space requirements on machine containers.
Network recommendations
~~~~~~~~~~~~~~~~~~~~~~~
@@ -107,13 +106,13 @@ environment, consider a network configuration that contains
the following features:
* Bonded network interfaces, which increase performance, reliability, or both
(depending on the bonding architecture)
(depending on the bonding architecture).
* VLAN offloading, which increases performance by adding and removing VLAN tags
in hardware, rather than in the server's main CPU
in hardware, rather than in the server's main CPU.
* Gigabit or 10 Gigabit Ethernet, which supports higher network speeds and can
also improve storage performance when using the Block Storage service
* A high-speed Ethernet network can enhance storage performance when using
the Block Storage service.
* Jumbo frames, which increase network performance by allowing more data to
be sent in each packet
be sent in each packet.

2
deploy-guide/source/overview.rst
View File

@@ -6,7 +6,7 @@ Overview
For essential background reading to help understand the service and storage
architecture, please read the
:dev_docs:`OpenStack-Ansible Architecture section of its reference guide <reference/architecture/index.html>`
:dev_docs:`OpenStack-Ansible Architecture section of its reference guide <reference/architecture/index.html>`.
If you'd like to understand when OpenStack-Ansible would be a good fit for your
organisation, please read :dev_docs:`About OpenStack-Ansible <reference/aboutosa.html>`.

2
deploy-guide/source/targethosts-networkconfig.rst
View File

@@ -59,7 +59,7 @@ Host network bridges information
The container network interface that the bridge attaches to is configurable
in the ``openstack_user_config.yml`` file.
* Storage:``br-storage``
* Storage: ``br-storage``
The ``br-storage`` bridge provides segregated access to Block Storage
devices between OpenStack services and Block Storage devices.

11
deploy-guide/source/targethosts-prepare.rst
View File

@@ -14,7 +14,6 @@ target host:
.. raw:: HTML
:file: supported-platforms.html
Configure at least one network interface to access the Internet or
suitable local repositories.
@@ -32,7 +31,6 @@ installation on target hosts that do not have local (console) access.
We also recommend setting your locale to `en_US.UTF-8`. Other locales might
work, but they are not tested or supported.
Configure Debian
~~~~~~~~~~~~~~~~
@@ -57,7 +55,6 @@ Configure Debian
#. Reboot the host to activate the changes and use the new kernel.
Configure Ubuntu
~~~~~~~~~~~~~~~~
@@ -88,9 +85,8 @@ Configure Ubuntu
#. Reboot the host to activate the changes and use the new kernel.
Configure CentOS / Rocky
~~~~~~~~~~~~~~~~~~~~~~~~
Configure CentOS Stream / Rocky Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Upgrade the system packages and kernel:
@@ -127,7 +123,6 @@ Configure CentOS / Rocky
# dnf install iputils lsof openssh-server\
sudo tcpdump python3
#. (Optional) Reduce the kernel log level by changing the printk
value in your sysctls:
@@ -135,10 +130,8 @@ Configure CentOS / Rocky
# echo "kernel.printk='4 1 7 4'" >> /etc/sysctl.conf
#. Reboot the host to activate the changes and use the new kernel.
Configure SSH keys
==================

4
deploy-guide/source/verify-operation.rst
View File

@@ -29,7 +29,7 @@ configuration and testing.
# lxc-attach -n infra1_utility_container-161a4084
#. Source the ``admin`` tenant credentials:
#. Source the ``admin`` project credentials:
.. code::
@@ -59,7 +59,7 @@ configuration and testing.
| e59e4379730b41209f036bbeac51b181 | keystone |
+----------------------------------+--------------------+
Verifying the Dashboard (horizon)
Verifying the Dashboard (Horizon)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. With a web browser, access the Dashboard by using the external load