commit | d6d83f8549399c9aa37d735df8123e30f8c8444a | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Wed Aug 15 12:47:24 2018 -0500 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Aug 15 12:47:58 2018 -0500 |
tree | 3ab50b6b3a13d0e25a64789adc06f9810531571c | |
parent | 94b94e50f8122781c7bff389ee0cae6787c37db8 [diff] |
Remove rfc-obmc-service-iface.md rfc-obmc-service-iface.md has been in the deprecated dir for months. Nothing in the document is currently relevant. Change-Id: I4bcac688cd990bc6d392a740ed84c3384125791f 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