Skip to content

Commit c48317f

Browse files
committed
Update AGGREGATION.md
1. Support multi SatMC configuration 2. Prefix generation from EM config Change-Id: If03f45ea5d88b23bd7ba6e61577b1ab177eb7fa0 Signed-off-by: Rohit PAI <ropai@nvidia.com>
1 parent 5a3d934 commit c48317f

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

AGGREGATION.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ reject satellite configs that do not comply with these requirements.
4242
4343
## Satellite BMC Restrictions
4444
45-
- Can only aggregate a single satellite BMC
4645
- HTTP only connection to satellite BMC
4746
- No authentication on satellite BMC
47+
- Each satellite BMC must have a unique "Name" property in its configuration
4848
4949
## Supported Resources
5050
@@ -79,18 +79,19 @@ not appear when querying the Service Root.
7979
8080
Aggregated resources will have a prefix appended to their URIs in order to
8181
distinguish them from resources that are local to the aggregating BMC. The
82-
aggregation prefix is planned to be derived from the uuid of the aggregating
83-
BMC. This should result in the aggregation prefix being unique to each
84-
aggregating BMC.
82+
prefix is derived from the "Name" property specified in the satellite BMC's
83+
configuration in Entity Manager. This allows for meaningful and unique prefixes
84+
for each satellite BMC.
8585
8686
The general URI format for aggregated resources is
8787
8888
```bash
89-
/redfish/v1/<resource_collection>/<prefix>_<resource_id>
89+
/redfish/v1/<resource_collection>/<name>_<resource_id>
9090
```
9191
92-
When support is added for aggregating more than one satellite BMC, then each
93-
satellite will be assigned its own unique satellite prefix.
92+
Where `<name>` is the value of the "Name" property from the satellite's
93+
configuration. For example, if a satellite is configured with `"Name": "sat0"`,
94+
its resources would appear as `/redfish/v1/Systems/sat0_system`.
9495
9596
### Aggregating Collections
9697
@@ -122,10 +123,13 @@ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems
122123
"@odata.id": "/redfish/v1/Systems/system"
123124
},
124125
{
125-
"@odata.id": "/redfish/v1/Systems/5B247A_system"
126+
"@odata.id": "/redfish/v1/Systems/sat0_system"
127+
},
128+
{
129+
"@odata.id": "/redfish/v1/Systems/sat1_system"
126130
}
127131
],
128-
"Members@odata.count": 2,
132+
"Members@odata.count": 3,
129133
"Name": "Computer System Collection"
130134
}
131135
```
@@ -150,18 +154,16 @@ The following steps are used to retrieve the requested aggregated resource:
150154
5. Return the updated response from the satellite BMC
151155
152156
```bash
153-
curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/5B247A_system
154-
{
155-
"@odata.id": "/redfish/v1/Systems/5B247A_system",
156-
...
157-
"LogServices": {
158-
"@odata.id": "/redfish/v1/Systems/5B247A_system/LogServices"
159-
},
160-
"Memory": {
161-
"@odata.id": "/redfish/v1/Systems/5B247A_system/Memory"
162-
},
163-
...
164-
}
157+
curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Systems/sat0_system
158+
{
159+
"@odata.id" :
160+
"/redfish/v1/Systems/sat0_system",
161+
... "LogServices" :
162+
{"@odata.id" : "/redfish/v1/Systems/sat0_system/LogServices"},
163+
"Memory" :
164+
{"@odata.id" : "/redfish/v1/Systems/sat0_system/Memory"},
165+
...
166+
}
165167
```
166168
167169
We consider any response to be a valid response code from the satellite BMC. The
@@ -179,9 +181,7 @@ are some features that must still be implemented before that can happen.
179181
180182
1. Add links to satellite only collections in responses from service root and
181183
other appropriate locations
182-
2. Generate aggregation prefix from uuid
183-
3. Aggregate more than one satellite BMC
184-
4. Support HTTPS connection to satellite BMC
184+
2. Support HTTPS connection to satellite BMC
185185
186186
Support for the following items should be added as well. However, their
187187
implementation is not a requirement to being able to enable Redfish aggregation

0 commit comments

Comments
 (0)