michi/compute-blade-agent
1
0
Fork 0
mirror of https://github.com/compute-blade-community/compute-blade-agent.git synced 2026-04-21 17:45:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: smart fan unit improvements (#31)

Browse Source 
* fix: load config from /etc/computeblade-agent

Signed-off-by: Matthias Riegler <matthias.riegler@ankorstore.com>

* fix: fan target percent reporting

Signed-off-by: Matthias Riegler <matthias.riegler@ankorstore.com>

* fix: fancontroller default config & update interval

Signed-off-by: Matthias Riegler <matthias.riegler@ankorstore.com>

* chore: update Readme

Signed-off-by: Matthias Riegler <matthias.riegler@ankorstore.com>

---------

Signed-off-by: Matthias Riegler <matthias.riegler@ankorstore.com>
This commit is contained in:
Matthias Riegler
2023-11-25 11:10:12 +01:00
committed by GitHub
parent 99920370fb
commit a8d470d4f9
8 changed files with 36 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.goreleaser.yaml
View File

@@ -81,7 +81,7 @@ nfpms:
dst: /etc/systemd/system/computeblade-agent.service
- src: ./cmd/agent/default-config.yaml
dst: /etc/computeblade-agent/config.yaml
type: config|noreplace
type: config
- src: ./fanunit.uf2
dst: /usr/share/computeblade-agent/fanunit.uf2

54
README.md
View File

@@ -1,11 +1,10 @@
# computeblade-agent
> :warning: this is still a beta-release & configuration&APIs might see breaking changes! It's not 100% feature complete yet but works
The `computeblade-agent` is an OS agent interfacing with the [ComputeBlade](http://computeblade.com) hardware.
It controls fan speed, LEDs and handles common events e.g. to _identify_/find an individual blade in a server rack.
In addition, it exposes hardware- and agent-related metrics on a [Prometheus](http://prometheus.io) endpoint.
> :warning: **Beta Release**: This software is currently in beta, and both configurations and APIs may undergo breaking changes. It is not yet 100% feature complete, but it functions as intended.
**TL;DR, I just want it running on my blade script**:
The `computeblade-agent` serves as an operating system agent interfacing with [ComputeBlade](http://computeblade.com) hardware. It takes charge of fan speed, LEDs, and manages common events, such as identifying or locating an individual blade in a server rack. Additionally, it exposes hardware- and agent-related metrics on a [Prometheus](http://prometheus.io) endpoint.
**Quick Setup with TL;DR**:
```bash
curl -L -o /tmp/computeblade-agent-installer.sh https://raw.githubusercontent.com/Uptime-Lab/computeblade-agent/main/hack/autoinstall.sh
chmod +x /tmp/computeblade-agent-installer.sh
@@ -15,47 +14,40 @@ chmod +x /tmp/computeblade-agent-installer.sh
## Components
### computeblade-agent
The agent is an event-loop handler that's reacting on system events such as button presses and temperature changes.
It also exposes a prometheus endpoint allowing monitoring of core-metrics such as PoE status.
This event-loop handler responds to system events, such as button presses and temperature changes. It offers a Prometheus endpoint for monitoring core metrics, including Power over Ethernet (PoE) status.
By default, the computeblade agent runs in _normal_ operation mode; the LEDs are static and fanspeed is set based on the configuration.
In case the SoC temperature raises above a predefined level, the _critical_ mode is active and sets the fan-speed to 100% alongside changing the LED color (Red by default)
Aside from the above mentioned normal and critical modes, the _identify_ action (independend of the mode), which lets the edge LED blink.
This can be toggled using `bladectl` on the blade (`bladectl identify`) or by pressing the edge button.
In normal operation mode, the agent maintains static LEDs and fan speed based on the configuration. If the System on Chip (SoC) temperature exceeds a predefined level, the critical mode is activated, setting the fan speed to 100% and changing the LED color to red. The _identify_ action, independent of the mode, makes the edge LED blink. This can be toggled using `bladectl` on the blade (`bladectl identify`) or by pressing the edge button (or smart fan unit button).
### Smart Fan Unit Firmware
This firmware controls fan speed and LEDs on the fan unit using a UART-based protocol with agents running on the blades. It reports metrics (fan RPM and airflow temperature) regularly to the blades and forwards button presses (1x -> left blade, 2x -> right blade). The fan unit determines the highest requested fan speed, configuring the fan control chip on the board. Advanced functionalities, such as airflow-based fan curve control, are possible with the EMC2101 chip on the smart fan unit, currently implemented in software on the agent side.
### bladectl - interacting with the agent
The bladectl interacts with the blade-local API exposed by the computeblade-agent.
You can e.g. identify the blade in a rack using `bladectl identify --wait`, which will block & make the edge-LED blink until the button is pressed.
`bladectl` interacts with the blade-local API exposed by the computeblade-agent. For instance, you can identify the blade in a rack using `bladectl identify --wait`, which blocks and makes the edge LED blink until the button is pressed.
## Installation Options
## Install Options
The agent and `bladectl` are available as packages for Debian, RPM, and ArchLinux or as an OCI image to run within Docker/Kubernetes. Packages include a systemd unit, which can be enabled using `systemd enable computeblade-agent.service --now`.
The agent and bladectl are provided as package for Debian, RPM and ArchLinux or as OCI image to run within docker/Kubernetes.
Packages ship with a systemd unit which can be enabled using `systemd enable computeblade-agent.service --now`.
`bladectl` is available globally, but has to be executed as root since the socket (default `/tmp/computeblade-agent.sock`) does not have a user/group accessed due to privileged access on critical resources.
**Kubernetes deployment**:
A kustomize environment can be found in `hack/deploy`. A `kubectl -k hack/deploy` does the trick - or use a GitOps tool such as FluxCD.
For global access, `bladectl` requires root privileges since the socket (default `/tmp/computeblade-agent.sock`) does not have user/group access due to privileged access to critical resources.
<!-- WIP
**Kubernetes Deployment**:
A Kustomize environment can be found in `hack/deploy`. Use `kubectl -k hack/deploy` or employ a GitOps tool like FluxCD.
-->
## Configuration
The configuration is driven by a config file or environment variables. Linux packages ship with the default configuration placed in `/etc/computeblade-agent/config.yaml`.
Alternatively (specifically for running within Kubernetes), all parameters in the YAML configuration can be overwritten using environment variables, prefixed with `BLADE_`:
Configuration can be driven by a config file or environment variables. Linux packages ship with the default configuration in `/etc/computeblade-agent/config.yaml`. Alternatively, especially for Kubernetes, all parameters in the YAML configuration can be overwritten using environment variables prefixed with `BLADE_`.
Changing the metric address defined in YAML like this:
For example, changing the metric address defined in YAML:
```yaml
# Listen configuration
listen:
metrics: ":9666"
```
is driven by the environment variable `BLADE_LISTEN_METRICS=":1234"`.
can be achieved with the environment variable `BLADE_LISTEN_METRICS=":1234"`.
Some useful parameters:
- `BLADE_STEALTH_MODE=false` Enables/disables stealth mode
- `BLADE_FAN_SPEED_PERCENT=80` Sets static fan-speed (by default, there's a linear fan-curve of 40-80%
- `BLADE_CRITICAL_TEMPERATURE_THRESHOLD=60` Configures critical temperature threshold of the agent
- `BLADE_HAL_BCM2711_DISABLE_FANSPEED_MEASUREMENT=false` enables/disables fan speed measnurement (disabling it reduces CPU load of the agent)
- `BLADE_STEALTH_MODE=false`: Enables/disables stealth mode.
- `BLADE_FAN_SPEED_PERCENT=80`: Sets static fan speed (by default, there's a linear fan curve of 40-80%).
- `BLADE_CRITICAL_TEMPERATURE_THRESHOLD=60`: Configures the critical temperature threshold of the agent.
- `BLADE_HAL_RPM_REPORTING_STANDARD_FAN_UNIT=false`: Enables/disables fan speed measurement (disabling it reduces CPU load of the agent).

4
cmd/agent/default-config.yaml
View File

@@ -41,8 +41,8 @@ fan_controller:
# For now, this is only supporting a two-step configuration.
steps:
- temperature: 45
speed: 40
percent: 40
- temperature: 55
speed: 80
percent: 80
# Critical temperature threshold
critical_temperature_threshold: 60

15
cmd/agent/main.go
View File

@@ -1,7 +1,6 @@
package main
import (
"bytes"
"context"
"fmt"
"net"
@@ -14,8 +13,6 @@ import (
"syscall"
"time"
_ "embed"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/spf13/viper"
bladeapiv1alpha1 "github.com/xvzf/computeblade-agent/api/bladeapi/v1alpha1"
@@ -25,22 +22,22 @@ import (
"google.golang.org/grpc"
)
// embed default configuration
//go:embed default-config.yaml
var defaultConfig []byte
func main() {
var wg sync.WaitGroup
// Setup configuration
viper.SetConfigType("yaml")
// auto-bind environment variables
viper.SetEnvPrefix("BLADE")
viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
viper.AutomaticEnv()
viper.SetConfigName("config")
viper.SetConfigType("yaml")
viper.AddConfigPath("/etc/computeblade-agent")
// Load potential file configs
if err := viper.ReadConfig(bytes.NewBuffer(defaultConfig)); err != nil {
if err := viper.ReadInConfig(); err != nil {
panic(err)
}

2
internal/agent/agent.go
View File

@@ -389,7 +389,7 @@ func (a *computeBladeAgentImpl) runEdgeLedEngine(ctx context.Context) error {
func (a *computeBladeAgentImpl) runFanController(ctx context.Context) error {
// Update fan speed periodically
ticker := time.NewTicker(15 * time.Second)
ticker := time.NewTicker(5 * time.Second)
for {

1
pkg/hal/hal_bcm2711.go
View File

@@ -337,6 +337,7 @@ func (bcm *bcm2711) setPwm0Freq(targetFrequency uint64) error {
// SetFanSpeed sets the fanspeed of a blade in percent (standard fan unit)
func (bcm *bcm2711) SetFanSpeed(speed uint8) error {
fanTargetPercent.Set(float64(speed))
return bcm.fanUnit.SetFanSpeedPercent(context.TODO(), speed)
}

1
pkg/hal/hal_bcm2711_simulated.go
View File

@@ -43,7 +43,6 @@ func (m *SimulatedHal) Close() error {
func (m *SimulatedHal) SetFanSpeed(percent uint8) error {
m.logger.Info("SetFanSpeed", zap.Uint8("percent", percent))
fanSpeedTargetPercent.Set(float64(percent))
fanSpeed.Set(2500 * (float64(percent) / 100))
return nil
}

4
pkg/hal/metrics.go
View File

@@ -7,9 +7,9 @@ import (
)
var (
fanSpeedTargetPercent = promauto.NewGauge(prometheus.GaugeOpts{
fanTargetPercent = promauto.NewGauge(prometheus.GaugeOpts{
Namespace: "computeblade",
Name: "fan_speed_target_percent",
Name: "fan_target_percent",
Help: "Target fanspeed in percent",
})
fanSpeed = promauto.NewGauge(prometheus.GaugeOpts{