openstack/masakari
Code Issues Proposed changes
Files
44cae8ad7fef17ace1b3fe6ae5258b12417b2c08
masakari/doc/source/index.rst
Ghanshyam Mann 44cae8ad7f [community goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38536
Change-Id: I1d8ff80322deffb904d1bfe16b5a5ad9d4d9fc07
2021-05-31 20:33:51 +00:00

3.4 KiB
Raw Blame History

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 </user/architecture>: An overview of how all the components in masakari work together.

Installation

A detailed install guide for masakari.

install/index

Reference Material

  • Configuration Guide <configuration/index>: Information on configuration files.
  • Custom Recovery Workflow Configuration Guide <configuration/recovery_workflow_custom_task>
  • CLI Commands for Masakari </cli/index>: The complete command reference for Masakari.
  • Versioned Notifications </user/notifications>: This provides the list of existing versioned notifications with sample payloads.
  • Masakari team process <user/process>
  • Getting started with Masakari <user/how_to_get_involved>: This will help newcomers understand basics of Masakari
  • Nova Docs: A collection of guides for Nova.

cli/index configuration/api-paste.ini.rst configuration/config.rst configuration/index.rst configuration/policy.rst configuration/recovery_config.rst configuration/recovery_workflow_custom_task.rst configuration/recovery_workflow_sample_config.rst configuration/sample_config.rst configuration/sample_policy.rst install/development.environment.rst user/architecture.rst user/how_to_get_involved.rst user/notifications.rst user/process.rst

For Contributors

  • If you are a new contributor to Masakari please refer: contributor/contributing

    contributor/contributing

Search

  • search: Search the contents of this document.
  • OpenStack wide search: Search the wider set of OpenStack documentation, including forums.