Review post-migration of pages

The migration of non-deployment content to the charm-guide
is now complete. This PR is a consequence of that change. It
introduces some rewording and restructuring. In particular,
the installation-overview page is folded into the main
landing page. This PR closes a bug in the process.

Closes-Bug: #1976369
Change-Id: I5e31bd0e340662b52607bc72a089bd7c08190741
This commit is contained in:
Peter Matulis 2022-08-16 13:13:18 -04:00
parent f6da73921e
commit 25bb3b2ffe
4 changed files with 46 additions and 56 deletions

View File

@ -2,20 +2,50 @@
OpenStack Charms Deployment Guide
=================================
The OpenStack Charms Deployment Guide is the main source of information for
OpenStack Charms usage. To help improve it you can `file an issue`_ or
`submit a contribution`_.
The OpenStack Charms Deployment Guide demonstrates how to build an OpenStack
cloud by making use of the tools provided by the OpenStack Charms project. Its
aim is to impart a solid understanding of how the cloud is constructed by
deploying and configuring each charm manually.
.. note::
For project information, development guidelines, release notes, and release
schedules, please refer to the `OpenStack Charm Guide`_.
For all other information concerning the OpenStack Charms project please
refer to the :doc:`cg:index`.
The Charm Guide also documents an automated cloud deployment method that
uses a Juju bundle (see the :doc:`cg:getting-started/index` tutorial).
This guide can be :ref:`searched here <search>`. To help improve it you can
`file an issue`_ or `submit a contribution`_.
Software
--------
The software versions used in this guide are as follows:
* **Ubuntu 20.04 LTS (Focal)** for the MAAS server, Juju client, and Juju
controller
* **Ubuntu 22.04 LTS (Jammy)** for all cloud nodes (including containers)
* **MAAS 3.1.0**
* **Juju 2.9.29**
* **OpenStack Yoga**
Cloud description
-----------------
For easy adoption the cloud will be minimal. Nevertheless, it will be capable
of both performing some real work and scaling to fit more ambitious projects.
High availability will not be implemented beyond natively HA applications
(Ceph, MySQL, OVN, and RabbitMQ).
Procedure
---------
The procedure consists of the following steps:
.. toctree::
:caption: Installation
:maxdepth: 1
Overview <install-overview>
install-maas
install-juju
install-openstack
@ -24,4 +54,3 @@ OpenStack Charms usage. To help improve it you can `file an issue`_ or
.. LINKS
.. _file an issue: https://bugs.launchpad.net/charm-deployment-guide/+filebug
.. _submit a contribution: https://opendev.org/openstack/charm-deployment-guide
.. _OpenStack Charm Guide: https://docs.openstack.org/charm-guide

View File

@ -2,9 +2,8 @@
Install MAAS
============
In the :doc:`previous section <install-overview>`, we gave a summary of the
OpenStack cloud we'll be building and described the approach we'll take for
doing that.
In the :doc:`previous section <index>`, we gave a summary of the OpenStack
cloud we'll be building and described the approach we'll take for doing that.
This page will cover the installation of `MAAS`_ as well as point out what is
required out of MAAS in terms of post-installation tasks. The goal is to

View File

@ -24,17 +24,14 @@ OpenStack release
-----------------
.. TEMPLATE (alternate between the following two paragraphs each six months)
As the :doc:`Overview <install-overview>` of the Installation section
states, OpenStack Xena will be deployed atop Ubuntu 20.04 LTS (Focal) cloud
nodes. In order to achieve this a cloud archive release of
'cloud:focal-xena' will be used during the install of each OpenStack
application. Note that some applications are not part of the OpenStack
project per se and therefore do not apply (exceptionally, Ceph applications
do use this method). Not using a more recent OpenStack release in this way
will result in an Ussuri deployment (i.e. Ussuri is in the Ubuntu package
archive for Focal).
OpenStack Xena will be deployed atop Ubuntu 20.04 LTS (Focal) cloud nodes.
In order to achieve this a cloud archive release of 'cloud:focal-xena' will
be used during the install of each OpenStack application. Note that some
applications are not part of the OpenStack project per se and therefore do
not apply (exceptionally, Ceph applications do use this method). Not using a
more recent OpenStack release in this way will result in an Ussuri
deployment (i.e. Ussuri is in the Ubuntu package archive for Focal).
As the :doc:`Overview <install-overview>` of the Installation section states,
OpenStack Yoga will be deployed atop Ubuntu 22.04 LTS (Jammy) cloud nodes. In
order to achieve this the default package archive ("distro") for the cloud
nodes will be used during the install of each OpenStack application. Note that

View File

@ -1,35 +0,0 @@
=====================
Installation overview
=====================
The purpose of the Installation section is to demonstrate how to build a
multi-node OpenStack cloud with `MAAS`_, `Juju`_, and `OpenStack Charms`_. For
easy adoption the cloud will be minimal. Nevertheless, it will be capable of
both performing some real work and scaling to fit more ambitious projects. High
availability will not be implemented beyond natively HA applications (Ceph,
MySQL, OVN, Swift, and RabbitMQ).
.. note::
The cloud will be deployed charm-by-charm. This method will provide a solid
understanding of how Charmed OpenStack is put together. For a streamlined
path towards a working cloud, consider the `Getting started tutorial`_ found
in the Charm Guide.
The software versions used in this guide are as follows:
* **Ubuntu 20.04 LTS (Focal)** for the MAAS server, Juju client, and Juju
controller
* **Ubuntu 22.04 LTS (Jammy)** for all cloud nodes (including containers)
* **MAAS 3.1.0**
* **Juju 2.9.29**
* **OpenStack Yoga**
Proceed to the :doc:`Install MAAS <install-maas>` page to begin your
installation journey. Hardware requirements are also listed there.
.. LINKS
.. _MAAS: https://maas.io
.. _Juju: https://juju.is
.. _OpenStack Charms: https://docs.openstack.org/charm-guide
.. _Getting started tutorial: https://docs.openstack.org/charm-guide/latest/getting-started/index.html