Skip to content
This repository was archived by the owner on Oct 13, 2025. It is now read-only.

Commit 01b206f

Browse files
zeek-botzeek-bot
committed
Generate docs
1 parent 32e4ef2 commit 01b206f

File tree

1 file changed

+66
-40
lines changed

1 file changed

+66
-40
lines changed

‎scripts/policy/frameworks/management/controller/config.zeek.rst‎

Lines changed: 66 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,35 @@ Summary
1313
~~~~~~~
1414
Redefinable Options
1515
###################
16-
======================================================================================================== =====================================================================================
17-
:zeek:id:`Management::Controller::auto_assign_broker_ports`: :zeek:type:`bool` :zeek:attr:`&redef` Whether the controller should auto-assign Broker listening ports to
18-
cluster nodes that need them and don't have them explicitly specified
19-
in cluster configurations.
20-
:zeek:id:`Management::Controller::auto_assign_broker_start_port`: :zeek:type:`port` :zeek:attr:`&redef` The TCP start port to use for auto-assigning cluster node listening
21-
ports, if :zeek:see:`Management::Controller::auto_assign_broker_ports` is
22-
enabled (the default) and nodes don't come with those ports assigned.
23-
:zeek:id:`Management::Controller::auto_assign_metrics_ports`: :zeek:type:`bool` :zeek:attr:`&redef` Whether the controller should auto-assign metrics ports for Prometheus
24-
to nodes that need them and don't have them explicitly specified in
25-
their cluster configurations.
26-
:zeek:id:`Management::Controller::auto_assign_metrics_start_port`: :zeek:type:`port` :zeek:attr:`&redef` The TCP start port to use for auto-assigning metrics exposition ports
27-
for Prometheus, if :zeek:see:`Management::Controller::auto_assign_metrics_ports`
28-
is enabled (the default).
29-
:zeek:id:`Management::Controller::default_port`: :zeek:type:`port` :zeek:attr:`&redef` The fallback listen port if :zeek:see:`Management::Controller::listen_port`
30-
remains empty.
31-
:zeek:id:`Management::Controller::default_port_websocket`: :zeek:type:`port` :zeek:attr:`&redef` The fallback listen port if :zeek:see:`Management::Controller::listen_port_websocket`
32-
remains empty.
33-
:zeek:id:`Management::Controller::directory`: :zeek:type:`string` :zeek:attr:`&redef` An optional custom output directory for stdout/stderr.
34-
:zeek:id:`Management::Controller::listen_address`: :zeek:type:`string` :zeek:attr:`&redef` The network address the controller listens on for Broker clients.
35-
:zeek:id:`Management::Controller::listen_address_websocket`: :zeek:type:`string` :zeek:attr:`&redef` The network address the controller listens on for websocket
36-
clients.
37-
:zeek:id:`Management::Controller::listen_port`: :zeek:type:`string` :zeek:attr:`&redef` The network port the controller listens on for Broker clients.
38-
:zeek:id:`Management::Controller::listen_port_websocket`: :zeek:type:`string` :zeek:attr:`&redef` The network port the controller listens on for websocket clients.
39-
:zeek:id:`Management::Controller::name`: :zeek:type:`string` :zeek:attr:`&redef` The name of this controller.
40-
:zeek:id:`Management::Controller::stderr_file`: :zeek:type:`string` :zeek:attr:`&redef` The controller's stderr log name.
41-
:zeek:id:`Management::Controller::stdout_file`: :zeek:type:`string` :zeek:attr:`&redef` The controller's stdout log name.
42-
:zeek:id:`Management::Controller::topic`: :zeek:type:`string` :zeek:attr:`&redef` The controller's Broker topic.
43-
======================================================================================================== =====================================================================================
16+
======================================================================================================================= =====================================================================================
17+
:zeek:id:`Management::Controller::auto_assign_broker_ports`: :zeek:type:`bool` :zeek:attr:`&redef` Whether the controller should auto-assign Broker listening ports to
18+
cluster nodes that need them and don't have them explicitly specified
19+
in cluster configurations.
20+
:zeek:id:`Management::Controller::auto_assign_broker_start_port`: :zeek:type:`port` :zeek:attr:`&redef` The TCP start port to use for auto-assigning cluster node listening
21+
ports, if :zeek:see:`Management::Controller::auto_assign_broker_ports` is
22+
enabled (the default) and nodes don't come with those ports assigned.
23+
:zeek:id:`Management::Controller::auto_assign_metrics_ports`: :zeek:type:`bool` :zeek:attr:`&redef` Whether the controller should auto-assign metrics ports for Prometheus
24+
to nodes that need them and don't have them explicitly specified in
25+
their cluster configurations.
26+
:zeek:id:`Management::Controller::auto_assign_metrics_start_port`: :zeek:type:`port` :zeek:attr:`&redef` The TCP start port to use for auto-assigning metrics exposition ports
27+
for Prometheus, if :zeek:see:`Management::Controller::auto_assign_metrics_ports`
28+
is enabled (the default).
29+
:zeek:id:`Management::Controller::default_port`: :zeek:type:`port` :zeek:attr:`&redef` The fallback listen port if :zeek:see:`Management::Controller::listen_port`
30+
remains empty.
31+
:zeek:id:`Management::Controller::default_port_websocket`: :zeek:type:`port` :zeek:attr:`&redef` The fallback listen port if :zeek:see:`Management::Controller::listen_port_websocket`
32+
remains empty.
33+
:zeek:id:`Management::Controller::directory`: :zeek:type:`string` :zeek:attr:`&redef` An optional custom output directory for stdout/stderr.
34+
:zeek:id:`Management::Controller::listen_address`: :zeek:type:`string` :zeek:attr:`&redef` The network address the controller listens on for Broker clients.
35+
:zeek:id:`Management::Controller::listen_address_websocket`: :zeek:type:`string` :zeek:attr:`&redef` The network address the controller listens on for websocket
36+
clients.
37+
:zeek:id:`Management::Controller::listen_port`: :zeek:type:`string` :zeek:attr:`&redef` The network port the controller listens on for Broker clients.
38+
:zeek:id:`Management::Controller::listen_port_websocket`: :zeek:type:`string` :zeek:attr:`&redef` The network port the controller listens on for websocket clients.
39+
:zeek:id:`Management::Controller::name`: :zeek:type:`string` :zeek:attr:`&redef` The name of this controller.
40+
:zeek:id:`Management::Controller::stderr_file`: :zeek:type:`string` :zeek:attr:`&redef` The controller's stderr log name.
41+
:zeek:id:`Management::Controller::stdout_file`: :zeek:type:`string` :zeek:attr:`&redef` The controller's stdout log name.
42+
:zeek:id:`Management::Controller::tls_options_websocket`: :zeek:type:`Cluster::WebSocketTLSOptions` :zeek:attr:`&redef` TLS options for the controller's WebSocket server.
43+
:zeek:id:`Management::Controller::topic`: :zeek:type:`string` :zeek:attr:`&redef` The controller's Broker topic.
44+
======================================================================================================================= =====================================================================================
4445

4546
Constants
4647
#########
@@ -69,7 +70,7 @@ Detailed Interface
6970
Redefinable Options
7071
###################
7172
.. zeek:id:: Management::Controller::auto_assign_broker_ports
72-
:source-code: policy/frameworks/management/controller/config.zeek 67 67
73+
:source-code: policy/frameworks/management/controller/config.zeek 75 75
7374

7475
:Type: :zeek:type:`bool`
7576
:Attributes: :zeek:attr:`&redef`
@@ -80,7 +81,7 @@ Redefinable Options
8081
in cluster configurations.
8182

8283
.. zeek:id:: Management::Controller::auto_assign_broker_start_port
83-
:source-code: policy/frameworks/management/controller/config.zeek 72 72
84+
:source-code: policy/frameworks/management/controller/config.zeek 80 80
8485

8586
:Type: :zeek:type:`port`
8687
:Attributes: :zeek:attr:`&redef`
@@ -91,7 +92,7 @@ Redefinable Options
9192
enabled (the default) and nodes don't come with those ports assigned.
9293

9394
.. zeek:id:: Management::Controller::auto_assign_metrics_ports
94-
:source-code: policy/frameworks/management/controller/config.zeek 77 77
95+
:source-code: policy/frameworks/management/controller/config.zeek 85 85
9596

9697
:Type: :zeek:type:`bool`
9798
:Attributes: :zeek:attr:`&redef`
@@ -102,7 +103,7 @@ Redefinable Options
102103
their cluster configurations.
103104

104105
.. zeek:id:: Management::Controller::auto_assign_metrics_start_port
105-
:source-code: policy/frameworks/management/controller/config.zeek 82 82
106+
:source-code: policy/frameworks/management/controller/config.zeek 90 90
106107

107108
:Type: :zeek:type:`port`
108109
:Attributes: :zeek:attr:`&redef`
@@ -137,7 +138,7 @@ Redefinable Options
137138
for websocket clients.
138139

139140
.. zeek:id:: Management::Controller::directory
140-
:source-code: policy/frameworks/management/controller/config.zeek 91 91
141+
:source-code: policy/frameworks/management/controller/config.zeek 99 99
141142

142143
:Type: :zeek:type:`string`
143144
:Attributes: :zeek:attr:`&redef`
@@ -234,8 +235,33 @@ Redefinable Options
234235
Note that the controller also establishes a "proper" Zeek log via the
235236
:zeek:see:`Management::Log` module.
236237

238+
.. zeek:id:: Management::Controller::tls_options_websocket
239+
:source-code: policy/frameworks/management/controller/config.zeek 70 70
240+
241+
:Type: :zeek:type:`Cluster::WebSocketTLSOptions`
242+
:Attributes: :zeek:attr:`&redef`
243+
:Default:
244+
245+
::
246+
247+
{
248+
cert_file=<uninitialized>
249+
key_file=<uninitialized>
250+
enable_peer_verification=F
251+
ca_file=""
252+
ciphers=""
253+
}
254+
255+
256+
TLS options for the controller's WebSocket server. The default is
257+
to operate unencrypted. To replicate Broker's default encryption
258+
without endpoint validation, set the
259+
:zeek:field:`Cluster::WebSocketTLSOptions$ca_file` field to
260+
"NONE" and :zeek:field:`Cluster::WebSocketTLSOptions$ciphers` to
261+
"AECDH-AES256-SHA@SECLEVEL=0:AECDH-AES256-SHA:P-384".
262+
237263
.. zeek:id:: Management::Controller::topic
238-
:source-code: policy/frameworks/management/controller/config.zeek 85 85
264+
:source-code: policy/frameworks/management/controller/config.zeek 93 93
239265

240266
:Type: :zeek:type:`string`
241267
:Attributes: :zeek:attr:`&redef`
@@ -246,7 +272,7 @@ Redefinable Options
246272
Constants
247273
#########
248274
.. zeek:id:: Management::Controller::store_name
249-
:source-code: policy/frameworks/management/controller/config.zeek 95 95
275+
:source-code: policy/frameworks/management/controller/config.zeek 103 103
250276

251277
:Type: :zeek:type:`string`
252278
:Default: ``"controller"``
@@ -257,38 +283,38 @@ Constants
257283
Functions
258284
#########
259285
.. zeek:id:: Management::Controller::endpoint_info
260-
:source-code: policy/frameworks/management/controller/config.zeek 163 171
286+
:source-code: policy/frameworks/management/controller/config.zeek 171 179
261287

262288
:Type: :zeek:type:`function` () : :zeek:type:`Broker::EndpointInfo`
263289

264290
Returns a :zeek:see:`Broker::EndpointInfo` record describing the
265291
controller's Broker connectivity.
266292

267293
.. zeek:id:: Management::Controller::endpoint_info_websocket
268-
:source-code: policy/frameworks/management/controller/config.zeek 173 181
294+
:source-code: policy/frameworks/management/controller/config.zeek 181 189
269295

270296
:Type: :zeek:type:`function` () : :zeek:type:`Broker::EndpointInfo`
271297

272298
Returns a :zeek:see:`Broker::EndpointInfo` record describing the
273299
controller's websocket connectivity.
274300

275301
.. zeek:id:: Management::Controller::get_name
276-
:source-code: policy/frameworks/management/controller/config.zeek 117 123
302+
:source-code: policy/frameworks/management/controller/config.zeek 125 131
277303

278304
:Type: :zeek:type:`function` () : :zeek:type:`string`
279305

280306
Returns the effective name of the controller.
281307

282308
.. zeek:id:: Management::Controller::network_info
283-
:source-code: policy/frameworks/management/controller/config.zeek 125 142
309+
:source-code: policy/frameworks/management/controller/config.zeek 133 150
284310

285311
:Type: :zeek:type:`function` () : :zeek:type:`Broker::NetworkInfo`
286312

287313
Returns a :zeek:see:`Broker::NetworkInfo` record describing the
288314
controller's Broker connectivity.
289315

290316
.. zeek:id:: Management::Controller::network_info_websocket
291-
:source-code: policy/frameworks/management/controller/config.zeek 144 161
317+
:source-code: policy/frameworks/management/controller/config.zeek 152 169
292318

293319
:Type: :zeek:type:`function` () : :zeek:type:`Broker::NetworkInfo`
294320

0 commit comments

Comments
 (0)