openstack/ironic
Code Issues Proposed changes

Follow-up to Redfish Interop Profile

Browse Source 
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
This commit is contained in:
Aija Jauntēva 2022-11-30 12:02:35 -05:00
parent 4d66609e95
commit b70b4180f9
3 changed files with 42 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/admin/drivers/redfish.rst
View File

@ -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

15
redfish-interop-profiles/OpenStackIronicProfile.v1_0_0.json
View File

@ -5,13 +5,14 @@
"ProfileName": "OpenStackIronicProfile",
"ProfileVersion": "1.0.0",
"Purpose": "Specifies the OpenStack Ironic vendor-independent Redfish service requirements, typically offered by a baseboard management controller (BMC).",
"OwningEntity": "Dell Inc.",
"ContactInfo": "michael.raineri@dell.com, aija.jaunteva@dell.com",
"OwningEntity": "Ironic community",
"ContactInfo": "openstack-discuss@lists.openstack.org",
"Protocol": {
"MinVersion": "1.6.0"
},
"Resources": {
"Bios": {
"ReadRequirement": "Recommended",
"PropertyRequirements": {
"Attributes": {}
},
@ -24,7 +25,9 @@
"AssetTag": {
"ReadRequirement": "Recommended"
},
"Bios": {},
"Bios": {
"ReadRequirement": "Recommended"
},
"BiosVersion": {
"ReadRequirement": "Recommended"
},
@ -56,7 +59,8 @@
}
},
"IndicatorLED": {
"WriteRequirement": "Mandatory",
"WriteRequirement": "Recommended",
"ReadRequirement": "Recommended",
"MinSupportValues": [
"Lit",
"Off",
@ -69,6 +73,9 @@
"ManagedBy": {}
}
},
"Manufacturer": {
"ReadRequirement": "Recommended"
},
"MemorySummary": {
"PropertyRequirements": {
"TotalSystemMemoryGiB": {}

37
redfish-interop-profiles/README.rst
View File

@ -1,37 +0,0 @@
=================================
Redfish Interoperability Profile
=================================
Overview
--------
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.
Reference
---------
https://github.com/DMTF/Redfish-Interop-Validator