Modifications pursuant to golden path tutorial

Now that the golden path tutorial has received
sufficient polish, this PR makes modifications to the
Deploy Guide accordingly.

* Point to the tutorial and remove the
  install-openstack-bundle page.

* Reword, refactor, and deal with a link.

Change-Id: I90fd395c1a31d3e59f480a8dd0bb8fcf58915e83
This commit is contained in:
Peter Matulis 2022-05-20 17:39:54 -04:00
parent 2fa962231e
commit 847fc07a35
5 changed files with 28 additions and 79 deletions

View File

@ -395,6 +395,20 @@ Next steps
You now have a functional OpenStack cloud managed by MAAS-backed Juju.
.. important::
Now that the cloud is deployed, the following management practices related
to charm versions and machine series are recommended:
* The entire suite of charms used to manage the cloud should be upgraded to
the latest stable charm revision before any major change is made to the
cloud (e.g. migrating to new charms, upgrading cloud services, upgrading
machine series). See :doc:`Charms upgrade <upgrade-charms>` for details.
* The Juju machines that comprise the cloud should all be running the same
series (e.g. 'focal' or 'jammy', but not a mix of the two). See
:doc:`Series upgrade <upgrade-series>` for details.
As next steps, consider browsing these documentation sources:
* `OpenStack Charm Guide`_: the primary source of information for OpenStack

View File

@ -1,47 +0,0 @@
:orphan:
===============================
Install OpenStack from a bundle
===============================
Charmed OpenStack is often deployed via a charm bundle. A bundle encompasses
multiple charms, their configuration options, and various optional elements
such as hardware and network constraints. See `Charm bundles`_ in the Juju
documentation.
.. tip::
The `Install OpenStack`_ page shows how to install by deploying,
configuring, and relating applications on an individual basis using Juju. It
is the recommended install method for getting a high level view of how
OpenStack is put together. It also provides an opportunity to gain
experience with Juju, which will in turn prepare you for post-deployment
management of the cloud.
To arrive at a truly customised deployment, while taking advantage of an
official base bundle, a secondary (overlay) bundle can be applied to override
and fine-tune certain elements of the original bundle.
The bundle recommended here is the stable release of `openstack-base`_. It is
used throughout Charmed OpenStack documentation as a reference bundle.
The bundle will probably need to be modified to accommodate for factors in the
local environment (e.g. hardware), or as mentioned, overridden with an overlay
bundle.
Deploy the bundle now. Follow the instructions provided in the stable
`openstack-base README`_.
Once deployed, go on to `Configure OpenStack`_.
Finally, once cloud functionality has been verified see the `OpenStack
Administrator Guides`_ for long-term guidance.
.. LINKS
.. _Install OpenStack: install-openstack
.. _Configure OpenStack: configure-openstack.html
.. _Charm bundles: https://juju.is/docs/sdk/bundles
.. _MAAS: https://maas.io
.. _openstack-base: https://github.com/openstack-charmers/openstack-bundles/tree/master/stable/openstack-base
.. _openstack-base README: https://github.com/openstack-charmers/openstack-bundles/blob/master/stable/openstack-base/README.md
.. _OpenStack Administrator Guides: http://docs.openstack.org/admin

View File

@ -4,38 +4,11 @@ Install OpenStack
In the :doc:`previous section <install-juju>`, we installed Juju and created a
Juju controller and model. We are now going to use Juju to install OpenStack
itself. There are two methods to choose from:
#. **By individual charm**. This method provides a solid understanding of how
Juju works and of how OpenStack is put together. Choose this option if you
have never installed OpenStack with Juju.
#. **By charm bundle**. This method provides an automated means to install
OpenStack. Choose this option if you are familiar with how OpenStack is
built with Juju.
The current page is devoted to method #1. See :doc:`Install OpenStack from a
bundle <install-openstack-bundle>` for method #2.
.. important::
Irrespective of install method, once the cloud is deployed, the following
management practices related to charm versions and machine series are
recommended:
#. The entire suite of charms used to manage the cloud should be upgraded to
the latest stable charm revision before any major change is made to the
cloud (e.g. migrating to new charms, upgrading cloud services, upgrading
machine series). See :doc:`Charms upgrade <upgrade-charms>` for details.
#. The Juju machines that comprise the cloud should all be running the same
series (e.g. 'focal' or 'jammy', but not a mix of the two). See
:doc:`Series upgrade <upgrade-series>` for details.
itself.
Despite the length of this page, only two distinct Juju commands will be
employed: :command:`juju deploy`, and :command:`juju add-relation`. You may
want to review these pertinent sections of the Juju documentation before
continuing:
employed: :command:`juju deploy` and :command:`juju add-relation`. You may want
to review these pertinent sections of the Juju documentation before continuing:
* `Deploying applications`_
* `Deploying to specific machines`_

View File

@ -9,6 +9,13 @@ 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
@ -25,3 +32,4 @@ installation journey. Hardware requirements are also listed there.
.. _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

View File

@ -122,8 +122,8 @@ To deploy OpenStack with Manila Ganesha:
juju deploy ./base.yaml --overlay ./manila-ganesha-overlay.yaml
Where `base.yaml` is a bundle to deploy OpenStack. See :doc:`Install OpenStack
from a bundle <install-openstack-bundle>`.
Where `base.yaml` is a bundle to deploy OpenStack. See the `Getting started
tutorial`_ for an introduction to bundle usage.
Configuration
-------------
@ -174,3 +174,4 @@ be attached to that provider network.
.. _deploying OpenStack: install-openstack
.. _create the share: https://docs.openstack.org/manila/latest/admin/cephfs_driver.html#create-cephfs-nfs-share
.. _grant access: https://docs.openstack.org/manila/latest/admin/cephfs_driver.html#allow-access-to-cephfs-nfs-share
.. _Getting started tutorial: https://docs.openstack.org/charm-guide/latest/getting-started/index.html