| commit | a72974312446174f382ab424460f3b355fc2874c | [log] [tgz] |
|---|---|---|
| author | Jeremy Kerr <jk@ozlabs.org> | Thu May 05 12:24:23 2016 +0800 |
| committer | Jeremy Kerr <jk@ozlabs.org> | Thu May 05 15:08:23 2016 +0800 |
| tree | da25d1b0c1731b7e2ee17cafc1a78c7b922b1617 | |
| parent | 235ccfc123806b736a50cc90838e634737c3842d [diff] |
Add infrastructure for User Guide This change adds a little infrastructure for creating an OpenBMC User's Guide, from the user-related documents in markdown. 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
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, 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