Skip to main content

Management configuration

[management]​

Where the broker serves its health probes and metrics.
[management]
mode = "separate-port"
host = "0.0.0.0"
port = 1086
transport = "plaintext"

management.mode​

stringrestart to apply

Where the management endpoints are served: on a port of their own, on the API port, or not at all. A port of their own by default, so probes and metrics keep answering while the API is saturated or draining.

Default
"separate-port"
Allowed values
"disabled"Serves no management endpoints. The health paths under /ngsi-ld/v1 on the API port remain.
"shared-port"Serves the management endpoints at the root of the API port, behind the API's full web stack (CORS, CSRF, security headers, body limits, compression).
"separate-port"Serves the management endpoints on a listener of their own, management.host and management.port, on a bare stack, so probes and metrics keep answering while the API is saturated or draining.
Also required
Environment variable
ANDROMEDA__MANAGEMENT__MODE

management.host​

stringrestart to apply

The address the management listener binds. Read only when management.mode is "separate-port".

Default
"0.0.0.0"
Environment variable
ANDROMEDA__MANAGEMENT__HOST

management.port​

positive integerrestart to apply

The TCP port the management listener binds. Read only when management.mode is "separate-port".

Default
1086
Must be
0 < port
Also required
Environment variable
ANDROMEDA__MANAGEMENT__PORT

management.transport​

stringrestart to apply

Whether the management listener serves plaintext or terminates TLS with the [tls] certificate. Read only when management.mode is "separate-port".

Default
"plaintext"
Allowed values
"plaintext"Serves plaintext HTTP/1.1 and HTTP/2, for a deployment behind a reverse proxy or load balancer that terminates TLS. NGSI-LD calls plaintext HTTP not recommended.
"tls"Terminates TLS in the broker with the [tls] certificate and serves HTTP/1.1 and HTTP/2 over it.
Environment variable
ANDROMEDA__MANAGEMENT__TRANSPORT