Update README for supported status
Change-Id: Ibf4231d93bdb45abfcff4df3dacbb085e154fc72
This commit is contained in:
Peter Matulis
parent
74be9b33e3
commit
c817cf7dfb
|
|
@ -1,26 +1,86 @@
|
|||
# Overview
|
||||
|
||||
Masakari is used to provide automated instance recovery for virtual machines
|
||||
(VMs) that use shared storage. It does this by performing live VM migrations to
|
||||
an existing compute node when failures arise.
|
||||
[Masakari][upstream-masakari] is used to provide automated recovery of
|
||||
KVM-based OpenStack machine instances for deployments that use shared storage
|
||||
(volumes).
|
||||
|
||||
Masakari responds to two different failures types:
|
||||
The masakari charm deploys the Masakari engine and the Masakari API. It is used
|
||||
in conjunction with the [masakari-monitors][masakari-monitors-charm] and
|
||||
[pacemaker-remote][pacemaker-remote-charm] charms. Together, these charms
|
||||
provide the following functionality:
|
||||
|
||||
1. individual VM
|
||||
1. compute node
|
||||
<!-- The next line has two trailing spaces. -->
|
||||
|
||||
When an entire compute node has failed all its VMs are "evacuated".
|
||||
1. **Evacuation of instances** (supported since OpenStack Stein)
|
||||
In the event of hypervisor failure, instances can be migrated to another
|
||||
hypervisor.
|
||||
|
||||
For more details see the [Automated Instance Recovery][cdg-app-masakari]
|
||||
appendix in the [OpenStack Charms Deployment Guide][charms-deploy-guide].
|
||||
<!-- The next line has two trailing spaces. -->
|
||||
|
||||
> **Important**: Both the `masakari` and `masakari-monitors` charms are
|
||||
considered preview charms. They will become supported charms once software
|
||||
issues [LP #1728527][lp-1728527] and [LP #1839715][lp-1839715] are resolved.
|
||||
1. **Restarting of instances** (supported since OpenStack Ussuri)
|
||||
A failed instance can be restarted.
|
||||
|
||||
For details see the [Automated Instance Recovery][cdg-app-masakari] appendix in
|
||||
the [OpenStack Charms Deployment Guide][cdg].
|
||||
|
||||
> **Note**: The restarting of services (e.g. nova-compute) is not supported by
|
||||
the charm as it is considered a `systemd` task.
|
||||
|
||||
# Usage
|
||||
|
||||
## Configuration
|
||||
|
||||
See file `config.yaml` for the full list of configuration options, along with
|
||||
their descriptions and default values.
|
||||
|
||||
## Deployment
|
||||
|
||||
To deploy a single masakari unit:
|
||||
|
||||
juju deploy masakari
|
||||
|
||||
## High availability
|
||||
|
||||
When more than one unit is deployed with the hacluster application the charm
|
||||
will bring up an HA active/active cluster.
|
||||
|
||||
To deploy a three-node cluster:
|
||||
|
||||
juju deploy -n 3 masakari
|
||||
|
||||
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 the [OpenStack high availability][cdg-app-ha-apps] appendix in the
|
||||
[OpenStack Charms Deployment Guide][cdg] for details.
|
||||
|
||||
## Actions
|
||||
|
||||
This section lists Juju [actions][juju-docs-actions] supported by the charm.
|
||||
Actions allow specific operations to be performed on a per-unit basis. To
|
||||
display action descriptions run `juju actions masakari`. If the charm is
|
||||
not deployed then see file `actions.yaml`.
|
||||
|
||||
* `openstack-upgrade`
|
||||
* `pause`
|
||||
* `restart-services`
|
||||
* `resume`
|
||||
|
||||
# Bugs
|
||||
|
||||
Please report bugs on [Launchpad][lp-bugs-charm-masakari].
|
||||
|
||||
For general charm questions refer to the [OpenStack Charm Guide][cg].
|
||||
|
||||
<!-- LINKS -->
|
||||
|
||||
[lp-1728527]: https://bugs.launchpad.net/masakari-monitors/+bug/1728527
|
||||
[lp-1839715]: https://bugs.launchpad.net/masakari/+bug/1839715
|
||||
[upstream-masakari]: https://docs.openstack.org/masakari
|
||||
[cg]: https://docs.openstack.org/charm-guide
|
||||
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/index.html
|
||||
[cdg-app-masakari]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-masakari.html
|
||||
[charms-deploy-guide]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/index.html
|
||||
[cdg-app-ha-apps]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#ha-applications
|
||||
[lp-bugs-charm-masakari]: https://bugs.launchpad.net/charm-masakari/+filebug
|
||||
[masakari-monitors-charm]: https://jaas.ai/masakari-monitors
|
||||
[pacemaker-remote-charm]: https://jaas.ai/pacemaker-remote
|
||||
[juju-docs-actions]: https://jaas.ai/docs/actions
|
||||
|
|
|
|||
Loading…
Reference in New Issue