| commit | 8b3ca6fb852815ce13d147893b384d7a703a60c6 | [log] [tgz] |
|---|---|---|
| author | Brad Bishop <bradleyb@fuzziesquirrel.com> | Fri Aug 24 08:41:45 2018 -0400 |
| committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | Fri Aug 24 08:45:16 2018 -0400 |
| tree | 44258996d921624fcf88a3e1ec7aee23457c25e5 | |
| parent | a75fe2f8e1165c542c3c25df840d660f1456f7e3 [diff] |
subtree: Replace GitHub remotes with Gerrit Gerrit is the canonical location for OpenBMC hosted meta-* repositories, with GitHub being a read-only mirror. As such update the subtree documentation to refer to the canonical sources, on the off chance that GitHub replication stops working or the meta-* mirrors are hosted elsewhere someday. Change-Id: Id846d01a14874b9fecbb02f9ce7694cd2a73bff9 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.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