bmcweb/docs/AGGREGATION.md

4 satellite BMCs. Aggregated resources are accessed in the same way as local
8 The satellite BMCs are not aware that they are being aggregated. The aggregating
10 satellite BMCs to be observable as a singular combined BMC.
21 In addition to the compiler option, bmcweb requires a satellite config to be
23 satellite BMC. The following is an example entity-manager json config for a
24 satellite located at 160.80.40.20:80
39 Note that the satellite config must specify a hostname, port, and authentication
41 reject satellite configs that do not comply with these requirements.
43 ## Satellite BMC Restrictions
45 - HTTP only connection to satellite BMC
46 - No authentication on satellite BMC
47 - Each satellite BMC must have a unique "Name" property in its configuration
68 Similarly, we do not aggregate any satellite `$metadata` which is available at
70 aggregating BMC is compatible with all aggregated satellite resources.
75 resources on the satellite BMC, but a link for the unsupported collection will
82 prefix is derived from the "Name" property specified in the satellite BMC's
84 for each satellite BMC.
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"`,
99 aggregating BMC. In addition, the request is forwarded to the satellite BMCs as
107 If the responses from the satellite responses do not contain a "Members" array
110 aggregating BMC. Similarly, we ignore any satellite responses that do not return
139 When the request is for a singular satellite resource instead of a top level
150 1. Determine the target satellite BMC based on the prefix
152 3. Forward the request to the satellite BMC
154 5. Return the updated response from the satellite BMC
169 We consider any response to be a valid response code from the satellite BMC. The
182 1. Add links to satellite only collections in responses from service root and
184 2. Support HTTPS connection to satellite BMC
192 2. Support Authentication with satellite BMCs