Merge pull request #140 from cybertec-postgresql/ENV

Env

Author: Schmaetz

charts/postgres-operator/crds/postgresqls.yaml

@@ -206,6 +206,17 @@ spec:
                     type: string
                   user:
                     type: string
+                  env:
+                    type: array
+                    nullable: true
+                    items:
+                      type: object
+                      x-kubernetes-preserve-unknown-fields: true
+                  labels:
+                    type: object
+                    nullable: true
+                    additionalProperties:
+                      type: string
               databases:
                 type: object
                 additionalProperties:
@@ -375,6 +386,18 @@ spec:
                 type: object
                 additionalProperties:
                   type: string
+              monitor:
+                nullable: true
+                properties:
+                  image:
+                    type: string
+                  env:
+                    type: array
+                    nullable: true
+                    items:
+                      type: object
+                      x-kubernetes-preserve-unknown-fields: true
+                type: object
               nodeAffinity:
                 type: object
                 properties:
@@ -553,6 +576,17 @@ spec:
                     type: object
                     additionalProperties:
                       type: string
+                  env:
+                    type: array
+                    nullable: true
+                    items:
+                      type: object
+                      x-kubernetes-preserve-unknown-fields: true
+                  labels:
+                    type: object
+                    nullable: true
+                    additionalProperties:
+                      type: string
               preparedDatabases:
                 type: object
                 additionalProperties:
@@ -976,6 +1010,17 @@ spec:
                               memory:
                                 type: string
                                 pattern: '^(\d+(e\d+)?|\d+(\.\d+)?(e\d+)?[EPTGMK]i?)$'
+                      env:
+                        type: array
+                        nullable: true
+                        items:
+                          type: object
+                          x-kubernetes-preserve-unknown-fields: true
+                      labels:
+                        type: object
+                        nullable: true
+                        additionalProperties:
+                          type: string
                     required:
                       - image
                       - repos

charts/postgres-operator/templates/clusterrole.yaml

@@ -196,6 +196,7 @@ rules:
   - get
   - list
   - patch
+  - update
 # to CRUD cron jobs for logical backups
 - apiGroups:
   - batch

docs/hugo/content/en/connection_pooler/_index.md

@@ -31,13 +31,19 @@ CPO relies on pgBouncer, a popular and above all lightweight open source tool. p
 - connection_poole.max_db_connections - How many connections the pooler can max hold. This value is divided among the pooler pods. Default is 60 which will make up 30 connections per pod for the default setup with two instances.
 - connection_pooler.mode - Defines pooler mode. Available Value:  `session`,  `transaction` or `statement`. Default is `transaction`.
 - connection_pooler.resources - Hardware definition for the pooler pods
+- env: Allows you to add custom environment variables
 
 - enableConnectionPooler - Defines whether poolers for read/write access should be created based on the spec.connectionPooler definition. 
 - enableReplicaConnectionPooler- Defines whether poolers for read-only access should be created based on the spec.connectionPooler definition. 
 
 ```
 spec:
   connectionPooler:
+    env:
+      - name: POOLER_ENV
+        value: 'custom value'
+    labels:
+      custom_pooler_label: 'custom value'
     mode: transaction
     numberOfInstances: 2
     resources:

docs/hugo/content/en/crd/crd-postgresql.md

@@ -35,8 +35,9 @@ weight: 331
 | enableMasterPoolerLoadBalancer | boolean | false     | Define whether to enable the load balancer pointing to the primary ConnectionPooler |
 | enableReplicaPoolerLoadBalancer| boolean | false     | Define whether to enable the load balancer pointing to the Replica-ConnectionPooler |
 | enableShmVolume                | boolean | false     | Start a database pod without limitations on shm memory. By default Docker limit /dev/shm to 64M (see e.g. the docker issue, which could be not enough if PostgreSQL uses parallel workers heavily. If this option is present and value is true, to the target database pod will be mounted a new tmpfs volume to remove this limitation. |
-| [env](#env)                    | array   | false     | Allows to add own Envs to the PostgreSQL containers |
+| [env](#env)                    | array   | false     | Allows you to add custom environment variables to all cluster containers |
 | [initContainers](#initcontainers) | array   | false    | Enables the definition of init-containers |
+| [labels](#labels)              | object  | false     | Allows you to add custom labels to all cluster pods |
 | logicalBackupSchedule          | string  | false     | Enables the scheduling of logical backups based on cron-syntax. Example: `30 00 * * *` |
 | maintenanceWindows             | array   | false     | Enables the definition of maintenance windows for the cluster. Example: `Sat:00:00-04:00` |
 | masterServiceAnnotations       | map     | false     | Enables the definition of annotations for the Primary Service |
@@ -113,6 +114,9 @@ key, operator, value, effect and tolerationSeconds |
 
 | Name                           | Type    | required  | Description        |
 | ------------------------------ |:-------:| ---------:| ------------------:|
+| [env](#env)                    | array   | false     | Allows you to add custom environment variables to connection-pooler containers |
+| [labels](#labels)              | object  | false     | Allows you to add custom labels to connection-pooler pods |
+| dockerImage                    | string  | true      | Defines the used pgbouncer container image for this cluster |
 | numberOfInstances              | int     | true      | Number of Pods per Pooler  |
 | mode                           | string  | true      | pooling mode for pgBouncer (session, transaction, statement) |
 | schema                         | string  | true      | Schema for Pooler (Default: pooler) |
@@ -149,10 +153,22 @@ key, operator, value, effect and tolerationSeconds |
 
 ---
 
+#### labels
+
+| Name                           | Type    | required  | Description        |
+| ------------------------------ |:-------:| ---------:| ------------------:|
+| <key>                          | string  | true      | Namefield for the label |
+| <value>                        | string  | true      | Value for the label |
+
+{{< back >}}
+
+---
+
 #### monitor
 
 | Name                           | Type    | required  | Description        |
 | ------------------------------ |:-------:| ---------:| ------------------:|
+| [env](#env)                    | array   | false     | Allows you to add custom environment variables to all expoerter-sidecar containers |
 | image                          | string  | true      | Docker-Image for the metric exporter  |
 
 {{< back >}}
@@ -184,6 +200,8 @@ key, operator, value, effect and tolerationSeconds |
 
 | Name                           | Type    | required  | Description        |
 | ------------------------------ |:-------:| ---------:| ------------------:|
+| [env](#env)                    | array   | false     | Allows you to add custom environment variables to all postgresql containers |
+| [labels](#labels)              | object  | false     | Allows you to add custom labels to poostgresql pods |
 | parameters                     | map     | false     | PostgreSQL-Parameter as item (Example: max_connections: "100"). For help check out the [CYBERTEC PostgreSQL Configurator](https://pgconfigurator.cybertec.at)  |
 | version                        | string  | false     | a map of key-value pairs describing initdb parameters  |
 
@@ -401,8 +419,10 @@ key, operator, value, effect and tolerationSeconds |
 | Name                           | Type    | required  | Description        |
 | ------------------------------ |:-------:| ---------:| ------------------:|
 | [configuration](#configuration)| object  | false     | Enables the definition of a pgbackrest-setup for the cluster |
+| [env](#env)                    | array   | false     | Allows you to add custom environment variables to all pgbackrest containers |
 | global                         | object  | false     |  |
 | image                          | string  | true      |  |
+| [labels](#labels)              | object  | false     | Allows you to add custom labels to pgbackrest pods |
 | [repos](#repos)                | array   | true      |  |
 | [resources](#resources)        | object  | false     | CPU & Memory (Limit & Request) definition for the pgBackRest container|
 

docs/hugo/content/en/customize_cluster/env.md

@@ -0,0 +1,31 @@
+---
+title: "Environment variables"
+date: 2023-12-28T14:26:51+01:00
+draft: false
+weight: 1
+---
+
+To flexibly manage containers within a cluster, the operator allows environment variables to be defined at various levels. This enables both global settings and specific configurations for individual components.
+Hierarchy and Scope
+The variables are defined within the Custom Resource (CR). The following logic applies for inheritance and assignment:
+
+| object | Scope | Description |
+| :--- | :--- | :--- |
+| `spec.env` | **Global** | These ENVs are inherited by **all** containers within the cluster (PostgreSQL, Backup, Monitoring, etc.). |
+| `spec.postgresql.env` | **PostgreSQL** | These ENVs apply exclusively to the **PostgreSQL containers**. |
+| `spec.backup.pgbackrest.env` | **pgBackRest** | These ENVs apply exclusively to the **Backup containers**. |
+| `spec.monitor.env` | **Exporter-Sidecar** | These ENVs apply exclusively to the **ConnectionPooler containers**. |
+| `spec.connectionPooler.env` | **ConnectionPooler** | These ENVs apply exclusively to the **Monitoring sidecars**. |
+
+{{< hint type=Warning >}}Updating the ENVs triggers a rolling update to the respective containers.{{< /hint >}}
+
+
+### Configuration Logic 
+
+The definition of variables follows the standard Kubernetes schema for key-value pairs. 
+
+```yaml 
+env: 
+  - name: ENV_NAME 
+    value: ‘value’
+```

docs/hugo/content/en/customize_cluster/labels.md

@@ -0,0 +1,27 @@
+---
+title: "Custom Labels"
+date: 2023-12-28T14:26:51+01:00
+draft: false
+weight: 2
+---
+
+To manage and organise pods flexibly within a cluster, the operator allows labels to be defined at various levels. This enables both global labelling and specific metadata for individual components. Unlike environment variables, labels always refer to the pod as a whole, not to individual containers.
+
+| object | Scope | Description |
+| :--- | :--- | :--- |
+| `spec.labels` | **Global** | These labels are adopted by **all** pods within the cluster (**PostgreSQL**, **Backup**, **Pooler**, etc.). |
+| `spec.postgresql.labels` | **PostgreSQL** | These labels apply exclusively to the PostgreSQL pods. **PostgreSQL pods**. |
+| `spec.backup.pgbackrest.labels` | **pgBackRest** | These labels apply exclusively to the backup pods **pgBackRest pods**. |
+| `spec.connectionPooler.labels` | **ConnectionPooler** | These labels apply exclusively to the  **ConnectionPooler pods**. |
+
+{{< hint type=Warning >}}Updating the labels triggers a rolling update to the respective pods.{{< /hint >}}
+
+
+### Configuration Logic 
+
+The definition of labels follows the standard Kubernetes schema for key-value pairs. 
+
+```yaml 
+labels: 
+  custom_label: ‘value’
+```

docs/hugo/content/en/customize_cluster/sidecars.md

@@ -2,7 +2,7 @@
 title: "Sidecars"
 date: 2023-12-28T14:26:51+01:00
 draft: false
-weight: 1
+weight: 2
 ---
 Starting with the Single-Node-Cluster from the previous section, we want to modify the Instance a bit to see. 
 ## CPU and Memory

pkg/apis/cpo.opensource.cybertec.at/v1/crds.go

@@ -338,6 +338,26 @@ var PostgresCRDResourceValidation = apiextv1.CustomResourceValidation{
 							"user": {
 								Type: "string",
 							},
+							"env": {
+								Type:     "array",
+								Nullable: true,
+								Items: &apiextv1.JSONSchemaPropsOrArray{
+									Schema: &apiextv1.JSONSchemaProps{
+										Type:                   "object",
+										XPreserveUnknownFields: util.True(),
+									},
+								},
+							},
+							"labels": {
+								Type:     "object",
+								Nullable: true,
+								AdditionalProperties: &apiextv1.JSONSchemaPropsOrBool{
+									Allows: true,
+									Schema: &apiextv1.JSONSchemaProps{
+										Type: "string",
+									},
+								},
+							},
 						},
 					},
 					"databases": {
@@ -385,6 +405,16 @@ var PostgresCRDResourceValidation = apiextv1.CustomResourceValidation{
 							},
 						},
 					},
+					"labels": {
+						Type:     "object",
+						Nullable: true,
+						AdditionalProperties: &apiextv1.JSONSchemaPropsOrBool{
+							Allows: true,
+							Schema: &apiextv1.JSONSchemaProps{
+								Type: "string",
+							},
+						},
+					},
 					"init_containers": {
 						Type:        "array",
 						Description: "deprecated",
@@ -759,6 +789,26 @@ var PostgresCRDResourceValidation = apiextv1.CustomResourceValidation{
 									},
 								},
 							},
+							"env": {
+								Type:     "array",
+								Nullable: true,
+								Items: &apiextv1.JSONSchemaPropsOrArray{
+									Schema: &apiextv1.JSONSchemaProps{
+										Type:                   "object",
+										XPreserveUnknownFields: util.True(),
+									},
+								},
+							},
+							"labels": {
+								Type:     "object",
+								Nullable: true,
+								AdditionalProperties: &apiextv1.JSONSchemaPropsOrBool{
+									Allows: true,
+									Schema: &apiextv1.JSONSchemaProps{
+										Type: "string",
+									},
+								},
+							},
 						},
 					},
 					"preparedDatabases": {
@@ -1433,6 +1483,26 @@ var PostgresCRDResourceValidation = apiextv1.CustomResourceValidation{
 											},
 										},
 									},
+									"env": {
+										Type:     "array",
+										Nullable: true,
+										Items: &apiextv1.JSONSchemaPropsOrArray{
+											Schema: &apiextv1.JSONSchemaProps{
+												Type:                   "object",
+												XPreserveUnknownFields: util.True(),
+											},
+										},
+									},
+									"labels": {
+										Type:     "object",
+										Nullable: true,
+										AdditionalProperties: &apiextv1.JSONSchemaPropsOrBool{
+											Allows: true,
+											Schema: &apiextv1.JSONSchemaProps{
+												Type: "string",
+											},
+										},
+									},
 								},
 							},
 						},
@@ -1465,6 +1535,16 @@ var PostgresCRDResourceValidation = apiextv1.CustomResourceValidation{
 							"image": {
 								Type: "string",
 							},
+							"env": {
+								Type:     "array",
+								Nullable: true,
+								Items: &apiextv1.JSONSchemaPropsOrArray{
+									Schema: &apiextv1.JSONSchemaProps{
+										Type:                   "object",
+										XPreserveUnknownFields: util.True(),
+									},
+								},
+							},
 						},
 					},
 				},