Jump to: navigation, search

Difference between revisions of "Masakari"

(Architecture)
(Getting in Touch)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Virtual Machine High Availability (VMHA) as a service (Masakari) =
+
= Masakari: Instances High Availability Service=
  
 
== Mission ==
 
== Mission ==
Masakari provides Virtual Machine High Availability (VMHA) service for OpenStack clouds by automatically recover the KVM-based Virtual Machine(VM)s from failure events such as VM process down, provisioning process down, and nova-compute host failure. Also provides API service for manage and control the automated rescue mechanism.
+
Masakari provides Instances High Availability Service for OpenStack clouds by automatically recovering failed Instances. Currently, Masakari can recover KVM-based Virtual Machine(VM)s from failure events such as VM process down, provisioning process down, and nova-compute host failure. Masakari also provides an API service to manage and control the automated rescue mechanism.
 +
 
 +
== Getting in Touch ==
 +
 
 +
We use the [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss openstack-discuss@lists.openstack.org] mailing list for discussions using subjects with the prefix "[masakari]".
 +
 
 +
We also hang out on IRC in #openstack-masakari on OFTC.
 +
 
 +
== Governance ==
 +
 
 +
For basic information on Masakari's governance, including the current PTL (Project Team Lead), please visit [https://governance.openstack.org/tc/reference/projects/masakari.html Masakari's governance page].
 +
 
 +
To see the current list of Masakari core reviewers (aka cores), see the [https://review.opendev.org/#/admin/groups/1448,members masakari-core group on Gerrit].
 +
 
 
== Project Meetings ==
 
== Project Meetings ==
 
See [[Meetings/Masakari]].
 
See [[Meetings/Masakari]].
== Getting in Touch ==
 
We use the [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev@lists.openstack.org] mailing list for discussions using subjects with the prefix "[masakari]". We also hang out on IRC in #openstack-masakari on freenode.
 
== Requirements for High Availability for Virtual Machines==
 
[http://specs.openstack.org/openstack/openstack-user-stories/user-stories/proposed/ha_vm.html User Story; High Availability for Virtual Machines]
 
  
== Code and Bug/Feature trackers ==
+
== Whiteboard ==
 +
https://etherpad.opendev.org/p/masakari-whiteboard
 +
 
 +
== Deliverables ==
 +
 
 +
Note project features are tracked via blueprints and specs on the main deliverable (masakari).
 +
 
 
=== masakari ===
 
=== masakari ===
 +
 
API service and recovery engine for Masakari
 
API service and recovery engine for Masakari
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
| Official name
+
| Launchpad
| '''Masakari'''
+
| https://launchpad.net/masakari
 
|-
 
|-
 
| Source code
 
| Source code
| https://github.com/openstack/masakari
+
| https://opendev.org/openstack/masakari
 
|-
 
|-
 
| Bug tracker
 
| Bug tracker
 
| https://bugs.launchpad.net/masakari
 
| https://bugs.launchpad.net/masakari
 
|-
 
|-
| Feature tracker
+
| Feature tracker (blueprints)
 
| https://blueprints.launchpad.net/masakari
 
| https://blueprints.launchpad.net/masakari
 
|-
 
|-
| Developer doc
+
| Feature tracker (specs)
| http://docs.openstack.org/developer/masakari/
+
| https://specs.openstack.org/openstack/masakari-specs/
 +
|-
 +
| Code Review
 +
|https://review.opendev.org/#/q/project:openstack/masakari
 +
|-
 +
| CI Status
 +
|https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari
 +
|-
 +
| Docs
 +
| https://docs.openstack.org/masakari/latest/
 +
|-
 +
| API Reference
 +
|https://docs.openstack.org/api-ref/instance-ha/
 
|}
 
|}
  
 
=== python-masakariclient ===
 
=== python-masakariclient ===
 +
 
python-masakariclient provides python client library for Masakari built on the Masakari APIs. It provides a Python API (the masakariclient module) and a command-line tool for masakari.
 
python-masakariclient provides python client library for Masakari built on the Masakari APIs. It provides a Python API (the masakariclient module) and a command-line tool for masakari.
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
| Official name
+
| Launchpad
| '''Masakari'''
+
| https://launchpad.net/python-masakariclient
 
|-
 
|-
 
| Source code
 
| Source code
| https://github.com/openstack/python-masakariclient
+
| https://opendev.org/openstack/python-masakariclient
 
|-
 
|-
 
| Bug tracker
 
| Bug tracker
 
| https://bugs.launchpad.net/python-masakariclient
 
| https://bugs.launchpad.net/python-masakariclient
 
|-
 
|-
| Feature tracker
+
| Code Review
| https://blueprints.launchpad.net/python-masakariclient
+
|https://review.opendev.org/#/q/project:openstack/python-masakariclient
 
|-
 
|-
| Developer doc
+
| CI Status
| http://docs.openstack.org/developer/python-masakariclient
+
|https://zuul.opendev.org/t/openstack/builds?project=openstack/python-masakariclient
 +
|-
 +
| Docs
 +
| https://docs.openstack.org/python-masakariclient/latest/
 
|}
 
|}
  
 
=== masakari-monitors ===
 
=== masakari-monitors ===
 +
 
Masakari-monitors provides monitoring tools for Masakari. These tools monitor the openstack nova compute node and send notification to Masakari using masakari APIs.
 
Masakari-monitors provides monitoring tools for Masakari. These tools monitor the openstack nova compute node and send notification to Masakari using masakari APIs.
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
| Official name
+
| Launchpad
| '''Masakari'''
+
| https://launchpad.net/masakari-monitors
 
|-
 
|-
 
| Source code
 
| Source code
| https://github.com/openstack/masakari-monitors
+
| https://opendev.org/openstack/masakari-monitors
 
|-
 
|-
 
| Bug tracker
 
| Bug tracker
 
| https://bugs.launchpad.net/masakari-monitors
 
| https://bugs.launchpad.net/masakari-monitors
 
|-
 
|-
| Feature tracker
+
| Code Review
| https://blueprints.launchpad.net/masakari-monitors
+
|https://review.opendev.org/#/q/project:openstack/masakari-monitors
 
|-
 
|-
| Developer doc
+
| CI Status
| http://docs.openstack.org/developer/masakari-monitors
+
|https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari-monitors
 +
|-
 +
| Docs
 +
| https://docs.openstack.org/masakari-monitors/latest/
 +
|}
 +
 
 +
=== masakari-dashboard ===
 +
 
 +
Masakari-dashboard provides the dashboard (Horizon) plugin that exposes Masakari client functionality on Web.
 +
{| border="1" cellpadding="2"
 +
| Launchpad
 +
| https://launchpad.net/masakari-dashboard
 +
|-
 +
| Source code
 +
| https://opendev.org/openstack/masakari-dashboard
 +
|-
 +
| Bug tracker
 +
| https://bugs.launchpad.net/masakari-dashboard
 +
|-
 +
| Code Review
 +
|https://review.opendev.org/#/q/project:openstack/masakari-dashboard
 +
|-
 +
| CI Status
 +
|https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari-dashboard
 +
|-
 +
| Docs
 +
| https://docs.openstack.org/masakari-dashboard/latest/
 
|}
 
|}
  
 
== Project History ==
 
== Project History ==
Masakari started as a project on github.
 
Older version of masakari (< v1.1.1) is
 
[https://github.com/ntt-sic/masakari Masakri v1.1.1]
 
  
== Architecture ==
+
Masakari started as a project on GitHub.
[[File:MasakariDiagram2.svg|center|1000px|Masakari Architecture Diagram]]
+
Older versions of masakari (<=1.1.0) are still available at https://github.com/ntt-sic/masakari
  
== Masakari API Design ==
+
[http://specs.openstack.org/openstack/openstack-user-stories/user-stories/proposed/ha_vm.html User Story; High Availability for Virtual Machines]
[https://github.com/ntt-sic/masakari/wiki/Masakari-API-Design Masakari API Design (WIP)]
 

Latest revision as of 07:56, 31 May 2021

Masakari: Instances High Availability Service

Mission

Masakari provides Instances High Availability Service for OpenStack clouds by automatically recovering failed Instances. Currently, Masakari can recover KVM-based Virtual Machine(VM)s from failure events such as VM process down, provisioning process down, and nova-compute host failure. Masakari also provides an API service to manage and control the automated rescue mechanism.

Getting in Touch

We use the openstack-discuss@lists.openstack.org mailing list for discussions using subjects with the prefix "[masakari]".

We also hang out on IRC in #openstack-masakari on OFTC.

Governance

For basic information on Masakari's governance, including the current PTL (Project Team Lead), please visit Masakari's governance page.

To see the current list of Masakari core reviewers (aka cores), see the masakari-core group on Gerrit.

Project Meetings

See Meetings/Masakari.

Whiteboard

https://etherpad.opendev.org/p/masakari-whiteboard

Deliverables

Note project features are tracked via blueprints and specs on the main deliverable (masakari).

masakari

API service and recovery engine for Masakari

Launchpad https://launchpad.net/masakari
Source code https://opendev.org/openstack/masakari
Bug tracker https://bugs.launchpad.net/masakari
Feature tracker (blueprints) https://blueprints.launchpad.net/masakari
Feature tracker (specs) https://specs.openstack.org/openstack/masakari-specs/
Code Review https://review.opendev.org/#/q/project:openstack/masakari
CI Status https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari
Docs https://docs.openstack.org/masakari/latest/
API Reference https://docs.openstack.org/api-ref/instance-ha/

python-masakariclient

python-masakariclient provides python client library for Masakari built on the Masakari APIs. It provides a Python API (the masakariclient module) and a command-line tool for masakari.

Launchpad https://launchpad.net/python-masakariclient
Source code https://opendev.org/openstack/python-masakariclient
Bug tracker https://bugs.launchpad.net/python-masakariclient
Code Review https://review.opendev.org/#/q/project:openstack/python-masakariclient
CI Status https://zuul.opendev.org/t/openstack/builds?project=openstack/python-masakariclient
Docs https://docs.openstack.org/python-masakariclient/latest/

masakari-monitors

Masakari-monitors provides monitoring tools for Masakari. These tools monitor the openstack nova compute node and send notification to Masakari using masakari APIs.

Launchpad https://launchpad.net/masakari-monitors
Source code https://opendev.org/openstack/masakari-monitors
Bug tracker https://bugs.launchpad.net/masakari-monitors
Code Review https://review.opendev.org/#/q/project:openstack/masakari-monitors
CI Status https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari-monitors
Docs https://docs.openstack.org/masakari-monitors/latest/

masakari-dashboard

Masakari-dashboard provides the dashboard (Horizon) plugin that exposes Masakari client functionality on Web.

Launchpad https://launchpad.net/masakari-dashboard
Source code https://opendev.org/openstack/masakari-dashboard
Bug tracker https://bugs.launchpad.net/masakari-dashboard
Code Review https://review.opendev.org/#/q/project:openstack/masakari-dashboard
CI Status https://zuul.opendev.org/t/openstack/builds?project=openstack/masakari-dashboard
Docs https://docs.openstack.org/masakari-dashboard/latest/

Project History

Masakari started as a project on GitHub. Older versions of masakari (<=1.1.0) are still available at https://github.com/ntt-sic/masakari

User Story; High Availability for Virtual Machines