# Welcome to Masakari’s documentation!

Masakari is an OpenStack project designed to ensure high availability of instances and compute processes running on hosts.

This documentation is intended to help explain the current scope of the Masakari project and the architectural decisions made to support this scope. The documentation will include the future architectural roadmap and the current development process and policies.

## Masakari API References

The Masakari API is extensive. We provide a concept guide which gives some of the high level details, as well as a more detailed API reference.

## Operator Guide

### Architecture Overview

- Masakari architecture: An overview of how all the components in masakari work together.

### Installation

A detailed install guide for masakari.

- Masakari services
  - Masakari service overview
  - Install and configure
  - Verify operation

### Reference Material

- Configuration Guide: Information on configuration files.

- Custom Recovery Workflow Configuration Guide

- CLI Commands for Masakari: The complete command reference for Masakari.

- Versioned Notifications: This provides the list of existing versioned notifications with sample payloads. This will help newcomers understand basics of Masakari

- Nova Docs: A collection of guides for Nova.

## Contributor Guide

- How to get (more) involved with Masakari
  - How do I get started?
  - Top Tips for working with the Masakari community
  - Process
  - Why do code reviews if I am not in masakari-core?
  - How to do great code reviews?
  - How do I become masakari-core?
- Masakari team process
  - OpenStack Wide Patterns
  - How do I get my code merged?
- Development Quickstart
  - Setup
  - Building the Documentation
  - Running unit tests
- Masakari Code Structure
  - Code layout
  - The data model
  - The entry points
  - The tests
- Release notes
  - Introduction
  - Templates and examples

## For Contributors

- If you are a new contributor to Masakari please refer: So You Want to Contribute…

## Search

- Search Page: Search the contents of this document.

- OpenStack wide search: Search the wider set of OpenStack documentation, including forums.

this page last updated: 2026-04-01 20:28:51

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug