commit | 5064a25bc6d64424d716652c10f4fce953e0991a | [log] [tgz] |
---|---|---|
author | Myung Bae <myungbae@us.ibm.com> | Fri Oct 04 09:34:25 2024 -0700 |
committer | Ed Tanous <ed@tanous.net> | Fri Dec 06 21:53:00 2024 +0000 |
tree | 1e82c65258e53a699b8a6de23301a6dfe9c917b9 | |
parent | 06b71375b21fedf20c189965cb4e6925dfcbb044 [diff] |
Add Persistent Heartbeat subscription properties This adds Heartbeat parameters to subscriptions so that the future heartbeat implementation can use those parameters specified by the schema [1][2][3]. - SendHeartbeat - HeartbeatIntervalMinutes Tested: 1. POST Subscription - Create a subscription (e.g. via Redfish-Event-Listener) or like ``` curl -k -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/EventService/Subscriptions \ -d '{ "Context": "Public", "DeliveryRetryPolicy": "TerminateAfterRetries", "Destination": "https://DESTINATION-IPADDR/Redfish-Evt-Listener", "EventFormatType": "Event", "HeartbeatIntervalMinutes": 2, "HttpHeaders": [], "MessageIds": [], "MetricReportDefinitions": [], "Protocol": "Redfish", "RegistryPrefixes": [], "ResourceTypes": [], "SendHeartbeat": true, "SubscriptionType": "RedfishEvent", "VerifyCertificate": true }' ``` 2. GET the subscription and check the content ``` SUBID=<id> curl -k -X GET https://${bmc}/redfish/v1/EventService/Subscriptions/${SUBID} ``` 3. PATCH Subscription - PATCH with various SendHeartbeat & HeartbeatIntervalMinutes For example, ``` curl -k -X PATCH https://${bmc}/redfish/v1/EventService/Subscriptions/${SUBID} \ -H "Content-Type: application/json" \ -d '{"SendHeartbeat":true, "HeartbeatIntervalMinutes":10}' ``` - Restart bmcweb or reboot BMC - Get the subscription data and see whether the heartbeat properties are persistent. 4. Redfish Validator Service passes [1] https://github.com/openbmc/bmcweb/blob/d109e2b60f7bb367dc8115475c6cb86bca6e1914/redfish-core/schema/dmtf/json-schema/EventDestination.v1_15_0.json#L356 [2] https://github.com/openbmc/bmcweb/blob/d109e2b60f7bb367dc8115475c6cb86bca6e1914/redfish-core/schema/dmtf/json-schema/EventDestination.v1_15_0.json#L222 [3] https://www.dmtf.org/sites/default/files/standards/documents/DSP2046_2022.3.html Change-Id: I9e7feadb2e851ca320147df2231f65ece58ddf25 Signed-off-by: Myung Bae <myungbae@us.ibm.com>
This component attempts to be a "do everything" embedded webserver for OpenBMC.
The webserver implements a few distinct interfaces:
bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.
Bmcweb supports multiple authentication protocols:
Each of these types of authentication is able to be enabled or disabled both via runtime policy changes (through the relevant Redfish APIs) or via configure time options. All authentication mechanisms supporting username/password are routed to libpam, to allow for customization in authentication implementations.
All authorization in bmcweb is determined at routing time, and per route, and conform to the Redfish PrivilegeRegistry.
*Note: Non-Redfish functions are mapped to the closest equivalent Redfish privilege level.
bmcweb is configured per the meson build files. Available options are documented in meson_options.txt
meson setup builddir ninja -C builddir
If any of the dependencies are not found on the host system during configuration, meson will automatically download them via its wrap dependencies mentioned in bmcweb/subprojects
.
bmcweb relies on some on-system data for storage of persistent data that is internal to the process. Details on the exact data stored and when it is read/written can seen from the persistent_data
namespace.
When SSL support is enabled and a usable certificate is not found, bmcweb will generate a self-signed a certificate before launching the server. Please see the bmcweb source code for details on the parameters this certificate is built with.
bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.