e892b37565
**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>
473 lines
14 KiB
YAML
473 lines
14 KiB
YAML
suite: container env test
|
|
templates:
|
|
- common.yaml
|
|
release:
|
|
name: test-release-name
|
|
namespace: test-release-namespace
|
|
tests:
|
|
- it: should create the correct env
|
|
set:
|
|
some_value: value1
|
|
some_other_value: 2
|
|
image: &image
|
|
repository: nginx
|
|
tag: 1.19.0
|
|
pullPolicy: IfNotPresent
|
|
configmap:
|
|
configmap-name:
|
|
enabled: true
|
|
data:
|
|
key1: value1
|
|
key2: value2
|
|
secret:
|
|
secret-name:
|
|
enabled: true
|
|
data:
|
|
key1: value1
|
|
key2: value2
|
|
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: "{{ .Values.some_value }}"
|
|
VAR2: some_value
|
|
VAR3:
|
|
configMapKeyRef:
|
|
name: configmap-name
|
|
key: key1
|
|
VAR4:
|
|
secretKeyRef:
|
|
name: secret-name
|
|
key: key2
|
|
VAR5:
|
|
configMapKeyRef:
|
|
expandObjectName: false
|
|
name: configmap-name
|
|
key: key3
|
|
VAR6:
|
|
secretKeyRef:
|
|
expandObjectName: false
|
|
name: secret-name
|
|
key: key4
|
|
VAR7:
|
|
fieldRef:
|
|
fieldPath: metadata.name
|
|
VAR8: ""
|
|
VAR9: false
|
|
VAR10: "100000514"
|
|
VAR11: 100000514
|
|
VAR12: 1000text00514
|
|
VAR13: "100.40"
|
|
asserts:
|
|
- documentIndex: &deploymentDoc 2
|
|
isKind:
|
|
of: Deployment
|
|
- documentIndex: *deploymentDoc
|
|
isAPIVersion:
|
|
of: apps/v1
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR1
|
|
value: value1
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR2
|
|
value: some_value
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR3
|
|
valueFrom:
|
|
configMapKeyRef:
|
|
key: key1
|
|
name: test-release-name-common-test-configmap-name
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR4
|
|
valueFrom:
|
|
secretKeyRef:
|
|
key: key2
|
|
name: test-release-name-common-test-secret-name
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR5
|
|
valueFrom:
|
|
configMapKeyRef:
|
|
key: key3
|
|
name: configmap-name
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR6
|
|
valueFrom:
|
|
secretKeyRef:
|
|
key: key4
|
|
name: secret-name
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR7
|
|
valueFrom:
|
|
fieldRef:
|
|
fieldPath: metadata.name
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR8
|
|
value: ""
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR9
|
|
value: "false"
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR10
|
|
value: "100000514"
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR11
|
|
value: "100000514"
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR12
|
|
value: "1000text00514"
|
|
- documentIndex: *deploymentDoc
|
|
contains:
|
|
path: spec.template.spec.containers[0].env
|
|
content:
|
|
name: VAR13
|
|
value: "100.40"
|
|
|
|
# Failures
|
|
- it: it should fail invalid ref
|
|
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:
|
|
VAR:
|
|
invalidKeyRef: {}
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected [env] in [containers.container-name1] with a ref to have one of [configMapKeyRef, secretKeyRef, fieldRef], but got [invalidKeyRef]
|
|
|
|
- it: it should fail with more than one ref
|
|
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:
|
|
VAR:
|
|
configMapKeyRef: {}
|
|
secretKeyRef: {}
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected [env] in [containers.container-name1] with a ref to have one of [configMapKeyRef, secretKeyRef, fieldRef], but got [configMapKeyRef, secretKeyRef]
|
|
|
|
- it: it should fail with empty name in configMapKeyRef
|
|
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:
|
|
VAR:
|
|
configMapKeyRef:
|
|
name: ""
|
|
key: key
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected non-empty [containers.container-name1.env.configMapKeyRef.name]
|
|
|
|
- it: it should fail with empty key in configMapKeyRef
|
|
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:
|
|
VAR:
|
|
configMapKeyRef:
|
|
name: name
|
|
key: ""
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected non-empty [containers.container-name1.env.configMapKeyRef.key]
|
|
|
|
- it: it should fail with empty name in secretKeyRef
|
|
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:
|
|
VAR:
|
|
secretKeyRef:
|
|
name: ""
|
|
key: key
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected non-empty [containers.container-name1.env.secretKeyRef.name]
|
|
|
|
- it: it should fail with empty key in secretKeyRef
|
|
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:
|
|
VAR:
|
|
secretKeyRef:
|
|
name: name
|
|
key: ""
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected non-empty [containers.container-name1.env.secretKeyRef.key]
|
|
|
|
- it: it should fail with referenced secret not defined
|
|
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:
|
|
VAR:
|
|
secretKeyRef:
|
|
name: secret-name
|
|
key: somekey
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected in [containers.container-name1.env] the referenced Secret [secret-name] to be defined
|
|
|
|
- it: it should fail with referenced configmap not defined
|
|
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:
|
|
VAR:
|
|
configMapKeyRef:
|
|
name: configmap-name
|
|
key: somekey
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected in [containers.container-name1.env] the referenced Configmap [configmap-name] to be defined
|
|
|
|
- it: it should fail with referenced key in configmap not defined
|
|
set:
|
|
image: *image
|
|
configmap:
|
|
configmap-name:
|
|
enabled: true
|
|
data:
|
|
key1: value1
|
|
key2: value2
|
|
workload:
|
|
workload-name:
|
|
enabled: true
|
|
primary: true
|
|
type: Deployment
|
|
podSpec:
|
|
containers:
|
|
container-name1:
|
|
enabled: true
|
|
primary: true
|
|
imageSelector: image
|
|
probes: *probes
|
|
env:
|
|
VAR:
|
|
configMapKeyRef:
|
|
name: configmap-name
|
|
key: somekey
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected in [containers.container-name1.env] the referenced key [somekey] in Configmap [configmap-name] to be defined
|
|
|
|
- it: it should fail with referenced key in secret not defined
|
|
set:
|
|
image: *image
|
|
secret:
|
|
secret-name:
|
|
enabled: true
|
|
data:
|
|
key1: value1
|
|
key2: value2
|
|
workload:
|
|
workload-name:
|
|
enabled: true
|
|
primary: true
|
|
type: Deployment
|
|
podSpec:
|
|
containers:
|
|
container-name1:
|
|
enabled: true
|
|
primary: true
|
|
imageSelector: image
|
|
probes: *probes
|
|
env:
|
|
VAR:
|
|
secretKeyRef:
|
|
name: secret-name
|
|
key: somekey
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected in [containers.container-name1.env] the referenced key [somekey] in Secret [secret-name] to be defined
|
|
|
|
- it: it should fail with empty fieldPath in fieldRef
|
|
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:
|
|
VAR:
|
|
fieldRef:
|
|
fieldPath: ""
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected non-empty [containers.container-name1.env.fieldRef.fieldPath]
|
|
|
|
- it: it should fail empty expandObjectName
|
|
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:
|
|
key1:
|
|
secretKeyRef:
|
|
expandObjectName:
|
|
name: '{{ printf "secret-name" }}'
|
|
key: secret-key
|
|
asserts:
|
|
- failedTemplate:
|
|
errorMessage: Container - Expected the defined key [expandObjectName] in [env.key1] to not be empty
|