bluechi-controller.conf(5)

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

NAME

6       bluechi-controller.conf  - Configuration file to bootstrap bluechi-con‐
7       troller
8
9

DESCRIPTION

11       The basic file definition used to bootstrap bluechi-controller.
12
13

Format

15       The bluechi-controller configuration file is using the systemd configu‐
16       ration     file    format    ⟨https://www.freedesktop.org/software/sys‐
17       temd/man/systemd.syntax.html⟩. Contrary to this, there is no  need  for
18       the \ symbol at the end of a line to continue a value on the next line.
19       A value continued on  multiple  lines  will  just  be  concatenated  by
20       bluechi.  The  maximum  line length supported is 500 characters. If the
21       value exceeds this limitation, use multiple, indented lines.
22
23
24   bluechi-controller section
25       All fields to bootstrap the bluechi controller  are  contained  in  the
26       bluechi-controller  section.  The  following  keys  are  understood  by
27       bluechi-controller.
28
29
30   ManagerPort (uint16_t)
31       The port the manager listens  on  to  establish  connections  with  the
32       bluechi-agent. By default port 842 is used.
33
34
35   AllowedNodeNames (string)
36       A comma separated list of unique bluechi-agent names. It's mandatory to
37       set the option, only nodes with names mentioned in the list can connect
38       to  bluechi  manager. These names are defined in the agent's configura‐
39       tion file under NodeName option (see bluechi-agent.conf(5)).
40
41
42   LogLevel (string)
43       The level used for logging. Supported values are:
44
45
46              • DEBUG
47
48              • INFO
49
50              • WARN
51
52              • ERROR
53
54
55
56       By default INFO level is used for logging.
57
58
59   LogTarget (string)
60       The target where logs are written to. Supported values are:
61
62
63              • stderr
64
65              • stderr-full
66
67              • journald
68
69
70
71       By default journald is used as the target.
72
73
74   LogIsQuiet (string)
75       If this flag is set to true, no logs are written by bluechi. By default
76       the flag is set to false.
77
78

Example

80       A basic example of a configuration file for bluechi:
81
82       [bluechi-controller]
83       ManagerPort=842
84       AllowedNodeNames=agent-007,agent-123
85       LogLevel=DEBUG
86       LogTarget=journald
87       LogIsQuiet=false
88
89
90
91       Using a value that is continued on multiple lines:
92
93       [bluechi-controller]
94       ManagerPort=842
95       AllowedNodeNames=agent-007,
96          agent-123,
97          agent-456,
98          agent-789
99       LogLevel=DEBUG
100       LogTarget=journald
101       LogIsQuiet=false
102
103
104

FILES

106       Distributions   provide  the  /usr/share/bluechi/config/controller.conf
107       file which defines bluechi configuration defaults.  Administrators  can
108       copy  this  file  to /etc/bluechi/controller.conf and specify their own
109       configuration.
110
111
112       Administrators can also use  a  "drop-in"  directory  /etc/bluechi/con‐
113       troller.conf.d to drop their configuration changes.
114
115

NAME

DESCRIPTION

Format

Example

FILES

SEE ALSO