| commit | ad3becf99e1a88a91c507a190baf9d80000e55a8 | [log] [tgz] |
|---|---|---|
| author | Patrick Venture <venture@google.com> | Fri Oct 19 10:47:27 2018 -0700 |
| committer | Patrick Venture <venture@google.com> | Fri Oct 19 10:48:53 2018 -0700 |
| tree | 17fa47b2f636a4d8cf2088486a26671ec6f7e017 | |
| parent | 318d9707f53515dabd1242e6d620052c69f1a75a [diff] |
design-template: reduce heading depth Reduce heading depth from the start to reduce depth of sub-headings in detailed design. As the designs are meant to stand alone, they do not need an explicit initial depth of 3. Change-Id: Ib037c2da81962d7b5bee8dc01916e1269e189e5e Signed-off-by: Patrick Venture <venture@google.com>
This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
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
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.
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