Databases Options
Options for: cnpg, redis-operator.
All options are under lab.clusters.<name>.components.
cnpg.chart
Custom chart derivation. When null, uses nixhelm default.
Type: package
Default:
<derivation helm-chart-https-cloudnative-pg.github.io-charts-cloudnative-pg-0.23.0>
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters
Declarative PostgreSQL clusters managed by CNPG
Type: attribute set of (submodule)
Default: { }
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.backup.enable
Enable automated backups
Type: boolean
Default: false
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.backup.retentionPolicy
Backup retention policy
Type: string
Default: "30d"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.backup.schedule
Cron schedule for backups
Type: string
Default: "0 0 * * *"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.createNamespace
Whether to create the namespace (set to false if another app manages it)
Type: boolean
Default: true
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases
Databases to create in this cluster
Type: attribute set of (submodule)
Default: { }
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases.<name>.extensions
PostgreSQL extensions to enable for this database
Type: list of string
Default: [ ]
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases.<name>.owner
Database owner username
Type: string
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases.<name>.userPasswordSecretRef
Reference to Secret containing the database user’s password
Type: null or (submodule)
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases.<name>.userPasswordSecretRef.key
Key within the secret
Type: string
Default: "password"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.databases.<name>.userPasswordSecretRef.name
Secret containing user password
Type: string
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.enable
Enable this PostgreSQL cluster
Type: boolean
Default: true
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.instances
Number of PostgreSQL instances (replicas)
Type: positive integer, meaning >0
Default: 1
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.monitoring.enable
Enable Prometheus metrics
Type: boolean
Default: true
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.namespace
Namespace for this cluster
Type: string
Default: "databases"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.postgresql.parameters
PostgreSQL configuration parameters
Type: attribute set of string
Default: { }
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.postgresql.version
PostgreSQL major version
Type: string
Default: "16"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.ref
Computed references for this cluster
Type: attribute set
Default: { }
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.storage.size
PVC size for each instance
Type: string
Default: "10Gi"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.storage.storageClass
Storage class for PVCs. Null uses the cluster default.
Type: null or string
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.superuserPasswordSecretRef
Reference to Secret containing superuser password for bootstrap
Type: null or (submodule)
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.superuserPasswordSecretRef.key
Key within the secret
Type: string
Default: "password"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.clusters.<name>.superuserPasswordSecretRef.name
Secret name containing superuser password
Type: string
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.enable
Whether to enable CloudNativePG operator.
Type: boolean
Default: false
Example: true
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.namespace
Namespace for the CloudNativePG operator
Type: string
Default: "cnpg-system"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.phase
Deployment phase this component belongs to
Type: string
Default: "operators"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.ref
Computed references for CNPG
Type: attribute set
Default: { }
Declared in: modules/lab/cluster/components/databases/cnpg.nix
cnpg.version
CloudNativePG operator chart version
Type: string
Default: "0.22.0"
Declared in: modules/lab/cluster/components/databases/cnpg.nix
redis-operator.chart
Custom chart derivation. When null, uses nixhelm default.
Type: package
Default:
<derivation helm-chart-https-ot-container-kit.github.io-helm-charts-redis-operator-0.18.2>
Declared in: modules/lab/cluster/components/redis-operator.nix
redis-operator.enable
Whether to enable Redis operator.
Type: boolean
Default: false
Example: true
Declared in: modules/lab/cluster/components/redis-operator.nix
redis-operator.namespace
Namespace for the Redis operator
Type: string
Default: "redis-operator"
Declared in: modules/lab/cluster/components/redis-operator.nix
redis-operator.phase
Deployment phase this component belongs to
Type: string
Default: "operators"
Declared in: modules/lab/cluster/components/redis-operator.nix
redis-operator.ref
Computed references for Redis operator
Type: attribute set
Default: { }
Declared in: modules/lab/cluster/components/redis-operator.nix
redis-operator.version
Redis operator chart version
Type: string
Default: "0.18.0"
Declared in: modules/lab/cluster/components/redis-operator.nix