| commit | 3f06a886bc81abfdc832882888b5fc31f10dd7a3 | [log] [tgz] |
|---|---|---|
| author | Emily Shaffer <emilyshaffer@google.com> | Wed Oct 10 06:49:10 2018 -0700 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Thu Nov 15 21:47:05 2018 +0000 |
| tree | 930227f3fc8f2254584da0c6bef40a94b0cad3c4 | |
| parent | 19a592a17a170dfc3d7f0099ad6a095cfe0fe6a3 [diff] |
Add first version of community Code of Conduct Adapted from the Linux Foundation COC, https://lfprojects.org/policies/code-of-conduct/ Change-Id: Ic5251970b65ab46b6c5a979e14fbcfa24772be4f Signed-off-by: Emily Shaffer <emilyshaffer@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