Chapter 0. Introduction

Welcome to OpenCHAMI!

This handbook is meant to serve as a guide and a reference for deploying, configuring, and administering OpenCHAMI.

0.1. How to Use The Documentation#

The documentation section has been split into subsections based on purpose:

• OpenCHAMI Tutorial – A detailed guide for deploying virtual machines using OpenCHAMI meant to be a practical way for understanding OpenCHAMI.
• The OpenCHAMI Handbook (You are here) – The main guide for configuring the core of OpenCHAMI for most use cases, with links to other relevant content.
• Guides – Guides documenting how to deploy/use OpenCHAMI for some extended use cases.
• Architecture – Details on component organization, philosophy, design decisions, etc.
• Software – Details on each software component in OpenCHAMI, including detailed configuration documentation.

This handbook is organized by chapter and attempt to logically organize information

0.2. What Is OpenCHAMI?#

See the About Us and Origin pages for high-level information, including frequently asked questions. See also the Introduction to OpenCHAMI to learn why OpenCHAMI was created.

OpenCHAMI is the Open Composable, Heterogeneous, Adaptable Management Infrastructure, a set of open source system management software organized into microservices that use a REST API.

0.3. Contributing#

OpenCHAMI welcomes contributions.

For code or documentation contributions, see the contribution guidelines.

For edition of this handbook or other page in the documentation on openchami.org, find the Edit in GitHub link on the page, which links to the file on GitHub where the page can be edited and a pull request made.