| commit | d318c6ebd72eaf7744d586b86f8d9209c28dbbe3 | [log] [tgz] |
|---|---|---|
| author | Brad Bishop <bradleyb@fuzziesquirrel.com> | Wed May 11 15:50:25 2016 -0400 |
| committer | Jeremy Kerr <jk@ozlabs.org> | Fri May 13 15:20:20 2016 +0800 |
| tree | 9faf581045be955e3182b85b69dcd57aca5c6ab3 | |
| parent | 57812c8902c07d9a217fc924b02c6bfeb99bf507 [diff] |
Take a stab at a proper DBUS API document. Changed the main structure to be interface based rather than topic based. Each interface should have a methods, signals properties and namespace section with a table and option free form examples or additional overview information. If an interface doesn't have any properties, methods or signals those sections can be omitted. The namespace section outlines where objects implementing certain interfaces are expected to be found. There are a number of things that still need to be filled out.
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