| commit | b41aff0fabe137cdb0cfff584b5fe4a41c0c8e77 | [log] [tgz] |
|---|---|---|
| author | Xiaochao Ma <maxiaochao@inspur.com> | Thu Sep 05 15:41:05 2019 +0800 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Fri Nov 01 20:15:02 2019 +0000 |
| tree | 93ebf2d85bf4141943ea314775e95ecbab902ec8 | |
| parent | 3f757abb0742e18ac407ea56a83219a818b21854 [diff] |
Optimize REDFISH and REST documents Optimized several documents about REST and REDFISH. Add new command and fix out-of-date commands. Tested on fp5280g2 that all commands are working on openbmc version 2.8.0-dev-434-g48f8ce5a5-dirty. Signed-off-by: Xiaochao Ma <maxiaochao@inspur.com> Change-Id: Ibbf1857cef327e57cceb5ac9f206ddf10601cb42
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