| commit | 3ef8adf3e1893230d5d65f12f888ffad99e578b8 | [log] [tgz] |
|---|---|---|
| author | Jeremy Kerr <jk@ozlabs.org> | Wed May 04 15:47:27 2016 +0800 |
| committer | Jeremy Kerr <jk@ozlabs.org> | Thu May 05 15:05:44 2016 +0800 |
| tree | ab0c123721e9b4c30f65c9def74749279cf5dc97 | |
| parent | 1cf85a540ba51480422323ae9c9a9364f4781c0f [diff] |
rest-api: Restructure and expand, and improve example code This change restructures the rest-api document a little, so that it's more in a manual format. Also, we simplify the command-line examples a little, by only providing the cjar-specific options where required; use single-quoting to avoid lots of shell escaping; add command output where suitable, and wrap to prevent long lines. 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