commit | 4635bf2fecc3d47af9edac1fd41b19d465372880 | [log] [tgz] |
---|---|---|
author | Patrick Venture <venture@google.com> | Fri Jun 02 12:03:32 2017 -0700 |
committer | Patrick Venture <venture@google.com> | Fri Jun 02 19:17:01 2017 +0000 |
tree | 3c7dc6a9ab64b3d16b72df730fb22203f3e956a0 | |
parent | b91c244f419f543bdaa31611f92cbee7a34f5fc6 [diff] |
Added rw overlay fs note to cheatsheet. Change-Id: I2d5c9068775ff353af92e25d6fa8aa06a79b09aa 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.md: 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
dbus-interfaces.md: Reference for APIs exposed to dbus
kernel-development.md: Reference for common kernel development tasks
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