From d293dba6287cd331de3c3afc4b2631476d053d6a Mon Sep 17 00:00:00 2001 From: Kafilat Adeleke Date: Tue, 27 Oct 2020 02:18:06 -0700 Subject: [PATCH] Adds sushy library overview Change-Id: I4c2d5eb427a7b76a1bfe69551cf0c9937567550d Story: #2006610 Task: #36858 --- README.rst | 4 ++-- doc/source/index.rst | 18 ++++++++++++++++++ doc/source/reference/index.rst | 21 ++------------------- 3 files changed, 22 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index ef3ec981..7ade1e11 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -About Sushy -=========== +Overview +======== Sushy is a Python library to communicate with `Redfish`_ based systems. diff --git a/doc/source/index.rst b/doc/source/index.rst index 6c231684..e3bcc482 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ============= diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 998aacf2..ba410c63 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -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 ==========================