commit | e38bc90b920eea090c9851ecc273217e30339f25 | [log] [tgz] |
---|---|---|
author | Anthony Wilson <wilsonan@us.ibm.com> | Thu Nov 15 16:51:16 2018 -0600 |
committer | Anthony P. Wilson <wilsonan@us.ibm.com> | Mon Dec 03 07:51:05 2018 +0000 |
tree | 3d3887267ad59e42ae6c5adddb78fb2bc54f410f | |
parent | 7c61fbaf34126f4b1002c0378b14f8424caebf2d [diff] |
Add Gerrit setup documentation Guide for new users to setup their workstations to connect to and utilize Gerrit. Change-Id: Id0d263b4c775d0a26378d517047b0feea3c96d9e Signed-off-by: Anthony Wilson <wilsonan@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