commit | f6b9fe0eeed77355c08886fc41abd608426657e9 | [log] [tgz] |
---|---|---|
author | Adriana Kobylak <anoo@us.ibm.com> | Tue Nov 01 09:21:01 2016 -0500 |
committer | Adriana Kobylak <anoo@us.ibm.com> | Tue Nov 01 09:24:45 2016 -0500 |
tree | 1926b372a3e317774a0406db34fd1ccaab310261 | |
parent | 155192f5158dac8c330e350cdddae92719d1b2ad [diff] |
cheatsheet.md: Replace oe-init-build-env with openbmc-env Change-Id: I59f81279c4ac018c8543cd79dbaf447adbf35c6a Signed-off-by: Adriana Kobylak <anoo@us.ibm.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