external-dns
external-dns copied to clipboard
kubernetes-sigs
Helm documentation includes no examples for providers
What happened: I tried to deploy external-dns via the provided helm chart
What you expected to happen: Setting provider values should result in them being set in the container. Properly documented examples should be provided.
Currently the documentation ends up in a loop on itself. The documentation on the main helm README shows only the generic 'provider' value option with no sub options. It then links to the non-helm version of the external-dns deployment when making any references on instructions on how to set up a provider. The non-helm documentation does not provide any insight into how to set the helm spec: values.yaml per provider.
Additionally after looking through most of the helm chart templates, I don't even see a proper area where provider specific spec can be included, the only portion I see supported at all at the moment is for the provider name to be set. This does not provide anywhere near a simple deployment process even if documentation were provided. At minimum the helm values.yaml should not force the entire extravars to provide provider api keys and other sensitive data when there are much safer ways to do this (secrets etc).
How to reproduce it (as minimally and precisely as possible):
spec:
provider:
name: cloudflare
email: [email protected]
apiKey:
Anything else we need to know?:
Environment:
- External-DNS version (use
external-dns --version): 1.14.4 - DNS provider: cloudflare
- Others:
After digging through other issue tickets here I was able to piece together a proper values.yaml for cloudflare, however my initial bug/issue still stands in that there is no formal documentation around this, only what can be gleaned from others/issues.
provider:
name: cloudflare
env:
- name: CF_API_KEY
valueFrom:
secretKeyRef:
name: cloudflare-api-key
key: apiKey
- name: CF_API_EMAIL
value: "[email protected]"
