OpenBMC documentation

This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.

The features document lists the project's major features with links to more information.

OpenBMC Usage

These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.

• rest-api.md: Introduction to using the OpenBMC REST API

• console.md: Using the host console

• host-management.md: Performing host management tasks with OpenBMC

• code-update: Updating OpenBMC and host platform firmware

OpenBMC Development

These documents contain details on developing OpenBMC code itself

• cheatsheet.md: Quick reference for some common development tasks

• CONTRIBUTING.md: Guidelines for contributing to OpenBMC

• kernel-development.md: Reference for common kernel development tasks

• REST-cheatsheet.md: Quick reference for some common curl commands usage.

OpenBMC Goals

The OpenBMC project's aim is to create a highly extensible framework for BMC software and implement for data-center computer systems.

We have a few high-level objectives:

• The OpenBMC framework must be extensible, easy to learn, and usable in a variety of programming languages.

• Provide a REST API for external management, and allow for "pluggable" interfaces for other types of management interactions.

• Provide a remote host console, accessible over the network

• Persist network configuration settable from REST interface and host

• Provide a robust solution for RTC management, exposed to the host.

• Compatible with host firmware implementations for basic IPMI communication between host and BMC

• Provide a flexible and hierarchical inventory tracking component

• Maintain a sensor database and track thresholds

Technical Steering Committee

• Brad Bishop (chair), IBM
• Nancy Yuen, Google
• Sai Dasari, Facebook
• James Mihm, Intel
• Sagar Dharia, Microsoft
• Supreeth Venkatesh, Arm