A set of tools to support the development and test of the Sushy library
Go to file
Andreas Jaeger 6baebba032 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I92d494b7579a7d9c131985f67c53bed20fb69048
2020-05-24 15:12:22 +02:00
doc/source Switch to newer openstackdocstheme and reno versions 2020-05-24 15:12:22 +02:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-05-24 15:12:22 +02:00
sushy_tools Stop using six library 2020-05-04 12:54:39 +02:00
zuul.d Restore default netboot boot option 2020-04-27 16:01:13 +02:00
.coveragerc Initial Commit 2017-04-06 17:05:16 +01:00
.gitignore Switch to use stestr for unit test 2018-07-27 08:14:22 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:44:40 +00:00
.mailmap Initial Commit 2017-04-06 17:05:16 +01:00
.stestr.conf Switch to use stestr for unit test 2018-07-27 08:14:22 +07:00
CONTRIBUTING.rst Initial Commit 2017-04-06 17:05:16 +01:00
HACKING.rst Update the URL in HACKING.rst 2018-09-23 16:38:42 +08:00
LICENSE Initial Commit 2017-04-06 17:05:16 +01:00
README.rst Correct doc link to point to sushy-tools docs 2019-10-25 10:35:19 +02:00
bindep.txt Fix pdf build 2020-05-14 16:16:35 +02:00
lower-constraints.txt Switch to newer openstackdocstheme and reno versions 2020-05-24 15:12:22 +02:00
requirements.txt Stop using six library 2020-05-04 12:54:39 +02:00
setup.cfg Cleanup py27 support 2020-04-05 20:13:36 +02:00
setup.py Cleanup py27 support 2020-04-05 20:13:36 +02:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-24 15:12:22 +02:00
tox.ini Merge "Stop configuring install_command in tox." 2020-04-29 11:19:36 +00:00

README.rst

Redfish development tools

This is a set of simple simulation tools aiming at supporting the development and testing of the Redfish protocol implementations and, in particular, Sushy library (https://docs.openstack.org/sushy/).

The package ships two simulators - static Redfish responder and virtual Redfish BMC that is backed by libvirt or OpenStack cloud.

The static Redfish responder is a simple REST API server which responds the same things to client queries. It is effectively read-only.

The virtual Redfish BMC resembles the real Redfish-controlled bare-metal machine to some extent. Some client queries are translated to commands that actually control VM instances simulating bare metal hardware. However some of the Redfish commands just return static content never touching the virtualization backend and, for that matter, virtual Redfish BMC is similar to the static Redfish responser.