sushy-tools/README.rst
Jay Faulkner 8427349985 Explictily document not for production use
Sushy-tools is a CI/development tool, for CI uses. It should not be run
in production.

Story: #2010382
Task: #46664
Change-Id: If90a38913f762ca4dc4f7b321b6b1e61db95105e
2022-10-26 09:30:13 -07:00

1.3 KiB

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/). It is not designed for use outside of development and testing environments. Please do not run sushy-tools in a production environment of any kind.

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.