1bluechi-agent.conf(5)         File Formats Manual        bluechi-agent.conf(5)
2
3
4

NAME

6       agent.conf - Configuration file to bootstrap bluechi-agent
7
8

DESCRIPTION

10       The basic file definition used to bootstrap bluechi-agent.
11
12

Format

14       The bluechi-agent configuration file is using the systemd configuration
15       file   format    ⟨https://www.freedesktop.org/software/systemd/man/sys‐
16       temd.syntax.html⟩.  Contrary to this, there is no need for the \ symbol
17       at the end of a line to continue a value on the next line. A value con‐
18       tinued on multiple lines will just be concatenated by bluechi. The max‐
19       imum line length supported is 500 characters. If the value exceeds this
20       limitation, use multiple, indented lines.
21
22
23   bluechi-agent section
24       All fields to bootstrap the bluechi-agent are contained in the bluechi-
25       agent section. The following keys are understood by bluechi-agent.
26
27
28   NodeName (string)
29       The unique name of this agent. The  option  defaults  to  the  system's
30       hostname.
31
32
33   ManagerAddress (string)
34       SD  Bus  address  used  by bluechi-agent to connect to bluechi. See man
35       sd_bus_set_address for its format.  Overrides any setting  of  Manager‐
36       Host  or  ManagerPort  defined in the configuration file as well as the
37       respective CLI options. The option doesn't have a default value.
38
39
40   ManagerHost (string)
41       The host used by bluechi-agent to connect to bluechi. Must be  a  valid
42       IPv4  or IPv6. ManagerHost defaults to localhost 127.0.0.1. It's manda‐
43       tory to set this field if the bluechi agent is on a remote system.
44
45
46   ManagerPort (uint16_t)
47       The port on which bluechi is listening for connection request  and  the
48       bluechi-agent is connecting to. By default port 842 is used.
49
50
51   HeartbeatInterval (long)
52       The interval between two heartbeat signals sent to bluechi in millisec‐
53       onds. If an agent is not connected, it will retry to  connect  on  each
54       heartbeat.  Setting  this  options to values smaller or equal to 0 dis‐
55       ables it. This option will overwrite the heartbeat interval defined  in
56       the configuration file.
57
58
59   LogLevel (string)
60       The level used for logging. Supported values are:
61
62
63              • DEBUG
64
65              • INFO
66
67              • WARN
68
69              • ERROR
70
71
72
73       By default INFO level is used for logging.
74
75
76   LogTarget (string)
77       The target where logs are written to. Supported values are:
78
79
80              • stderr
81
82              • stderr-full
83
84              • journald
85
86
87
88       By default journald is used as the target.
89
90
91   LogIsQuiet (string)
92       If this flag is set to true, no logs are written by bluechi. By default
93       the flag is set to false.
94
95

Example

97       Using ManagerHost and ManagerPort options:
98
99       [bluechi-agent]
100       NodeName=agent-007
101       ManagerHost=127.0.0.1
102       ManagerPort=842
103       LogLevel=DEBUG
104       LogTarget=journald
105       LogIsQuiet=false
106
107
108
109       Using ManagerAddress option:
110
111       [bluechi-agent]
112       NodeName=agent-007
113       ManagerAddress=tcp:host=127.0.0.1,port=842
114       LogLevel=DEBUG
115       LogTarget=journald
116       LogIsQuiet=false
117
118
119
120       Using a value that is continued on multiple lines:
121
122       [bluechi-agent]
123       NodeName=agent-007
124       ManagerAddress=tcp:
125         host=127.0.0.1,
126         port=842
127       LogLevel=DEBUG
128       LogTarget=journald
129       LogIsQuiet=false
130
131
132

FILES

134       Distributions  provide  the  /usr/share/bluechi/config/agent.conf  file
135       which  defines bluechi-agent configuration defaults. Administrators can
136       copy this file to /etc/bluechi/agent.conf and specify their own config‐
137       uration.
138
139
140       Administrators     can     also     use     a    "drop-in"    directory
141       /etc/bluechi/agent.conf.d to drop their configuration changes.
142
143

SEE ALSO

145       bluechi-agent(1)                           ⟨https://github.com/contain‐
146       ers/bluechi/blob/main/doc/man/bluechi-agent.1.md⟩
147
148
149
150                                                         bluechi-agent.conf(5)
Impressum