openstack
/
sushy
Code Issues Proposed changes

Adds sushy library overview 

Change-Id: I4c2d5eb427a7b76a1bfe69551cf0c9937567550d
Story: #2006610
Task: #36858
This commit is contained in:
Kafilat Adeleke 2020-10-27 02:18:06 -07:00
parent 16f1d3471c
commit d293dba628
3 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -1,5 +1,5 @@
About Sushy
===========
Overview
========
Sushy is a Python library to communicate with `Redfish`_ based systems.

18
doc/source/index.rst
View File

@ -9,6 +9,24 @@ Welcome to Sushy's documentation!
.. include:: ../../README.rst
Features
========
* Abstraction around the SystemCollection and System resources (Basic
server identification and asset information)
* RAID in Redfish based Systems
* Redfish Ethernet Interface
* System mappings
* System processor
* Storage management
* Systems power management (Both soft and hard; Including NMI injection)
* Changing systems boot device, frequency (Once or permanently) and mode
(UEFI or BIOS)
* Chassis management
* OEM extention
* Virtual media management
* Session Management
Documentation
=============

21
doc/source/reference/index.rst
View File

@ -2,31 +2,14 @@
Sushy Library Reference
=======================
Features
========
* Abstraction around the SystemCollection and System resources (Basic
server identification and asset information)
* Systems power management (Both soft and hard; Including NMI injection)
* Changing systems boot device, frequency (Once or permanently) and mode
(UEFI or BIOS)
* Virtual media management
* SessionManagement
Usage
=====
.. toctree::
:maxdepth: 2
usage
Missing Features
================
These are some features that sushy is presently missing.
* Collect sensor data (Health state, temperature, fans etc...)
* System disk size
* Serial console
Sushy Python API Reference
==========================