From b94f2b5de51b58ee6f63c3b4c02b7049c62226c8 Mon Sep 17 00:00:00 2001 From: Ivan Anfimov Date: Fri, 21 Feb 2025 14:45:05 +0000 Subject: [PATCH] Remove Salt and fix few small errors. Change-Id: I329d7b5a308936ac1edc30177b89a9f80cead567 --- doc/source/ops-lay-of-the-land.rst | 4 ++-- doc/source/ops-maintenance-configuration.rst | 16 +++++--------- doc/source/ops-planning.rst | 23 ++++++++++---------- doc/source/preface.rst | 16 +++++++------- tox.ini | 8 +++++++ 5 files changed, 34 insertions(+), 33 deletions(-) diff --git a/doc/source/ops-lay-of-the-land.rst b/doc/source/ops-lay-of-the-land.rst index d1acebf9..e629f8d5 100644 --- a/doc/source/ops-lay-of-the-land.rst +++ b/doc/source/ops-lay-of-the-land.rst @@ -578,8 +578,8 @@ For example: | user_id | 7aaa9b5573ce441b98dae857a82ecc68 | +--------------------------------------+----------------------------------------------------------+ -This output shows that an instance named ``devstack`` was created from -an Ubuntu 12.04 image using a flavor of ``m1.small`` and is hosted on +This output shows that an instance named ``instance-00000001`` was created from +an ``cirros`` image using a flavor of ``m1.small`` and is hosted on the compute node ``c02.example.com``. Summary diff --git a/doc/source/ops-maintenance-configuration.rst b/doc/source/ops-maintenance-configuration.rst index 6b589512..d5ee274c 100644 --- a/doc/source/ops-maintenance-configuration.rst +++ b/doc/source/ops-maintenance-configuration.rst @@ -16,14 +16,8 @@ configuration options) in a version-controlled repository. not recommend a specific one. The most popular ones in the OpenStack community are: - * `Puppet `_, with available `OpenStack - Puppet modules `_ - * `Ansible `_, with `OpenStack Ansible - `_ - * `Chef `_, with available `OpenStack Chef - recipes `_ - - Other newer configuration tools include `Juju `_ - and `Salt `_; and more mature configuration - management tools include `CFEngine `_ and `Bcfg2 - `_. + * `Kolla Ansible `_ + * `Puppet `_, with available `Puppet OpenStack + `_ + * `Ansible `_, with `OpenStack-Ansible + `_ diff --git a/doc/source/ops-planning.rst b/doc/source/ops-planning.rst index fd85add9..21e2483d 100644 --- a/doc/source/ops-planning.rst +++ b/doc/source/ops-planning.rst @@ -18,8 +18,9 @@ chance for operator error. This infrastructure includes systems to automatically install the operating system's initial configuration and later coordinate the configuration of all services automatically and centrally, which reduces -both manual effort and the chance for error. Examples include Ansible, -CFEngine, Kolla Ansible, Puppet and Salt. You can even use OpenStack to deploy +both manual effort and the chance for error. +Examples include OpenStack-Ansible, Kolla Ansible and Puppet. +You can even use OpenStack to deploy OpenStack, named TripleO (OpenStack On OpenStack). Automated deployment @@ -121,7 +122,7 @@ Option 3 You may find that you can automate the partitioning itself. For example, MIT uses `Fully Automatic Installation - (FAI) `_ to do the initial PXE-based + (FAI) `_ to do the initial PXE-based partition and then install using a combination of min/max and percentage-based partitioning. @@ -178,15 +179,13 @@ and configuration change propagation. These tools also make it possible to test and roll back changes, as they are fully repeatable. Conveniently, a large body of work has been done -by the OpenStack community in this space. Puppet, a configuration -management tool, even provides official modules for OpenStack projects -in an OpenStack infrastructure system known as `Puppet -OpenStack `_. Chef -configuration management is provided within -`OpenStack Chef Repo -`_. Additional -configuration management systems include Juju, Ansible, and Salt. Also, -PackStack is a command-line utility for Red Hat Enterprise Linux and +by the OpenStack community in this space. Puppet or Ansible, a configuration +management tools, even provides official modules for OpenStack projects +in an OpenStack infrastructure system known as +`Puppet OpenStack `_, +`OpenStack-Ansible `_ +and `Kolla Ansible `_. +Also, PackStack is a command-line utility for Red Hat Enterprise Linux and derivatives that uses Puppet modules to support rapid deployment of OpenStack on existing servers over an SSH connection. diff --git a/doc/source/preface.rst b/doc/source/preface.rst index bb7d7baf..d27d4926 100644 --- a/doc/source/preface.rst +++ b/doc/source/preface.rst @@ -76,7 +76,7 @@ experience, such as Mirantis or Metacloud. If your preference is to build your own OpenStack expertise internally, a good way to kick-start that might be to attend or arrange a training -session. The OpenStack Foundation has a `Training +session. The OpenInfra Foundation has a `Training Marketplace `_ where you can look for nearby events. Also, the OpenStack community is `working to produce `_ open source @@ -139,15 +139,15 @@ Installation Tutorials and Guides automation, for multiple distributions based on a packaging system: - `OpenStack Installation Tutorial for openSUSE and SUSE Linux Enterprise - `_ + `_ - `OpenStack Installation Tutorial for Red Hat Enterprise Linux and CentOS - `_ + `_ - `OpenStack Installation Tutorial for Ubuntu - `_ + `_ -`OpenStack Configuration Reference `_ +`OpenStack Configuration Reference `_ Contains a reference listing of all configuration options for core and integrated OpenStack services by release version @@ -176,7 +176,7 @@ Installation Tutorials and Guides OpenStack cloud with the OpenStack dashboard and OpenStack client commands -`OpenStack Networking Guide `_ +`OpenStack Networking Guide `_ This guide targets OpenStack administrators seeking to deploy and manage OpenStack Networking (neutron). @@ -402,7 +402,7 @@ Documentation Contributor Guide `_. If you find a bug and can't fix it or aren't sure it's really a doc bug, -log a bug in ` -Storyboard `_. You can assign the bug to yourself if you know how to +log a bug in `Storyboard `__. +You can assign the bug to yourself if you know how to fix it. Also, a member of the OpenStack operations-doc team can triage the doc bug. diff --git a/tox.ini b/tox.ini index 070cdc41..5381c839 100644 --- a/tox.ini +++ b/tox.ini @@ -19,3 +19,11 @@ deps = commands = doc8 doc/source -e txt -e rst docstheme-build-translated.sh + +[testenv:pdf-docs] +deps = {[testenv:docs]deps} +allowlist_externals = + make +commands = + sphinx-build -j auto -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf