Review README
* Improve Overview and Deployment sections. * Apply README template. * Add section on upgrading to Train, linking to CDG. Change-Id: I0ad22e07d8837e7e73bb02cda4f879888004daca
This commit is contained in:
Peter Matulis
parent
758c228f33
commit
647e1b0fdc
110
src/README.md
110
src/README.md
|
|
@ -1,43 +1,95 @@
|
|||
# Overview
|
||||
|
||||
This charm provides the Placement service for an OpenStack Cloud.
|
||||
The placement charm deploys [Placement][upstream-placement], the core OpenStack
|
||||
API service that tracks the inventory and usage of various cloud resources
|
||||
(e.g. compute, storage, network addresses). The charm works alongside other
|
||||
Juju-deployed OpenStack services.
|
||||
|
||||
OpenStack Train or later is required.
|
||||
> **Note**: The placement charm is supported starting with OpenStack Train.
|
||||
|
||||
# Usage
|
||||
|
||||
As of Train, the placement API is managed by this charm and is no longer managed
|
||||
by the nova-cloud-controller charm.
|
||||
## Configuration
|
||||
|
||||
Placement relies on mysql, keystone, and nova-cloud-controller charms:
|
||||
This section covers common and/or important configuration options. See file
|
||||
`config.yaml` for the full list of options, along with their descriptions and
|
||||
default values. See the [Juju documentation][juju-docs-config-apps] for details
|
||||
on configuring applications.
|
||||
|
||||
juju deploy --series bionic --config openstack-origin=cloud:bionic-train cs:placement
|
||||
juju add-relation placement mysql
|
||||
juju add-relation placement keystone
|
||||
juju add-relation placement nova-cloud-controller
|
||||
#### `openstack-origin`
|
||||
|
||||
If upgrading nova-cloud-controller to Train, the upgrade requires some coordination to
|
||||
transition to the new API endpoints. Prior to upgrading nova-cloud-controller to Train,
|
||||
the placement charm must be deployed for Train and related to the Stein-based
|
||||
nova-cloud-controller. It is important that nova-cloud-controller is paused while the
|
||||
API transition occurs (pause prior to adding relations for the placement charm) as the
|
||||
placement charm will migrate existing placement tables from the nova_api database to a
|
||||
new placement database. Once the new placement endpoints are registered,
|
||||
nova-cloud-controller can be resumed. After all of the steps have completed,
|
||||
nova-cloud-controller can then be upgraded to Train. Here's an example of the steps
|
||||
that were just described:
|
||||
The `openstack-origin` option states the software sources. A common value is an
|
||||
OpenStack UCA release (e.g. 'cloud:bionic-ussuri' or 'cloud:focal-victoria').
|
||||
See [Ubuntu Cloud Archive][wiki-uca]. The underlying host's existing apt
|
||||
sources will be used if this option is not specified (this behaviour can be
|
||||
explicitly chosen by using the value of 'distro').
|
||||
|
||||
juju deploy --series bionic --config openstack-origin=cloud:bionic-train cs:placement
|
||||
juju run-action nova-cloud-controller/0 pause
|
||||
juju add-relation placement mysql
|
||||
juju add-relation placement keystone
|
||||
juju add-relation placement nova-cloud-controller
|
||||
openstack endpoint list # ensure placement endpoints are listening on new placment IP address
|
||||
juju run-action nova-cloud-controller/0 resume
|
||||
juju config nova-cloud-controller openstack-origin=cloud:bionic-train
|
||||
## Deployment
|
||||
|
||||
Placement is often containerised. Here a single unit is deployed to a new
|
||||
container on machine '1':
|
||||
|
||||
juju deploy --to lxd:1 placement
|
||||
|
||||
Placement requires these applications to be present: keystone,
|
||||
nova-cloud-controller, and a cloud database.
|
||||
|
||||
The database application is determined by the series. Prior to focal
|
||||
[percona-cluster][percona-cluster-charm] is used, otherwise it is
|
||||
[mysql-innodb-cluster][mysql-innodb-cluster-charm]. In the example deployment
|
||||
below mysql-innodb-cluster has been chosen.
|
||||
|
||||
juju deploy mysql-router placement-mysql-router
|
||||
juju add-relation placement-mysql-router:db-router mysql-innodb-cluster:db-router
|
||||
juju add-relation placement-mysql-router:shared-db placement:shared-db
|
||||
|
||||
Add relations to the remaining applications:
|
||||
|
||||
juju add-relation placement:identity-service keystone:identity-service
|
||||
juju add-relation placement:placement nova-cloud-controller:placement
|
||||
|
||||
## Upgrading to OpenStack Train
|
||||
|
||||
Prior to OpenStack Train, the placement API was managed by the
|
||||
nova-cloud-controller charm. Some extra steps are therefore needed when
|
||||
performing a Stein to Train upgrade. The documented procedure can be found on
|
||||
the [Special charm procedures][cdg-upgrade-special] page in the [OpenStack
|
||||
Charms Deployment Guide][cdg].
|
||||
|
||||
## High availability
|
||||
|
||||
When more than one unit is deployed with the [hacluster][hacluster-charm]
|
||||
application the charm will bring up an HA active/active cluster.
|
||||
|
||||
There are two mutually exclusive high availability options: using virtual IP(s)
|
||||
or DNS. In both cases the hacluster subordinate charm is used to provide the
|
||||
Corosync and Pacemaker backend HA functionality.
|
||||
|
||||
See [Infrastructure high availability][cdg-ha-apps] in the [OpenStack Charms
|
||||
Deployment Guide][cdg] for details.
|
||||
|
||||
# Documentation
|
||||
|
||||
The OpenStack Charms project maintains two documentation guides:
|
||||
|
||||
* [OpenStack Charm Guide][cg]: for project information, including development
|
||||
and support notes
|
||||
* [OpenStack Charms Deployment Guide][cdg]: for charm usage information
|
||||
|
||||
# Bugs
|
||||
|
||||
Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-placement/+filebug).
|
||||
Please report bugs on [Launchpad][lp-bugs-charm-placement].
|
||||
|
||||
For general questions please refer to the OpenStack [Charm Guide](https://docs.openstack.org/charm-guide/latest/).
|
||||
<!-- LINKS -->
|
||||
|
||||
[cg]: https://docs.openstack.org/charm-guide
|
||||
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide
|
||||
[lp-bugs-charm-placement]: https://bugs.launchpad.net/charm-placement/+filebug
|
||||
[upstream-placement]: https://docs.openstack.org/placement
|
||||
[cdg-upgrade-special]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/upgrade-special.html
|
||||
[cdg-ha-apps]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#ha-applications
|
||||
[hacluster-charm]: https://jaas.ai/hacluster
|
||||
[wiki-uca]: https://wiki.ubuntu.com/OpenStack/CloudArchive
|
||||
[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
|
||||
[percona-cluster-charm]: https://jaas.ai/percona-cluster
|
||||
[mysql-innodb-cluster-charm]: https://jaas.ai/mysql-innodb-cluster
|
||||
|
|
|
|||
Loading…
Reference in New Issue