Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set unique placeholder values for each substitution #801

Merged
merged 2 commits into from
Nov 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions flux_local/manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@
SECRET_KIND = "Secret"
CONFIG_MAP_KIND = "ConfigMap"
DEFAULT_NAMESPACE = "flux-system"
VALUE_PLACEHOLDER = "..PLACEHOLDER.."
VALUE_B64_PLACEHOLDER = base64.b64encode(VALUE_PLACEHOLDER.encode())
VALUE_PLACEHOLDER_TEMPLATE = "..PLACEHOLDER_{name}.."
HELM_REPOSITORY = "HelmRepository"
GIT_REPOSITORY = "GitRepository"
OCI_REPOSITORY = "OCIRepository"
Expand Down Expand Up @@ -430,10 +429,12 @@ def parse_doc(cls, doc: dict[str, Any]) -> "Secret":
# placeholder values anyway.
if data := doc.get("data"):
for key, value in data.items():
data[key] = VALUE_B64_PLACEHOLDER
data[key] = base64.b64encode(
VALUE_PLACEHOLDER_TEMPLATE.format(name=key).encode()
)
if string_data := doc.get("stringData"):
for key, value in string_data.items():
string_data[key] = VALUE_PLACEHOLDER
string_data[key] = VALUE_PLACEHOLDER_TEMPLATE.format(name=key)
return Secret(
name=name, namespace=namespace, data=data, string_data=string_data
)
Expand Down
4 changes: 2 additions & 2 deletions flux_local/values.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
CONFIG_MAP_KIND,
ConfigMap,
Secret,
VALUE_PLACEHOLDER,
VALUE_PLACEHOLDER_TEMPLATE,
ValuesReference,
)
from .exceptions import HelmException, InputException, InvalidValuesReference
Expand Down Expand Up @@ -163,7 +163,7 @@ def _lookup_value_reference(
# When a target path is specified, the value is expected to be
# a simple value type. Create a synthetic placeholder value, otherwise
# there is nothing to replace.
return VALUE_PLACEHOLDER
return VALUE_PLACEHOLDER_TEMPLATE.format(name=ref.name)
return None

elif (found_value := found_data.get(ref.values_key)) is None:
Expand Down
6 changes: 3 additions & 3 deletions tests/__snapshots__/test_values.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
'tag': '7.0.6',
}),
'tls': dict({
'crt': '..PLACEHOLDER..',
'crt': '..PLACEHOLDER_podinfo-tls-values..',
}),
})
# ---
Expand All @@ -32,8 +32,8 @@
'mode': 'true',
}),
'oauth': dict({
'clientId': '..PLACEHOLDER..',
'clientSecret': '..PLACEHOLDER..',
'clientId': '..PLACEHOLDER_tailscale-operator..',
'clientSecret': '..PLACEHOLDER_tailscale-operator..',
}),
'operatorConfig': dict({
'defaultTags': list([
Expand Down
6 changes: 3 additions & 3 deletions tests/test_values.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def test_values_references_with_missing_secret() -> None:
assert updated_hr.values == {
"test": "test",
"target": {
"path": "..PLACEHOLDER..",
"path": "..PLACEHOLDER_test-values-secret..",
},
}

Expand Down Expand Up @@ -437,8 +437,8 @@ def test_values_references_secret() -> None:
assert updated_hr.values == {
"test": "test",
"target": {
"path1": "..PLACEHOLDER..",
"path2": "..PLACEHOLDER..",
"path1": "..PLACEHOLDER_some-key1..",
"path2": "..PLACEHOLDER_some-key2..",
},
}

Expand Down
28 changes: 28 additions & 0 deletions tests/testdata/cluster/apps/prod/certificates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,31 @@ spec:
- "${SECRET_DOMAIN2}"
- "*.${SECRET_DOMAIN2}"
- ${cluster_label}
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: "${SECRET_DOMAIN3/./-}-staging"
spec:
secretName: "${SECRET_DOMAIN3/./-}-staging-tls"
issuerRef:
name: letsencrypt-staging
kind: ClusterIssuer
commonName: "${SECRET_DOMAIN3}"
dnsNames:
- "${SECRET_DOMAIN3}"
- "*.${SECRET_DOMAIN3}"
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: "${SECRET_DOMAIN4/./-}-staging"
spec:
secretName: "${SECRET_DOMAIN4/./-}-staging-tls"
issuerRef:
name: letsencrypt-staging
kind: ClusterIssuer
commonName: "${SECRET_DOMAIN4}"
dnsNames:
- "${SECRET_DOMAIN4}"
- "*.${SECRET_DOMAIN4}"
2 changes: 2 additions & 0 deletions tests/testdata/cluster/clusters/prod/apps.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ spec:
substituteFrom:
- kind: ConfigMap
name: cluster-config
- kind: Secret
name: cluster-secrets
prune: true
wait: true
timeout: 5m0s
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
apiVersion: v1
kind: Secret
metadata:
name: cluster-secrets
namespace: flux-system
stringData:
SECRET_DOMAIN3: SECRET
SECRET_DOMAIN4: SECRET
170 changes: 168 additions & 2 deletions tests/tool/__snapshots__/test_build.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -1149,8 +1149,8 @@
config.kubernetes.io/index: '2'
internal.config.kubernetes.io/index: '2'
stringData:
client_id: ..PLACEHOLDER..
client_secret: ..PLACEHOLDER..
client_id: ..PLACEHOLDER_tailscale-operator..
client_secret: ..PLACEHOLDER_tailscale-operator..
---
# Source: tailscale-operator/templates/apiserverproxy-rbac.yaml
# Copyright (c) Tailscale Inc & AUTHORS
Expand Down Expand Up @@ -2943,6 +2943,46 @@
kind: ClusterIssuer
name: letsencrypt-staging
secretName: other-com-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN3..-staging
annotations:
config.kubernetes.io/index: '5'
internal.config.kubernetes.io/index: '5'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN3..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN3..
- '*...PLACEHOLDER_SECRET_DOMAIN3..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN3..-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN4..-staging
annotations:
config.kubernetes.io/index: '6'
internal.config.kubernetes.io/index: '6'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN4..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN4..
- '*...PLACEHOLDER_SECRET_DOMAIN4..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN4..-staging-tls

---
apiVersion: kustomize.toolkit.fluxcd.io/v1
Expand All @@ -2967,6 +3007,8 @@
substituteFrom:
- kind: ConfigMap
name: cluster-config
- kind: Secret
name: cluster-secrets
prune: true
sourceRef:
kind: GitRepository
Expand Down Expand Up @@ -4686,6 +4728,46 @@
kind: ClusterIssuer
name: letsencrypt-staging
secretName: other-com-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN3..-staging
annotations:
config.kubernetes.io/index: '5'
internal.config.kubernetes.io/index: '5'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN3..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN3..
- '*...PLACEHOLDER_SECRET_DOMAIN3..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN3..-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN4..-staging
annotations:
config.kubernetes.io/index: '6'
internal.config.kubernetes.io/index: '6'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN4..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN4..
- '*...PLACEHOLDER_SECRET_DOMAIN4..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN4..-staging-tls

---
apiVersion: kustomize.toolkit.fluxcd.io/v1
Expand All @@ -4710,6 +4792,8 @@
substituteFrom:
- kind: ConfigMap
name: cluster-config
- kind: Secret
name: cluster-secrets
prune: true
sourceRef:
kind: GitRepository
Expand Down Expand Up @@ -6529,6 +6613,46 @@
kind: ClusterIssuer
name: letsencrypt-staging
secretName: other-com-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN3..-staging
annotations:
config.kubernetes.io/index: '5'
internal.config.kubernetes.io/index: '5'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN3..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN3..
- '*...PLACEHOLDER_SECRET_DOMAIN3..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN3..-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN4..-staging
annotations:
config.kubernetes.io/index: '6'
internal.config.kubernetes.io/index: '6'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN4..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN4..
- '*...PLACEHOLDER_SECRET_DOMAIN4..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN4..-staging-tls


'''
Expand Down Expand Up @@ -6642,6 +6766,46 @@
kind: ClusterIssuer
name: letsencrypt-staging
secretName: other-com-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN3..-staging
annotations:
config.kubernetes.io/index: '5'
internal.config.kubernetes.io/index: '5'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN3..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN3..
- '*...PLACEHOLDER_SECRET_DOMAIN3..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN3..-staging-tls
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
kustomize.toolkit.fluxcd.io/name: apps
kustomize.toolkit.fluxcd.io/namespace: flux-system
name: -.PLACEHOLDER_SECRET_DOMAIN4..-staging
annotations:
config.kubernetes.io/index: '6'
internal.config.kubernetes.io/index: '6'
spec:
commonName: ..PLACEHOLDER_SECRET_DOMAIN4..
dnsNames:
- ..PLACEHOLDER_SECRET_DOMAIN4..
- '*...PLACEHOLDER_SECRET_DOMAIN4..'
issuerRef:
kind: ClusterIssuer
name: letsencrypt-staging
secretName: -.PLACEHOLDER_SECRET_DOMAIN4..-staging-tls

---
apiVersion: kustomize.toolkit.fluxcd.io/v1
Expand All @@ -6666,6 +6830,8 @@
substituteFrom:
- kind: ConfigMap
name: cluster-config
- kind: Secret
name: cluster-secrets
prune: true
sourceRef:
kind: GitRepository
Expand Down
Loading
Loading