| commit | 749207633a9cc73320531d148ff6b363c144b71d | [log] [tgz] |
|---|---|---|
| author | Joseph Reynolds <jrey@us.ibm.com> | Thu Jun 14 11:38:13 2018 -0500 |
| committer | Joseph Reynolds <jrey@us.ibm.com> | Thu Sep 06 18:41:07 2018 -0500 |
| tree | 7296e398fee64f9fb1e4a02136d5a183a3e9809b | |
| parent | 8a39576caf0bffa1274a56d986230547eb4b9e84 [diff] |
Create security documentation in docs/security This creates the openbmc/docs/security directory with files: - ../README.md -- links to security/README.md - README.md -- explains the security documentation - obmc-development-practices.md -- The OpenBMC team - obmc-downstream-best-practices.md -- BMC lifecycle topics - obmc-release-checklist.md -- release planning As explained in the README, two more stories complete the overall security picture and are being worked on: - functional security describes what the BMC does to protect itself in terms of security features and user interfaces Resolves: openbmc/openbmc #3247. Change-Id: Ie47038af4939a28646c33ea653bccff0d722ab12 Signed-off-by: Joseph Reynolds <jrey@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.
Security: Root of the security documentation
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