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

Helm documentation includes no examples for providers #4396

Closed
RaceFPV opened this issue Apr 19, 2024 · 3 comments · Fixed by #4405
Closed

Helm documentation includes no examples for providers #4396

RaceFPV opened this issue Apr 19, 2024 · 3 comments · Fixed by #4405
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@RaceFPV
Copy link

RaceFPV commented Apr 19, 2024

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: example@example.com
apiKey:

Anything else we need to know?:

Environment:

  • External-DNS version (use external-dns --version): 1.14.4
  • DNS provider: cloudflare
  • Others:
@RaceFPV RaceFPV added the kind/bug Categorizes issue or PR as related to a bug. label Apr 19, 2024
@RaceFPV
Copy link
Author

RaceFPV commented Apr 19, 2024

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: "example@example.com"

@omerap12
Copy link
Contributor

omerap12 commented Apr 22, 2024

Hey, can I take this?

@omerap12
Copy link
Contributor

/assign omerap12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants