Sushy is a small Python library to communicate with Redfish based systems
Go to file
Jay Faulkner 7c2a2511fc Requests must always have a read/connect timeout
Before this change, a request to a nonresponsive BMC may have hung
forever waiting for requests to connect and read. Now, we ensure all
calls have a timeout unless explicitly disabled by the API user.

Because timeout was already an argument for _op, anyone attempting
to previously override the requests timeout (send one at all) wouldn't
have been able to for pythonic reasons.

Closes-Bug: 2021995
Change-Id: I76c543c6e39bab81f46a7aa00f1d38328c30cf7b
2023-07-18 13:05:00 -07:00
doc Remove unicode literal from code 2022-06-09 07:35:58 +00:00
releasenotes Requests must always have a read/connect timeout 2023-07-18 13:05:00 -07:00
sushy Requests must always have a read/connect timeout 2023-07-18 13:05:00 -07:00
tools Prepare the ground to use enums instead of strings 2021-10-27 11:08:32 +02:00
zuul.d Remove setuptools workaround 2023-01-12 14:52:52 +01:00
.coveragerc Omit tests from code coverage run 2018-09-25 07:13:40 +00:00
.gitignore Switch to use stestr for unit test 2018-07-19 10:46:08 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:38 +00:00
.mailmap Initial commit 2017-02-13 22:04:23 +00:00
.stestr.conf Switch to use stestr for unit test 2018-07-19 10:46:08 +07:00
CONTRIBUTING.rst Update Launchpad references to Storyboard 2018-03-26 12:21:46 -07:00
HACKING.rst fix error url 2018-02-06 00:58:41 +08:00
LICENSE Initial commit 2017-02-13 22:04:23 +00:00
README.rst Adds sushy library overview 2020-11-03 04:22:50 -08:00
bindep.txt Fix pdf build 2020-05-14 13:36:50 +02:00
requirements.txt Drop lower-constraints.txt and its testing 2022-04-30 17:54:55 -05:00
setup.cfg Remove setuptools workaround 2023-01-12 14:52:52 +01:00
setup.py Remove setuptools workaround 2023-01-12 14:52:52 +01:00
test-requirements.txt Add doc/requirements 2021-01-06 18:09:30 +01:00
tox.ini Update pep8 dep hacking to latest: v6 2023-04-21 12:56:38 -07:00

README.rst

Overview

Sushy is a Python library to communicate with Redfish based systems.

The goal of the library is to be extremely simple, small, have as few dependencies as possible and be very conservative when dealing with BMCs by issuing just enough requests to it (BMCs are very flaky).

Therefore, the scope of the library has been limited to what is supported by the OpenStack Ironic project. As the project grows and more features from Redfish are needed we can expand Sushy to fulfill those requirements.