commit | 1781f86b19e72142cd023f4ad53e1ba081903266 | [log] [tgz] |
---|---|---|
author | Andrew Geissler <geissonator@yahoo.com> | Mon Dec 10 14:43:13 2018 -0600 |
committer | Andrew Geissler <geissonator@yahoo.com> | Mon Dec 10 14:43:13 2018 -0600 |
tree | 67023f38e795e7f218a15c4be91ffe4b6bf9ffc1 | |
parent | e38bc90b920eea090c9851ecc273217e30339f25 [diff] |
Ensure text does not exceed 80 chars Change-Id: I2dc35db00ec50f6efe083a249a1b76e1892c390a Signed-off-by: Andrew Geissler <geissonator@yahoo.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