| commit | 84ef2aa26ed0fec5159532279becbcf19a7975df | [log] [tgz] |
|---|---|---|
| author | Patrick Venture <venture@google.com> | Sat Oct 20 20:14:10 2018 -0700 |
| committer | Patrick Venture <venture@google.com> | Mon Oct 22 16:23:00 2018 +0000 |
| tree | 36544f214d641bfd3d9028b989616fc635b14a5f | |
| parent | ad3becf99e1a88a91c507a190baf9d80000e55a8 [diff] |
cpp-style-and-conventions: fix wrong case in example Class names are UpperCamelCase. Change-Id: Ic7d9432ec8458ef6e54070b0af445a9be10f1c9a Signed-off-by: Patrick Venture <venture@google.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