bluechi-agent(1)

📦
version 1.3.0 · 2 versions
, in fedora 43, fedora 44

💖 bluechi-agent — the girlboss of local systemd units 💖

bluechi-agent(1) — from the General Commands Manual, bestie. Pull up a chair, we're doing systemd stuff and it's gonna be adorable. 🎀

✨ NAME ✨

bluechi-agent — the agent that manages services on the local machine, aka your new favorite little helper 🫶

🌸 SYNOPSIS 🌸

bluechi-agent [options]

🦋 DESCRIPTION 🦋

Eclipse BlueChi™ is a systemd service controller, and it's literally built for multi-node environments — think a predefined number of nodes, no chaos, very curated. Its whole thing is a focus on highly regulated environments, like the ones that need functional safety (yes bestie, cars 🚗💨). So it's giving serious, responsible, main-character energy.

A bluechi-agent sets up a peer-to-peer connection to bluechi and then exposes its API so you can manage systemd units on it. That's the whole vibe. 💅

bluechi-agent [OPTIONS]

✨ OPTIONS ✨

  • --help, -h — prints the usage statement and dips out. Short, sweet, iconic. 👑
  • --host, -H — the host that bluechi-agent uses to connect to bluechi. It must be a valid IPv4 or IPv6. This option will overwrite the host defined in the configuration file. 📍
  • --port, -p — the port where bluechi is listening for connection requests and where bluechi-agent is connecting to. This option will overwrite the port defined in the configuration file. (default: 842)
  • --address, -a — the DBus address bluechi-agent uses to connect to bluechi. Peep man sd_bus_set_address for the format, iykyk. 🫶 This one overrides any setting of ControllerHost or ControllerPort defined in the configuration file, and the respective CLI options too. Like, it wins. Periodt.
  • --name, -n — the unique name of this bluechi-agent, used for registering at bluechi. This option will overwrite the port defined in the configuration file.
  • --interval, -i — the interval between two heartbeat signals sent to bluechi, in milliseconds. If an agent isn't connected, it will retry to connect on each heartbeat. Setting this option to values smaller or equal to 0 disables it. This option will overwrite the heartbeat interval defined in the configuration file. 💓
  • --config, -c — path to the configuration file, see bluechi-agent.conf(5). (default: /etc/bluechi/agent.conf)
  • --version, -v — prints the current bluechi-agent version. Slay. ✨
  • --user — connect to the user systemd instance instead of the system one. 🙈

🌈 ENVIRONMENT VARIABLES 🌈

bluechi-agent understands these environment variables, and they can be used to override the settings from the configuration file (peep bluechi-agent.conf(5)).

💜 BC_LOG_LEVEL

The level used for logging. Supported values are:

  • DEBUG
  • INFO
  • WARN
  • ERROR

💜 BC_LOG_TARGET

The target where logs are written to. Supported values are:

  • stderr
  • stderr-full
  • journald

💜 BC_LOG_IS_QUIET

If this flag is set to true, no logs are written by bluechi. 🤫 (not me being quiet for once)

💀 EXIT CODES 💀

TBD

bestie the exit codes are literally TBD. We'll know when we know. 😭

🎀 CONFIGURATION FILES 🎀

okay that's the whole page, you ate that 💅

Signing off from the bluechi-agent(1) page of the General Commands Manual — mwah, go manage those units, queen. 👑✨💖

📦 where this page comes from