truecharts/charts/library/common/docs/cnpg/cluster.md at a5cd5a42e598067a0237d65d79d28811ae9be082

Files

T

astro-stan e892b37565 feat(common): Add support for setting extra env to CNPG pods (#40673 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->

This PR adds the ability to set extra environment variables to CNPG
pods.

I need this, as I need to set the `HTTP_PROXY`, `HTTPS_PROXY` and
`NO_PROXY` envs to the CNPG pods, so that backup/restore goes through my
Gluetun proxy.

This PR only adds support for CNPG, as with Volsync, this can be done by
setting environment variables on the Volsync controller itself (see
[release
notes](https://github.com/backube/volsync/blob/main/CHANGELOG.md#061)
for more info).

This PR, along with the other PRs I opened recently (#40000 , #40385,
#40523 , #40668) should be the last piece of the puzzle needed for
enabling backup/restore of clusters using a remote self-hosted S3
server.

⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [X] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [ ] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

What I have tested:

- Rendered a chart with various combinations of CNPG envs set and looked
ad produced output
- Tested along with the other PRs (#40523, #40668) to verify backup up
to my S3 server works though the Gluetun proxy

**📃 Notes:**
<!-- Please enter any other relevant information here -->

Note that these changes should not affect any work related towards the
migration to the CNPG's new plugin-based barman. As per the [migration
guide](https://cloudnative-pg.io/plugin-barman-cloud/docs/migration/),
the required changes are primarily to export the keys under the
`barmanObjectStore` to a new CRD called `ObjectStore`. The `env` and
`envFrom` keys added in this PR are outside this dictionary; thus, they
should not require any changes when adding support for the new
plugin-based barman.

---

- [CNPG CRD for env and
envFrom](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/config/crd/bases/postgresql.cnpg.io_clusters.yaml#L2161-L2368)

**✔️ Checklist:**

- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [X] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made changes to the documentation
- [X] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ I increased versions for any altered app according to semantic
versioning
- [X] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Signed-off-by: Kjeld Schouten <info@kjeldschouten.nl>
Co-authored-by: Kjeld Schouten <info@kjeldschouten.nl>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

2025-10-18 00:05:25 +02:00

5.5 KiB

Raw Blame History

title

title
CNPG Cluster

:::note

Examples under each key are only to be used as a placement guide
See the Full Examples section for complete examples.
This page is targeted primarily at chart developers. If you are looking for how to configure a CNPG backup/restore, visit the dedicated guide page

:::

Appears in

.Values.cnpg.$name.cluster

:::tip

Replace references to $name with the actual name you want to use.

:::

`labels`

Additional labels for CNPG cluster


Key	`cnpg.$name.cluster.labels`
Type	`map`
Required	❌
Helm `tpl`	✅ (On value only)
Default	`{}`

Example

cnpg:
  cnpg-name:
    cluster:
      labels:
        key: value

`annotations`

Additional annotations for CNPG cluster


Key	`cnpg.$name.cluster.annotations`
Type	`map`
Required	❌
Helm `tpl`	✅ (On value only)
Default	`{}`

Example

cnpg:
  cnpg-name:
    cluster:
      annotations:
        key: value

`env`

Define additional environment variables for the cluster's pods

:::tip

See container env options in the container env section.

:::


Key	`cnpg.$name.cluster.env`
Type	`map`
Required	❌
Helm `tpl`	❌
Default	`{}`

Example

cnpg:
  cnpg-name:
    cluster:
      env:
        key: value

`envFrom`

Define additional environment variables for the cluster's pods

:::tip

See container envFrom options in the container envFrom section.

:::


Key	`cnpg.$name.cluster.envFrom`
Type	`map`
Required	❌
Helm `tpl`	❌
Default	`[]`

Example

cnpg:
  cnpg-name:
    cluster:
      envFrom:
        - secretRef:
            name: secret-name
            expandObjectName: false
        - configMapRef:
            name: configmap-name
            expandObjectName: true

`instances`

Number of instances


Key	`cnpg.$name.cluster.instances`
Type	`int`
Required	❌
Helm `tpl`	❌
Default	`2`

Example

cnpg:
  cnpg-name:
    cluster:
      instances: 2

`singleNode`

Whether this is a single-node cluster.

Setting this to true would allow PVCs to be kept on instance restart.

:::note

If you are a chart developer, changing the default value is not recommended, as users are expected to change this themselves if they are running your chart on a single-node cluster.

:::


Key	`cnpg.$name.cluster.singleNode`
Type	`bool`
Required	❌
Helm `tpl`	❌
Default	`false`

Example

cnpg:
  cnpg-name:
    cluster:
      singleNode: true

`logLevel`

The cluster log level. Available values:

error
warning
info
debug
trace

:::note

If you are a chart developer, changing the default value is not recommended, as users are expected to change this themselves if they are running into issues with CNPG.

:::


Key	`cnpg.$name.cluster.logLevel`
Type	`enum`
Required	❌
Helm `tpl`	❌
Default	`info`

Example

cnpg:
  cnpg-name:
    cluster:
      logLevel: info

`primaryUpdateMethod`

TODO

`primaryUpdateStrategy`

TODO

`certificates`

TODO

`postgresql`

TODO

`initdb`

TODO

Full Examples

cnpg:
  $name:
    cluster:
      labels:
        label1: label1
        label2: label2
      annotations:
        annotation1: annotation1
        annotation2: annotation2
      env:
        key: value
      envList:
        - name: key
          value: value
      envFrom:
        - secretRef:
          name: my-secret
          expandObjectName: true
        - configMapRef:
          name: my-configmap
          expandObjectName: false
      instances: 2
      singleNode: false
      logLevel: info
      primaryUpdateMethod: # TODO
      primaryUpdateStrategy: # TODO
      certificates: # TODO
      postgresql: # TODO
      initdb: # TODO
      primaryUpdateStrategy: # TODO

5.5 KiB Raw Blame History

Appears in

labels

annotations

env

envFrom

instances

singleNode

logLevel

primaryUpdateMethod

primaryUpdateStrategy

certificates

postgresql

initdb

Full Examples

5.5 KiB

Raw Blame History

`labels`

`annotations`

`env`

`envFrom`

`instances`

`singleNode`

`logLevel`

`primaryUpdateMethod`

`primaryUpdateStrategy`

`certificates`

`postgresql`

`initdb`