commit | a75fe2f8e1165c542c3c25df840d660f1456f7e3 | [log] [tgz] |
---|---|---|
author | Dave Cobbley <david.j.cobbley@linux.intel.com> | Thu Aug 09 17:32:14 2018 -0700 |
committer | Gunnar Mills <gmills@us.ibm.com> | Thu Aug 23 19:32:30 2018 +0000 |
tree | f24768838b488578d1a50be08efaba08c0a5c703 | |
parent | d9c32b0762dede747a6bc42b9f997027ce5b5955 [diff] |
Subtree documentation on workflows and structure Attempting to define the new architecture for how developers will contribute to the OpenBMC project meta-data. 15 new repositories will be created (if non-existent) to hold these subtrees. The idea is that a developer will clone openbmc/openbmc, commit, and then push their changes to a subtree'd repository. Automation on the back end will then take the new changes, merge them into openbmc/openbmc. Change-Id: I6c47c206131bc3a7b0be9aa7652995179ddfa619 Signed-off-by: Dave Cobbley <david.j.cobbley@linux.intel.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