Skip to content

configuration.md

Latest commit

 

History

History
94 lines (74 loc) · 4.79 KB

configuration.md

File metadata and controls

94 lines (74 loc) · 4.79 KB
Raw

Operator Configuration

Required Environment Variables

The operator requires two environment variables to be set on the Deployment (these are pre-configured in the install manifests):

Variable Description
POD_NAMESPACE Namespace where the operator is deployed. Used for leader election, cert secrets, and cache filtering.
POD_SERVICE_ACCOUNT Service account name of the operator pod. Used for webhook configuration.

Flags

You can customize the operator's behavior by passing flags to the binary (or editing the Deployment args).

Flag Default Description
--webhook-enable true Enable the admission webhook server.
--webhook-port 9443 The port that the webhook server serves at.
--webhook-cert-dir /var/run/secrets/webhook Directory to read/write webhook certificates.
--webhook-service-name multigres-operator-webhook-service Name of the Service pointing to the webhook.
--webhook-service-namespace $POD_NAMESPACE Namespace of the webhook service.
--webhook-service-account $POD_SERVICE_ACCOUNT Service Account name of the operator.
--metrics-bind-address :8443 Address for the metrics endpoint. Set to 0 to disable.
--metrics-secure true Serve metrics over HTTPS with authentication and authorization.
--enable-http2 false Enable HTTP/2 for metrics and webhook servers.
--leader-elect false Enable leader election (recommended for HA deployments).
--image-update-strategy immediate Default for when clusters adopt a changed default image set: immediate rolls a cluster as soon as operator configuration changes; lazy holds it on its current set until spec.imageUpdatePolicy.acknowledgedRevision names the new set's revision. Individual clusters can override this via spec.imageUpdatePolicy.strategy.

Component Images

Component images are operator configuration, resolved at reconcile time: the operator uses its compiled-in defaults for any component not explicitly set in spec.images, and each default can be overridden on the operator Deployment. Explicit spec.images values always win. The resolved default set and its revision are logged at startup. Per-cluster status.images reports the complete effective set and whether it comes from explicit pins, defaults, or a mixture; default revisions are reported only when defaults participate.

Variable Overrides the default image for
MULTIGRES_IMAGE_POSTGRES Postgres (pgctld)
MULTIGRES_IMAGE_MULTIADMIN Multiadmin
MULTIGRES_IMAGE_MULTIADMIN_WEB MultiadminWeb
MULTIGRES_IMAGE_MULTIORCH Multiorch
MULTIGRES_IMAGE_MULTIPOOLER Multipooler
MULTIGRES_IMAGE_MULTIGATEWAY Multigateway

See gitops-and-webhook-defaults.md for how image resolution and the lazy update strategy behave per cluster.

Logging

The operator uses structured JSON logging (zap via controller-runtime). When tracing is enabled, every log line within a traced operation automatically includes trace_id and span_id fields.

Flag Default Description
--zap-devel true Development mode preset (console encoder, debug level, warn stacktraces).
--zap-log-level depends on mode Log verbosity: debug, info, error, or an integer.
--zap-encoder depends on mode Log format: console or json.
--zap-stacktrace-level depends on mode Minimum level that triggers stacktraces.
Setting --zap-devel=true (default) --zap-devel=false (production)
Default log level debug info
Encoder console (human-readable) json
Stacktraces from warn error

Note

For production deployments, set --zap-devel=false to switch to JSON encoding and info-level logging.

Component Log Levels

The operator exposes per-component log level configuration for multigres data-plane components via the LogLevels field on MultigresClusterSpec. These control the --log-level flag passed to each component's container.

spec:
  logLevels:
    pgctld: "info"
    multipooler: "info"
    multiorch: "debug"      # Increase verbosity for multiorch
    multiadmin: "info"
    multigateway: "info"
Component Field Default
pgctld spec.logLevels.pgctld info
multipooler spec.logLevels.multipooler info
multiorch spec.logLevels.multiorch info
multiadmin spec.logLevels.multiadmin info
multigateway spec.logLevels.multigateway info

Log levels are inherited through the resource hierarchy (MultigresCluster → Cell → Shard → TableGroup). The webhook materializes all fields to info on CREATE if not set.