| commit | 2760941bb881b682eb7dea90f2cfca82f0a15ee7 | [log] [tgz] |
|---|---|---|
| author | George Keishing <gkeishin@in.ibm.com> | Thu Jan 11 22:48:56 2018 -0600 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Wed Jan 17 14:31:25 2018 +0000 |
| tree | 7eef5f54f84ff058447ee14f7af28e6ebecc084e | |
| parent | de21daa7ad3ff0e1964f74511321ef028f61c43d [diff] |
Update README.md and REST-cheatsheet.md
Added:
- Link to REST-cheatsheet.md.
- Command to set Name and NTP server.
Change-Id: I2280d3e5cccae75568ac8cabb0c238a89f0fa138
Signed-off-by: George Keishing <gkeishin@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: 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