hirte-agent.conf(5)

📦 version 0.4.0, in epel 9

🦋 hirte-agent.conf(5) 🦋

okay so this is a page from the File Formats Manual — hi bestie, welcome to the hirte-agent config glow-up ✨

🌸 NAME 🌸

agent.conf — the config file that bootstraps hirte-agent. that's it, that's the vibe 💅

✨ DESCRIPTION ✨

it's literally the basic file definition used to bootstrap hirte-agent. no cap, that's the whole description. main character energy 🎀

💜 Format 💜

the hirte-agent config file is using the systemd configuration file format ⟨https://www.freedesktop.org/software/systemd/man/systemd.syntax.html⟩ — so if you already know systemd syntax, you're so set, iykyk 🫶

🍓 hirte-agent section 🍓

all the fields to bootstrap the hirte-agent live inside the hirte-agent section. here's every key that hirte-agent understands, no gatekeeping 👑

⭐ NodeName (string) ⭐

the unique name of this agent. the option defaults to the system's hostname. cute, it just Knows 🧚

🔥 ManagerAddress (string) 🔥

SD Bus address used by hirte-agent to connect to hirte. see man sd_bus_set_address for its format. this overrides any setting of ManagerHost or ManagerPort defined in the configuration file, and the respective CLI options — yeah, it's that girl, she wins every argument 💅 the option doesn't have a default value.

🦋 ManagerHost (string) 🦋

the host used by hirte-agent to connect to hirte. must be a valid IPv4 or IPv6. ManagerHost defaults to localhost 127.0.0.1. it's mandatory to set this field if the hirte agent is on a remote system — like, don't skip this one bestie 😭

🌈 ManagerPort (uint16_t) 🌈

the port on which hirte is listening for connection request and the hirte-agent is connecting to. by default port 842 is used 🎀

💖 HeartbeatInterval (long) 💖

the interval between two heartbeat signals sent to hirte, in milliseconds. this option will overwrite the heartbeat interval defined in the configuration file. so many heartbeats, so little time 💓

👑 LogLevel (string) 👑

the level used for logging. supported values are:

  • DEBUG
  • INFO
  • WARN
  • ERROR

by default INFO level is used for logging. a reasonable queen 👑

🌸 LogTarget (string) 🌸

the target where logs are written to. supported values are:

  • stderr
  • stderr-full
  • journald

by default journald is used as the target 📓

💀 LogIsQuiet (string) 💀

if this flag is set to true, no logs are written by hirte. by default the flag is set to false. silence is golden, but honestly defaulting to logs is the correct call 🫶

🧚 Example 🧚

using ManagerHost and ManagerPort options:

[hirte-agent]
NodeName=agent-007
ManagerHost=127.0.0.1
ManagerPort=842
LogLevel=DEBUG
LogTarget=journald
LogIsQuiet=false

using ManagerAddress option:

[hirte-agent]
NodeName=agent-007
ManagerAddress=tcp:host=127.0.0.1,port=842
LogLevel=DEBUG
LogTarget=journald
LogIsQuiet=false

see how ManagerAddress just slid in there and did the whole host+port thing in one line? obsessed 😌

🎀 FILES 🎀

distributions provide the /usr/share/hirte/config/agent.conf file which defines hirte-agent configuration defaults. administrators can copy this file to /etc/hirte/agent.conf and specify their own configuration. literally copy-paste-and-edit, the og workflow 💖

administrators can also use a "drop-in" directory /etc/hirte/agent.conf.d to drop their configuration changes. drop-in dirs are such a slay 🦋

⭐ SEE ALSO ⭐

and that's the page!! this one's from the File Formats Manual, titled hirte-agent.conf(5) — no date on this one, she's timeless 💅 bye bestie, go configure something iconic 🌈✨

📦 where this page comes from