Skip to content

Commit 93f1fc8

Browse files
committed
Make OpenRMC spec compatible with tcg-pandoc.
To build: First clone [ocp-spec-tools](https://github.com/opencomputeproject/ocp-spec-tools/), and then run: ``` $ path/to/ocp-spec-tools/ocp-docker-pull.sh $ path/to/ocp-spec-tools/ocp-docker-run.sh --pdf OpenRMC_UsageGuide_v1.2.pdf OpenRMC_UsageGuide_v1.2.ocp ``` The following metadata fields are not currently respected by ocp-spec-tools: - `supersedes` - `status` - `released` - `class` - `copyright` - `paragraph_numbering` Signed-off-by: Jeff Andersen <jeffandersen@google.com>
1 parent c088747 commit 93f1fc8

File tree

3 files changed

+47
-32
lines changed

3 files changed

+47
-32
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
references:
2+
- id: "openrmc-design-specification"
3+
title: "OpenRMC Design Specification"
4+
publisher: "Open Compute Project"
5+
url: "http://www.opencompute.org"
6+
- id: "ocp-baseline-hw-management-profile"
7+
title: "Usage Guide and Requirements for the OCP Baseline Hardware Management Profile v1.0.1"
8+
publisher: "Open Compute Project"
9+
url: "https://www.opencompute.org/documents/usage-guide-for-baseline-hw-mgmt-api-v1-0-1-final-pdf"
10+
- id: redfish-firmware-update
11+
title: "Redfish Firmware Update White Paper"
12+
publisher: "Distributed Management Task Force"
13+
url: "https://www.dmtf.org/sites/default/files/standards/documents/DSP2062_1.0.0.pdf"
14+
- id: redfish-api-specification
15+
title: "Redfish API Specification"
16+
publisher: "Distributed Management Task Force"
17+
url: "https://www.dmtf.org/dsp/DSP0266"
18+
- id: redfish-certificate-whitepaper
19+
title: "Redfish Certificate Whitepaper"
20+
publisher: "Distributed Management Task Force"
21+
url: "https://www.dmtf.org/sites/default/files/standards/documents/DSP2059_1.1.0.pdf"

RackManager/OpenRMC_UsageGuide_v1.2.dsp.cfg

Lines changed: 0 additions & 14 deletions
This file was deleted.

RackManager/OpenRMC_UsageGuide_v1.2.md renamed to RackManager/OpenRMC_UsageGuide_v1.2.ocp

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
---
2+
project: Hardware Management
3+
title: Usage Guide for Rack Management
4+
version: 1.2.0
5+
supersedes: 1.1.0
6+
status: draft
7+
released: true
8+
class: info
9+
date: 2025-03-20
10+
copyright: 2023-2025
11+
paragraph_numbering: no
12+
bibliography: OpenRMC_UsageGuide_v1.2.bibliography.yaml
13+
...
14+
15+
---
16+
17+
\tableofcontents
18+
19+
---
20+
121
# License
222

323
This work is licensed under a [Creative Commons Attribution-ShareAlike
@@ -116,7 +136,7 @@ The response contains the following fragment. The fragment shows the URI for the
116136

117137
The fragment shows two actions that can be perform on an aggregate, either temporary or persistent.
118138
The action is invoke by performing a POST to the URI contained in Target property.
119-
The contents of the request body in desribed in resource whose URI is contained in the @Redfish.ActionInfo property.
139+
The contents of the request body in desribed in resource whose URI is contained in the \@Redfish.ActionInfo property.
120140

121141
```
122142
{
@@ -133,19 +153,19 @@ The contents of the request body in desribed in resource whose URI is contained
133153
"Actions": {
134154
"#AggregationService.Reset": {
135155
"target": "/redfish/v1/AggregationService/Actions/AggregationService.Reset",
136-
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/ResetActionInfo"
156+
"\@Redfish.ActionInfo": "/redfish/v1/AggregationService/ResetActionInfo"
137157
},
138158
"#AggregationService.SetDefaultBootOrder": {
139159
"target": "/redfish/v1/AggregationService/Actions/AggregationService.SetDefaultBootOrder",
140-
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/SetDefaultBootOrderActionInfo"
160+
"\@Redfish.ActionInfo": "/redfish/v1/AggregationService/SetDefaultBootOrderActionInfo"
141161
}
142162
}
143163
}
144164
```
145165

146166
## Update Firmware
147167

148-
The firmware can be updated with a pull or push method. The "Redfish Firmware Update Whitepaper"\[3\] has detail discussion of the firmware update process.
168+
The firmware can be updated with a pull or push method. The "Redfish Firmware Update Whitepaper" [@{redfish-firmware-update}] has detail discussion of the firmware update process.
149169

150170
The main process is for the firmware package to be delivered opaquely, and the Redfish Service interprets the firmware package to determine the components that are updated.
151171
The Targets property can be used to guide and constrain this behavior.
@@ -752,7 +772,7 @@ To perform a reset of the group, a POST is invoked to the value of the Target pr
752772
POST /redfish/v1/AggregationService/Actions/Aggregate.Reset
753773

754774
The POST request shall contain a request body. The contents of the request body are described by resource specified by the
755-
@Reddfish.ActionInfo property. The TargetURIs property specifies the group to be used.
775+
\@Reddfish.ActionInfo property. The TargetURIs property specifies the group to be used.
756776
After the group is used, it is forgotten.
757777

758778
```
@@ -1109,7 +1129,7 @@ it.
11091129
- **Managed Node List =** Node Certificate + Time Stamp of Initial
11101130
session establishment
11111131

1112-
> In the Redfish Certificate Management Whitepaper \[1\], the node
1132+
> In the Redfish Certificate Management Whitepaper [@{redfish-certificate-whitepaper}], the node
11131133
> certificate and rack manager certificate are referred to as device
11141134
> identity certificates.
11151135

@@ -1247,18 +1267,6 @@ Reason for Classification
12471267
| | | | | | Other node managers do not have node’s token (encrypted during transit) |
12481268
| 9 | A rogue rack manager attempts to reply legitimate encrypted rack manager’s token | Network Adversary | End User’s Data | H | In discovery flow, node decrypts rack manager’s token and checks the cert in token with the cert that rogue rack manager passes down early in discovery flow. Discrepancy leads to the fact that node logs “Suspicious Node Manger” event (no session will get establish). |
12491269

1250-
# References
1251-
1252-
\[1\] "[OpenRMC Design Specification](http://www.opencompute.org/)"
1253-
1254-
\[2\] Usage Guide and Requirements for the OCP Baseline Hardware Management Profile v1.0.1
1255-
1256-
\[3\] "[Redfish Firmware Update White Paper](https://www.dmtf.org/sites/default/files/standards/documents/DSP2062_1.0.0.pdf)"
1257-
1258-
\[4\] "[Redfish API Specification](https://www.dmtf.org/dsp/DSP0266)"
1259-
1260-
\[5\] "[Redfish Certificate Whitepaper](https://www.dmtf.org/sites/default/files/standards/documents/DSP2059_1.1.0.pdf)"
1261-
12621270
# Revision
12631271

12641272
| Revision/Version | Date | Description |

0 commit comments

Comments
 (0)