commit | d54ca80810c87bcf2b9a8cdcba4149ecb42985ba | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Mon Nov 27 15:41:11 2017 -0600 |
committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | Mon Dec 04 20:05:09 2017 +0000 |
tree | 0f40e4d54a0e36db3e90e0b67f4280f17be6e7db | |
parent | 56d79455f15ef07be326e59fde4b47ca5866a30c [diff] |
Change //bmc/ to //${bmc}/ in examples Changed the example calls from //bmc/ to //${bmc}/. This is more obvious and users can set bmc to their bmc ip and just copy/paste these example calls. Change-Id: I5bb2794fc80121ca793acf2d8cdd2fa27f56596b Signed-off-by: Gunnar Mills <gmills@us.ibm.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.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 D-Bus
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