| commit | b142fdd1578b2d3def7d6e6e07a7079575a58afc | [log] [tgz] |
|---|---|---|
| author | Gunnar Mills <gmills@us.ibm.com> | Mon Feb 11 09:31:13 2019 -0600 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Tue Feb 12 19:07:43 2019 +0000 |
| tree | 0d18d5c3c3aa9b76aaf54938a27f8cb703cb471b | |
| parent | acedc151c1384af37701679a711d962da4d5dd46 [diff] |
Move release docs to release/ dir Created a release/ dir and moved release docs to it. Renamed release docs with a - (this is the convention used in the other docs). Fixed the link release-notes.md Change-Id: I565ccb38f55dbdc4fcf84a743bd7928c826dda30 Signed-off-by: Gunnar Mills <gmills@us.ibm.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