From ce7b2102cff0d48264a944ced4ac823db6f0bb86 Mon Sep 17 00:00:00 2001 From: Ivan Anfimov Date: Fri, 11 Apr 2025 19:43:27 +0000 Subject: [PATCH] docs: minor fixes with OpenStack-Ansible naming Change-Id: Ib6e7c29cc729ab79a08ae5f428e891af58d05f3d --- doc/source/user/aio/quickstart.rst | 12 ++++++------ doc/source/user/ceph/full-deploy.rst | 10 +++++----- doc/source/user/multiarch/multiarch.rst | 10 +++++----- doc/source/user/prod/gnocchi_redis.rst | 2 +- doc/source/user/security/ssl-certificates.rst | 2 +- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/source/user/aio/quickstart.rst b/doc/source/user/aio/quickstart.rst index 51a480e44c..9db818e4fc 100644 --- a/doc/source/user/aio/quickstart.rst +++ b/doc/source/user/aio/quickstart.rst @@ -284,17 +284,17 @@ exist for OpenStack. Using a GUI ~~~~~~~~~~~ -The horizon web interface provides a graphical interface for interacting with -the AIO deployment. By default, the horizon API is available on port 443 of the +The Horizon web interface provides a graphical interface for interacting with +the AIO deployment. By default, the Horizon API is available on port 443 of the host (or port 80, if SSL certificate configuration was disabled). As such, to -interact with horizon, simply browse to the IP of the host. +interact with Horizon, simply browse to the IP of the host. .. note:: If the AIO was deployed in a cloud VM, you may need to configure security groups or firewall rules to allow access to the HTTP(S) ports. For example, if the AIO was deployed in an OpenStack VM, you can create and apply a - suitable security group for interacting with horizon like so: + suitable security group for interacting with Horizon like so: .. code-block:: shell-session @@ -370,8 +370,8 @@ files will be available on the host itself. If you wish to access the AIO deployment from another host - perhaps your local workstation - you will need either an ``openrc`` file or ``clouds.yaml`` file. -You can download an ``openrc`` file from horizon: simply click the User -dropdown in the top-right corner and select *⭳ OpenStack RC file*. +You can download an ``openrc`` file from Horizon: simply click the User +dropdown in the top-right corner and select ``OpenStack RC File``. .. important:: diff --git a/doc/source/user/ceph/full-deploy.rst b/doc/source/user/ceph/full-deploy.rst index 2a54b99327..d94caf4000 100644 --- a/doc/source/user/ceph/full-deploy.rst +++ b/doc/source/user/ceph/full-deploy.rst @@ -32,14 +32,14 @@ OpenStack-Ansible allows `Ceph storage `_ cluster integration in three ways: * connecting to your own pre-deployed ceph cluster by pointing to its - information in ``user_variables.yml`` and allowing openstack-ansible + information in ``user_variables.yml`` and allowing OpenStack-Ansible to ssh to the ceph monitors to retrieve the contents of ceph.conf and the keyrings. This method only requires a very small amount of configuration in ``user_variables.yml`` to point to the external ceph cluster monitors. The whole configuration for ceph-ansible would live outside the - openstack-ansible deployment and there is no duplication. + OpenStack-Ansible deployment and there is no duplication. The ``ceph_mons`` variable expects a list of IP addresses for the Ceph Monitor servers in the external ceph deployment: @@ -60,8 +60,8 @@ integration in three ways: monitors in ``user_variables.yml`` as above and providing data to populate ceph.conf and ceph keyring files on the deploy host. This is described `here `_. - No ssh access by openstack-ansible is required to the ceph cluster. -* deploying a ceph cluster as part of the openstack-ansible deployment + No ssh access by OpenStack-Ansible is required to the ceph cluster. +* deploying a ceph cluster as part of the OpenStack-Ansible deployment by using the roles maintained by the `Ceph-Ansible`_ project. Deployers can enable the ``ceph-install.yml`` playbook by adding hosts to the ``ceph-mon_hosts`` and ``ceph-osd_hosts`` groups in @@ -79,7 +79,7 @@ integration in three ways: .. warning:: - Deploying ceph cluster as part of openstack-ansible is not recommended since + Deploying ceph cluster as part of OpenStack-Ansible is not recommended since ceph-ansible upgrade path is not tested or supported. This option is mainly used for CI and AIO deployments to test and demonstrate a sample integration of the software stack. diff --git a/doc/source/user/multiarch/multiarch.rst b/doc/source/user/multiarch/multiarch.rst index 626d06e941..346a4bb0a8 100644 --- a/doc/source/user/multiarch/multiarch.rst +++ b/doc/source/user/multiarch/multiarch.rst @@ -3,7 +3,7 @@ Multi-Architecture Deployments ============================== OpenStack-Ansible supports deployments where either the control plane -or compute nodes may comprise of several different CPU architectures +or compute nodes may comprise of several different CPU architectures. Mixed CPU architectures for compute nodes ========================================= @@ -38,7 +38,7 @@ Example - adding ``aarch64`` nodes to an ``x86_64`` deployment 4) Run the OpenStack-Ansible playbooks to deploy the required services. -5) Add HW_ARCH_XXXX Trait to Every Compute Host in Openstack +5) Add HW_ARCH_XXXX Trait to Every Compute Host in OpenStack. Although most CPU hardware traits such as instruction set extensions are detected and handled automatically in OpenStack, CPU architecture is not. @@ -61,7 +61,7 @@ Example - adding ``aarch64`` nodes to an ``x86_64`` deployment The trait set command replaces all existing traits with the set provided, so you must specify all existing traits as well as the new trait. -6) Configure Nova Scheduler to Check Architecture +6) Configure Nova Scheduler to Check Architecture. Two additional settings in /etc/nova/nova.conf in all Nova API instances: @@ -106,7 +106,7 @@ Example - adding ``aarch64`` nodes to an ``x86_64`` deployment situation images without the ``hw_architecture`` property could be scheduled to a non native architecture host and emulated. -7) Disable QEMU Emulation +7) Disable QEMU Emulation. .. note:: @@ -124,7 +124,7 @@ Example - adding ``aarch64`` nodes to an ``x86_64`` deployment architecture `qemu-system-*`` binary so this step should not be required on newer releases. -8) Upload images to Glance +8) Upload images to Glance. * Ideally the ``hw_architecture`` property is set for all uploaded images. It is mandatory to set this property for all architectures that do not match diff --git a/doc/source/user/prod/gnocchi_redis.rst b/doc/source/user/prod/gnocchi_redis.rst index e227331f7c..43b5037b89 100644 --- a/doc/source/user/prod/gnocchi_redis.rst +++ b/doc/source/user/prod/gnocchi_redis.rst @@ -2,7 +2,7 @@ Telemetry with Gnocchi, Ceph and Redis example ============================================== -The default openstack-ansible installation configures gnocchi to use a file as +The default OpenStack-Ansible installation configures gnocchi to use a file as storage backend. When you already have a pre-installed ceph, you can use this as backend for gnocchi. This documentation will guide you how to set up gnocchi to use your ceph as storage backend. diff --git a/doc/source/user/security/ssl-certificates.rst b/doc/source/user/security/ssl-certificates.rst index d145906664..2df3fcf922 100644 --- a/doc/source/user/security/ssl-certificates.rst +++ b/doc/source/user/security/ssl-certificates.rst @@ -31,7 +31,7 @@ manage and install self-signed and user provided certificates. .. note:: - The openstack-ansible example configurations are designed to be minimal + The OpenStack-Ansible example configurations are designed to be minimal examples and in test or development use-cases will set ``external_lb_vip_address`` to the IP address of the HAProxy external endpoint. For a production deployment it is advised to set ``external_lb_vip_address`` to be