Coordinator

The SPQR Coordinator configuration can be specified in JSON, TOML, or YAML format. The configuration file passing as a parameter to run command:

spqr-coordinator run --config ./examples/coordinator.yaml

Refer to the pkg/config/coordinator.go file for the most up-to-date configuration options.

Coordinator Settings

Setting	Description	Possible Values
log_level	The level of logging output.	debug, info, warning, error, fatal
pretty_logging	Whether to write logs in an colorized, human-friendly format.	true, false
qdb_addr	the address of the QDB server	Any valid address
host	The host address the coordinator listens on.	Any valid hostname
coordinator_port	The port number for the coordinator.	Any valid port number
grpc_api_port	The port number for the gRPC API.	Any valid port number
auth	See auth.mdx	Object of AuthCfg
frontend_tls	See auth.mdx	Object of TLSConfig
frontend_rules	The rules for frontend connections.	List of FrontendRule
use_systemd_notifier	Whether to use systemd notifier.	true, false
systemd_notifier_debug	Whether to run systemd notifier in debug mode.	true, false
enable_role_system	Whether to enable the role-based access control system.	true, false
roles_file	The file path to the roles configuration.	Any valid file path

Frontend Rules

Frontend rule is a specification of how clients connect to the admin console.

Refer to the FrontendRule struct in the pkg/config/rules.go file for the most up-to-date configuration options.

Setting	Description	Possible Values
db	The database name to which the rule applies	Any valid database name
usr	The user name for which the rule is applicable	Any valid username
auth_rule	See General Auth Settings	Object of AuthCfg