Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / cd5a898fd4007212ce9e58ea9443071da494452e
commitcd5a898fd4007212ce9e58ea9443071da494452e[log] [tgz]
authorJanet Adkins <janeta@us.ibm.com>Wed Aug 14 09:28:29 2024 -0500
committerEd Tanous <ed@tanous.net>Fri Sep 13 21:54:54 2024 +0000
treea66e92f9206b485121350afc469f02535cc14db0
parent77dcace654b2a2627de56fb7b98d29172a2b55fb [diff]
Sensors: Add SpeedRPM property

Changes here are to add support for Redfish for Thermal Equipment[1].

Add the SpeedRPM property for a Rotational fan sensor. This property is
part of the Redfish Sensor schema since version 1_2_0.[2]

This change is so we will always have a property with the RPM. This
allows a client (e.g. webui-vue) to always look for the SpeedRPM
property.

Note: Redfish defines the Reading property for a fan to be a
percentage value. Currently for this type of fan sensor the Reading
value is being set to the RPM value. To preserve backwards
compatibility the SpeedRPM property is added without altering the
Reading value. However this may change in the future to match the
expected Redfish implementation. Clients are advised to use the new
SpeedRPM value to assure continuing correct function.

[1] https://www.dmtf.org/sites/default/files/standards/documents/DSP2064_1.0.0.pdf
[2] http://redfish.dmtf.org/schemas/v1/Sensor.v1_10_0.json#/definitions/Sensor

Implementation Note: The objectPropertiesToJson() has existing  else
if(sensorType ==) statements. However because the first if()
statement is looking at the chassisSubNode these are never visited for
sensors when using the
/redfish/v1/Chassis/<chassisId>/Sensors/<sensorName> URI.
Those existing sensorType comparisons are used for the
redfish-allow-deprecated-power-thermal Redfish interfaces.

```
$ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/Chassis/chassis/Sensors/fantach_fan1_0
{
  "@odata.id": "/redfish/v1/Chassis/chassis/Sensors/fantach_fan1_0",
  "@odata.type": "#Sensor.v1_2_0.Sensor",
  "Id": "fantach_fan1_0",
  "Name": "fan1 0",
  "Reading": 18000.0,
  "ReadingType": "Rotational",
  "ReadingUnits": "RPM",
  "SpeedRPM": 18000.0,
  "Status": {
    "Health": "OK",
    "State": "Enabled"
  }
}
```

Tested:
- Redfish Validator passes

Change-Id: Icd39fd70d4a24aafab0d9b66fa09c000b97b3199
Signed-off-by: Janet Adkins <janeta@us.ibm.com>
2 files changed
tree: a66e92f9206b485121350afc469f02535cc14db0
  1. .github/
  2. config/
  3. http/
  4. include/
  5. redfish-core/
  6. scripts/
  7. src/
  8. static/
  9. subprojects/
  10. test/
  11. .clang-format
  12. .clang-tidy
  13. .codespell-ignore
  14. .dockerignore
  15. .eslintignore
  16. .gitignore
  17. .markdownlint.yaml
  18. .openbmc-enforce-gitlint
  19. .prettierignore
  20. .shellcheck
  21. AGGREGATION.md
  22. CLIENTS.md
  23. COMMON_ERRORS.md
  24. DBUS_USAGE.md
  25. DEVELOPING.md
  26. HEADERS.md
  27. LICENSE
  28. meson.build
  29. meson.options
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. README.md
  33. Redfish.md
  34. REDFISH_CHECKLIST.md
  35. run-ci
  36. TESTING.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for OpenBMC.

Features

The webserver implements a few distinct interfaces:

  • DBus event websocket. Allows registering on changes to specific dbus paths, properties, and will send an event from the websocket if those filters match.
  • OpenBMC DBus REST api. Allows direct, low interference, high fidelity access to dbus and the objects it represents.
  • Serial: A serial websocket for interacting with the host serial console through websockets.
  • Redfish: A protocol compliant, DBus to Redfish translator.
  • KVM: A websocket based implementation of the RFB (VNC) frame buffer protocol intended to mate to webui-vue to provide a complete KVM implementation.

Protocols

bmcweb at a protocol level supports http and https. TLS is supported through OpenSSL.

AuthX

Authentication

Bmcweb supports multiple authentication protocols:

  • Basic authentication per RFC7617
  • Cookie based authentication for authenticating against webui-vue
  • Mutual TLS authentication based on OpenSSL
  • Session authentication through webui-vue
  • XToken based authentication conformant to Redfish DSP0266

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.

Authorization

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.

Configuration

bmcweb is configured per the meson build files. Available options are documented in meson_options.txt

Compile bmcweb with default options

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.

Use of persistent data

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.

TLS certificate generation

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.

Redfish Aggregation

bmcweb is capable of aggregating resources from satellite BMCs. Refer to AGGREGATION.md for more information on how to enable and use this feature.