Dmitry Tantsur 95784428a4
Decompose the Redfish documentation
This page is huge and keeps growing. So:
* Move additional topics to sub-documents.
* Move ESP creation to the install guide (it's not even
  Redfish-specific).
* Create a generic firmware updates document.

Provide a feature listing at the top for easier navigation.

Change-Id: Ic58c139da5e1e60f5ce4d2cec18972ebee9e2485
2024-06-13 12:37:11 +02:00

1.4 KiB

Redfish Interoperability Profile

The Ironic project provides a Redfish Interoperability Profile located in redfish-interop-profiles folder at source code root. The Redfish Interoperability Profile is a JSON document written in a particular format that serves two purposes:

  • It enables the creation of a human-readable document that merges the profile requirements with the Redfish schema into a single document for developers or users.
  • It allows a conformance test utility to test a Redfish Service implementation for conformance with the profile.

The JSON document structure is intended to align easily with JSON payloads retrieved from Redfish Service implementations, to allow for easy comparisons and conformance testing. Many of the properties defined within this structure have assumed default values that correspond with the most common use case, so that those properties can be omitted from the document for brevity.

Validation of Profiles using DMTF tool

An open source utility has been created by the Redfish Forum to verify that a Redfish Service implementation conforms to the requirements included in a Redfish Interoperability Profile. The Redfish Interop Validator is available for download from the DMTF's organization on Github at https://github.com/DMTF/Redfish-Interop-Validator. Refer to instructions in README on how to configure and run validation.