diff options
| author | Aija Jauntēva <aija.jaunteva@dell.com> | 2022-11-30 12:02:35 -0500 |
|---|---|---|
| committer | Aija Jauntēva <aija.jaunteva@dell.com> | 2022-11-30 12:08:56 -0500 |
| commit | b70b4180f970c272f56a5318f4baa0d056d6c81e (patch) | |
| tree | 63fc557f2e54175ada171fd142a66c9625fca775 /doc/source/admin/drivers/redfish.rst | |
| parent | 4d66609e95a1c7f5fb0fe0f61f95cf83d09da4d8 (diff) | |
| download | ironic-b70b4180f970c272f56a5318f4baa0d056d6c81e.tar.gz | |
Follow-up to Redfish Interop Profile
Follow-up to change I058ceadab33f6969157b89aca5ba34ebd0be2a93
to mark some properties recommended, move documentation
and update contact information.
Co-Authored-By: Mike Raineri <michael.raineri@gmail.com>
Change-Id: I493f9402e15fa78bc5dae9d9bcbb124146f0d026
Diffstat (limited to 'doc/source/admin/drivers/redfish.rst')
| -rw-r--r-- | doc/source/admin/drivers/redfish.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/source/admin/drivers/redfish.rst b/doc/source/admin/drivers/redfish.rst index eb1f561f4..063dd1fe5 100644 --- a/doc/source/admin/drivers/redfish.rst +++ b/doc/source/admin/drivers/redfish.rst @@ -670,6 +670,37 @@ from scratch. If this is due to any persistent connectivity issue, this may be sign of an unexpected condition, and please consider contacting the Ironic developer community for assistance. +Redfish Interoperability Profile +================================ + +Ironic projects provides 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. + + .. _Redfish: http://redfish.dmtf.org/ .. _Sushy: https://opendev.org/openstack/sushy .. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security |