| commit | 395b2d035f1adb7c978defaaf549f8e16898bd1f | [log] [tgz] |
|---|---|---|
| author | Alexander Amelkin <a.amelkin@yadro.com> | Mon Nov 26 17:46:17 2018 +0300 |
| committer | Alexander Amelkin <a.amelkin@yadro.com> | Mon Nov 26 17:55:19 2018 +0300 |
| tree | 7a696ca7b67b05cbbf7ed06b123ff95a12e6f29f | |
| parent | b0418993e3944e56ac033ec8eaa37404fb8b9b0f [diff] |
dev-environment: Fix example formatting Use proper markdown with `obmcutil state` example, also fix 'Note' formatting under that example. Change-Id: I45dcaf282d422f6ab8a91e554ef75f6bcbb6633f Signed-off-by: Alexander Amelkin <a.amelkin@yadro.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