1# OpenBMC documentation 2 3This repository contains documentation for OpenBMC as a whole. There may 4be component-specific documentation in the repository for each component. 5 6OpenBMC Usage 7------------- 8 9These documents describe how to use OpenBMC, including using the programmatic 10interfaces to an OpenBMC system. 11 12 - [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API 13 14 - [console.md](console.md): Using the host console 15 16 - [host-management.md](host-management.md): Performing host management tasks 17 with OpenBMC 18 19 - [code-update](code-update): Updating OpenBMC and host platform firmware 20 21 22OpenBMC Development 23------------------- 24 25These documents contain details on developing OpenBMC code itself 26 27 - [cheatsheet.md](cheatsheet.md): Quick reference for some common 28 development tasks 29 30 - [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to 31 OpenBMC 32 33 - [kernel-development.md](kernel-development.md): Reference for common 34 kernel development tasks 35 36 - [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common 37 curl commands usage. 38 39 40OpenBMC Goals 41------------- 42 43The OpenBMC project's aim is to create a highly extensible framework for BMC 44software and implement for data-center computer systems. 45 46We have a few high-level objectives: 47 48 * The OpenBMC framework must be extensible, easy to learn, and usable in a 49 variety of programming languages. 50 51 * Provide a REST API for external management, and allow for "pluggable" 52 interfaces for other types of management interactions. 53 54 * Provide a remote host console, accessible over the network 55 56 * Persist network configuration settable from REST interface and host 57 58 * Provide a robust solution for RTC management, exposed to the host. 59 60 * Compatible with host firmware implementations for basic IPMI communication 61 between host and BMC 62 63 * Provide a flexible and hierarchical inventory tracking component 64 65 * Maintain a sensor database and track thresholds 66 67 68Technical Steering Committee 69--------------------------- 70 71 * Brad Bishop (chair), IBM 72 * Nancy Yuen, Google 73 * Sai Dasari, Facebook 74 * James Mihm, Intel 75 * Ali Larijani, Microsoft 76