| commit | 17dbdee6f08b4995a9998b814e5d1faaa0280a41 | [log] [tgz] |
|---|---|---|
| author | Kurt Taylor <kurt.r.taylor@gmail.com> | Fri Aug 10 17:07:34 2018 -0500 |
| committer | Kurt Taylor <kurt.r.taylor@gmail.com> | Mon Aug 27 23:35:25 2018 +0000 |
| tree | 0cddade17ba9028bafcbcc608a317eb80bab8d8b | |
| parent | de502e10d77a2e6f67944febc84ccd4286cb4502 [diff] |
OpenBMC Design Template This is a proposed design template for new OpenBMC features. It is heavily influenced by the OpenStack, PEP and Google design documents. Change-Id: I80cd52873e2692a4ffed6589507c46b5d99f47fb Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.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: 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
kernel-development.md: Reference for common kernel development tasks
REST-cheatsheet.md: Quick reference for some common curl commands usage.
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