| commit | 4614fd5950110b041b3f5645dbbd4e71d5482cee | [log] [tgz] |
|---|---|---|
| author | Andrew Geissler <geissonator@yahoo.com> | Fri Oct 19 13:20:52 2018 -0400 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Thu Oct 25 18:51:03 2018 +0000 |
| tree | 48584a27655bd865f675fade7259883e8f38148c | |
| parent | f600673d2df96bbba6228090ac3a84eaee5312d9 [diff] |
dev-doc: Add README to development directory Provide a summary of each lesson and the recommended order to read them Change-Id: Iee33a13c80e10bb6ab9f39d232c41c3fb7e1ebcd 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