| commit | dfc4bbf2a227b2251ef8d69e7c88c8fbb2debaea | [log] [tgz] |
|---|---|---|
| author | Andrew Geissler <geissonator@yahoo.com> | Tue May 28 11:34:50 2019 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Tue Jun 18 14:04:55 2019 +0000 |
| tree | 5e5026164661e84304ccd5b87daf39e246cdf7d3 | |
| parent | 2c17ba1e1bb7d077c4b13ab9cdeacdd599d1e08b [diff] |
Clarify priority and firmware update design As a part of OpenBMC becoming engaged with the Redfish DMTF, some design points have come to light: - The existing UpdateService API using HttpPushUri is considered an OEM interface by the DMTF. It will continue to be documented within the specification but a new RedfishHttpPushUri is working its way through review. - The priority concept used within OpenBMC for firmware images was not accepted by the DMTF, but a different solution which provides similar functionality was reviewed and approved. Both of these points have been updated within this document and will be supported in the next OpenBMC release. Change-Id: I37b0158e3e342da98ed8680e1314281b23e8428f 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.
The features document lists the project's major features with links to more information.
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