| commit | 1cf85a540ba51480422323ae9c9a9364f4781c0f | [log] [tgz] |
|---|---|---|
| author | Jeremy Kerr <jk@ozlabs.org> | Wed May 04 15:04:13 2016 +0800 |
| committer | Jeremy Kerr <jk@ozlabs.org> | Wed May 04 15:04:13 2016 +0800 |
| tree | 5808a346c1d180b3c62ea38e230f6f0a373f134b | |
| parent | c16e3d0379088c19ec354259e4495f97533d12f5 [diff] |
README: Add OpenBMC goals section Based on the user guide Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
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
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, easily 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