summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoseph Reynolds <jrey@us.ibm.com>2019-01-16 16:04:42 -0600
committerGunnar Mills <gmills@us.ibm.com>2019-03-07 14:41:15 +0000
commit410869d5110c74ec20ae12abe0b1310e797ff35d (patch)
tree9dd09043c552b8bfa1ca097c84de212fd30bb447
parentb5c5da02eb6619e4e59aefaaa02c7898d8ce1003 (diff)
downloadopenbmc-docs-410869d5110c74ec20ae12abe0b1310e797ff35d.tar.gz
openbmc-docs-410869d5110c74ec20ae12abe0b1310e797ff35d.zip
Docs: Add Feature list with links to docs
This creates a document which lists OpenBMC features and provides links to documentation about each feature. Tested: via copy/paste into: https://dillinger.io Change-Id: Idfcd311a8b2fe4e30505a851e2aa77e26d5f442a Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
-rw-r--r--README.md4
-rw-r--r--features.md67
2 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77d47f1..5703788 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,10 @@
This repository contains documentation for OpenBMC as a whole. There may
be component-specific documentation in the repository for each component.
+The [features](features.md) document lists the project's major features
+with links to more information.
+
+
OpenBMC Usage
-------------
diff --git a/features.md b/features.md
new file mode 100644
index 0000000..ac1075a
--- /dev/null
+++ b/features.md
@@ -0,0 +1,67 @@
+# OpenBMC Features
+
+Follow links to learn more about OpenBMC features:
+
+* [BMCWeb][] HTTP/Web server
+* [Phosphor WebUI][] web application
+* REST Management: [BMCWeb Redfish][], [Phosphor REST APIs][] includes
+ [Host management REST APIs][]
+* [D-Bus interfaces][] describes internal interfaces
+* [D-Bus Object Mapper][]
+* [Remote KVM][]
+* [IPMI in band][] and [IPMI out of band][]
+* Full IPMI 2.0 Compliance with DCMI
+* SSH based SOL: [How to use][SOL How to use]
+* Power and Cooling Management: [Phosphor Fan Control][]
+* [Logging][Phosphor Logging] and [Callouts][Logging Callouts]
+* Zeroconf discoverable through `systemd-networkd`
+* [Sensors][]
+* Inventory: [Entity manager][], [Phosphor inventory manager][] and its [MSL application][]
+* [LEDs][]: see also [LED Groups][]
+* Host Watchdog: [Phosphor Watchdog Implementation][]
+* [Power State management] and [Chassis Power control][]
+* [Network management][]
+* [Factory reset][]
+* [User management][Phosphor User Management]
+* Time (time of day clock) management
+* [Certificate management][]: [Phosphor Certificate Manager][]
+* [Simulation][] via QEMU
+* [Firmware update support][]
+* [POWER OCC Support][POWER OCC Implementation] (On Chip Controller)
+* [Automated Testing][]
+* LDAP
+* Remote syslog
+
+[Automated Testing]: https://github.com/openbmc/openbmc-test-automation/blob/master/README.md
+[BMCWeb]: https://github.com/openbmc/bmcweb/blob/master/README.md
+[BMCWeb Redfish]: https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish
+[Certificate management]: https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/Certs/README.md
+[Chassis Power control]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/Chassis/README.md
+[D-Bus interfaces]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/README.md
+[D-Bus Object Mapper]: https://github.com/openbmc/docs/blob/master/object-mapper.md
+[Entity manager]: https://github.com/openbmc/entity-manager/blob/master/README.md
+[Factory reset]: https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/Common/FactoryReset/README.md
+[Firmware update support]: https://github.com/openbmc/docs/blob/master/code-update/code-update.md
+[Host management]: https://github.com/openbmc/docs/blob/master/host-management.md
+[Host management REST APIs]: https://github.com/openbmc/docs/blob/master/host-management.md
+[IPMI in band]: https://github.com/openbmc/docs/blob/master/ipmi-architecture.md
+[IPMI out of band]: https://github.com/openbmc/ipmitool/blob/master/README
+[LED Groups]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/Led/README.md
+[LEDs]: https://github.com/openbmc/docs/blob/master/LED-architecture.md
+[Logging Callouts]: https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/Common/Callout/README.md
+[MSL application]: https://github.com/openbmc/phosphor-dbus-monitor/blob/master/mslverify/README.md
+[Network management]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/Network/README.md
+[Phosphor Certificate Manager]: https://github.com/openbmc/phosphor-certificate-manager/blob/master/README.md
+[Phosphor Fan Control]: https://github.com/openbmc/phosphor-fan-presence/blob/master/README.md
+[Phosphor inventory manager]: https://github.com/openbmc/phosphor-inventory-manager/blob/master/README.md
+[Phosphor Logging]: https://github.com/openbmc/phosphor-logging/blob/master/README.md
+[Phosphor REST APIs]: https://github.com/openbmc/docs/blob/master/rest-api.md
+[Phosphor User Management]: https://github.com/openbmc/docs/blob/master/user_management.md
+[Phosphor Watchdog Implementation]: https://github.com/openbmc/phosphor-watchdog
+[Phosphor WebUI]: https://github.com/openbmc/phosphor-webui/blob/master/README.md
+[Power OCC Implementation]: https://github.com/openbmc/openpower-occ-control
+[Remote KVM]: https://github.com/openbmc/obmc-ikvm/blob/master/README.md
+[Sensors]: https://github.com/openbmc/docs/blob/master/sensor-architecture.md
+[Simulation]: https://github.com/openbmc/docs/blob/master/development/dev-environment.md
+[Power State management]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/State/README.md
+[SOL How to use]: https://github.com/openbmc/docs/blob/master/console.md
OpenPOWER on IntegriCloud