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
This commit is contained in:
parent
4d66609e95
commit
b70b4180f9
@ -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
|
this may be sign of an unexpected condition, and please consider
|
||||||
contacting the Ironic developer community for assistance.
|
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/
|
.. _Redfish: http://redfish.dmtf.org/
|
||||||
.. _Sushy: https://opendev.org/openstack/sushy
|
.. _Sushy: https://opendev.org/openstack/sushy
|
||||||
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
|
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
|
||||||
|
@ -5,13 +5,14 @@
|
|||||||
"ProfileName": "OpenStackIronicProfile",
|
"ProfileName": "OpenStackIronicProfile",
|
||||||
"ProfileVersion": "1.0.0",
|
"ProfileVersion": "1.0.0",
|
||||||
"Purpose": "Specifies the OpenStack Ironic vendor-independent Redfish service requirements, typically offered by a baseboard management controller (BMC).",
|
"Purpose": "Specifies the OpenStack Ironic vendor-independent Redfish service requirements, typically offered by a baseboard management controller (BMC).",
|
||||||
"OwningEntity": "Dell Inc.",
|
"OwningEntity": "Ironic community",
|
||||||
"ContactInfo": "michael.raineri@dell.com, aija.jaunteva@dell.com",
|
"ContactInfo": "openstack-discuss@lists.openstack.org",
|
||||||
"Protocol": {
|
"Protocol": {
|
||||||
"MinVersion": "1.6.0"
|
"MinVersion": "1.6.0"
|
||||||
},
|
},
|
||||||
"Resources": {
|
"Resources": {
|
||||||
"Bios": {
|
"Bios": {
|
||||||
|
"ReadRequirement": "Recommended",
|
||||||
"PropertyRequirements": {
|
"PropertyRequirements": {
|
||||||
"Attributes": {}
|
"Attributes": {}
|
||||||
},
|
},
|
||||||
@ -24,7 +25,9 @@
|
|||||||
"AssetTag": {
|
"AssetTag": {
|
||||||
"ReadRequirement": "Recommended"
|
"ReadRequirement": "Recommended"
|
||||||
},
|
},
|
||||||
"Bios": {},
|
"Bios": {
|
||||||
|
"ReadRequirement": "Recommended"
|
||||||
|
},
|
||||||
"BiosVersion": {
|
"BiosVersion": {
|
||||||
"ReadRequirement": "Recommended"
|
"ReadRequirement": "Recommended"
|
||||||
},
|
},
|
||||||
@ -56,7 +59,8 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"IndicatorLED": {
|
"IndicatorLED": {
|
||||||
"WriteRequirement": "Mandatory",
|
"WriteRequirement": "Recommended",
|
||||||
|
"ReadRequirement": "Recommended",
|
||||||
"MinSupportValues": [
|
"MinSupportValues": [
|
||||||
"Lit",
|
"Lit",
|
||||||
"Off",
|
"Off",
|
||||||
@ -69,6 +73,9 @@
|
|||||||
"ManagedBy": {}
|
"ManagedBy": {}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"Manufacturer": {
|
||||||
|
"ReadRequirement": "Recommended"
|
||||||
|
},
|
||||||
"MemorySummary": {
|
"MemorySummary": {
|
||||||
"PropertyRequirements": {
|
"PropertyRequirements": {
|
||||||
"TotalSystemMemoryGiB": {}
|
"TotalSystemMemoryGiB": {}
|
||||||
|
@ -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
|
|
Loading…
x
Reference in New Issue
Block a user