commit | 0772bd824bb7477ab65e7c6343d624c5f59d8109 | [log] [tgz] |
---|---|---|
author | Deepak Kodihalli <dkodihal@in.ibm.com> | Tue Apr 11 10:01:57 2017 -0500 |
committer | Deepak Kodihalli <dkodihal@in.ibm.com> | Fri Apr 21 13:36:20 2017 -0500 |
tree | 8b730d5856779d01a102a5886420b9d05d9c346d | |
parent | e07969f65775825b038f5089f233098bbea3a72b [diff] |
rest-api: document '/upload/image' route usage Change-Id: I4ed9e67bf19646da4b418a3e002a4c17a4e0bd3e Signed-off-by: Deepak Kodihalli <dkodihal@in.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.md: 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
dbus-interfaces.md: Reference for APIs exposed to dbus
kernel-development.md: Reference for common kernel development tasks
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