| commit | f8250a89b21dcad5fa1cd356ff086cc71c6ee82e | [log] [tgz] |
|---|---|---|
| author | Brad Bishop <bradleyb@fuzziesquirrel.com> | Thu Apr 05 12:45:14 2018 -0400 |
| committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | Tue May 22 02:25:44 2018 +0000 |
| tree | 74e22eb038f3d1dc193efa14dba8827f8bc6d181 | |
| parent | a3c65c0d2ec0cd99093d9281139caabd61a76430 [diff] |
contributing: Add CLA signing instructions Change-Id: I56dad1efc311d330e19b44c628f272457bffe06f 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