| commit | b5c5da02eb6619e4e59aefaaa02c7898d8ce1003 | [log] [tgz] |
|---|---|---|
| author | Andrew Geissler <geissonator@yahoo.com> | Thu Feb 14 09:13:32 2019 -0600 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Sat Feb 23 17:28:23 2019 +0000 |
| tree | 96d1480923c463012cd25653756f92e602570035 | |
| parent | 8b37263fe11d6b8790121d09828dd57080e4cf29 [diff] |
design: Add "design" topic to gerrit reviews This allows a query like this to be run to find all open design docs: https://gerrit.openbmc-project.xyz/#/q/topic:design+status:open This allows easy searching for design reviews in gerrit. Change-Id: Ia9dbdf0b762af7713e2cbd647ca45a8c5a609424 Signed-off-by: Andrew Geissler <geissonator@yahoo.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