Files
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

256 lines
7.8 KiB
YAML

suite: container env dupe test
templates:
- common.yaml
release:
name: test-release-name
namespace: test-release-namespace
tests:
# Failures
- it: should fail with dupe env in env and envList
set:
image: &image
repository: nginx
tag: 1.19.0
pullPolicy: IfNotPresent
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: &probes
liveness:
enabled: false
readiness:
enabled: false
startup:
enabled: false
env:
VAR1: some_value
envList:
- name: VAR1
value: 123
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [VAR1] in [containers.container-name1.envList] tried to override the Environment Variable that is already defined in [containers.container-name1.env]
- it: should fail with dupe env in env and envFrom configmap
set:
image: *image
configmap:
configmap-name:
enabled: true
data:
VAR1: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
env:
VAR1: some_value
envFrom:
- configMapRef:
name: configmap-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [VAR1] in [containers.container-name1.env] tried to override the Environment Variable that is already defined in [ConfigMap - configmap-name]
- it: should fail with dupe env in env and envFrom secret
set:
image: *image
secret:
secret-name:
enabled: true
data:
VAR1: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
env:
VAR1: some_value
envFrom:
- secretRef:
name: secret-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [VAR1] in [containers.container-name1.env] tried to override the Environment Variable that is already defined in [Secret - secret-name]
- it: should fail with dupe env in envList and envFrom secret
set:
image: *image
secret:
secret-name:
enabled: true
data:
VAR1: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
envList:
- name: VAR1
value: some_value
envFrom:
- secretRef:
name: secret-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [VAR1] in [containers.container-name1.envList] tried to override the Environment Variable that is already defined in [Secret - secret-name]
- it: should fail with dupe env in envList and envFrom configmap
set:
image: *image
configmap:
configmap-name:
enabled: true
data:
VAR1: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
envList:
- name: VAR1
value: some_value
envFrom:
- configMapRef:
name: configmap-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [VAR1] in [containers.container-name1.envList] tried to override the Environment Variable that is already defined in [ConfigMap - configmap-name]
- it: should fail with dupe env in fixedEnv and env
set:
image: *image
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
env:
TZ: some_value
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [TZ] in [containers.container-name1.env] tried to override the Environment Variable that is already defined in [containers.container-name1.fixedEnv]
- it: should fail with dupe env in fixedEnv and envList
set:
image: *image
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
envList:
- name: TZ
value: some_value
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [TZ] in [containers.container-name1.envList] tried to override the Environment Variable that is already defined in [containers.container-name1.fixedEnv]
- it: should fail with dupe env in fixedEnv and envFrom configmap
set:
image: *image
configmap:
configmap-name:
enabled: true
data:
TZ: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
envFrom:
- configMapRef:
name: configmap-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [TZ] in [containers.container-name1.fixedEnv] tried to override the Environment Variable that is already defined in [ConfigMap - configmap-name]
- it: should fail with dupe env in fixedEnv and envFrom secret
set:
image: *image
secret:
secret-name:
enabled: true
data:
TZ: value
workload:
workload-name:
enabled: true
primary: true
type: Deployment
podSpec:
containers:
container-name1:
enabled: true
primary: true
imageSelector: image
probes: *probes
envFrom:
- secretRef:
name: secret-name
asserts:
- failedTemplate:
errorMessage: Container - Environment Variable [TZ] in [containers.container-name1.fixedEnv] tried to override the Environment Variable that is already defined in [Secret - secret-name]