-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
docs: add setup example with helm chart on some providers #4405
docs: add setup example with helm chart on some providers #4405
Conversation
…hart documentation
|
Welcome @omerap12! |
Hi @omerap12. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
charts/external-dns/README.md
Outdated
Next, create a values.yaml file to configure ExternalDNS to use CloudFlare as the DNS provider. This file should include the necessary environment variables: | ||
```shell |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Next, create a values.yaml file to configure ExternalDNS to use CloudFlare as the DNS provider. This file should include the necessary environment variables: | |
```shell | |
Next, create a values.yaml file to configure ExternalDNS to use CloudFlare as the DNS provider. This file should include the necessary environment variables: | |
```shell |
Thanks for this PR. @stevehipwell Wdyt ? |
Hey @mloiseleur, no problem! |
@mloiseleur I was thinking the same thing. My gut instinct is that this documentation should live in the provider documentation, although I think the chart documentation could have links to the provider documentation where it's been written. FYI @omerap12 you need to modify the README template (README.md.gotmpl) and not the README file if you're updating the chart docs. |
@stevehipwell understood. |
… docs/tutorials/cloudflare.md
@mloiseleur Done |
/lgtm |
/retitle docs: add setup example with helm chart on some providers |
@omerap12 this looks good to me but you'll need to run |
Done |
/ok-to-test |
This LGTM, @mloiseleur you can approve when you're ready. /lgtm |
This will clearly help users 👍. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mloiseleur The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
…rnal-dns to v0.14.2@3fcad62 by renovate (#22163) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [registry.k8s.io/external-dns/external-dns](https://togithub.com/kubernetes-sigs/external-dns) | patch | `v0.14.1` -> `v0.14.2` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>kubernetes-sigs/external-dns (registry.k8s.io/external-dns/external-dns)</summary> ### [`v0.14.2`](https://togithub.com/kubernetes-sigs/external-dns/releases/tag/v0.14.2) [Compare Source](https://togithub.com/kubernetes-sigs/external-dns/compare/v0.14.1...v0.14.2) #### What's Changed - kustomize-v0.14.1 by [@​Raffo](https://togithub.com/Raffo) in [https://github.com/kubernetes-sigs/external-dns/pull/4331](https://togithub.com/kubernetes-sigs/external-dns/pull/4331) - replace all links in tutorials for v0.14.1 by [@​Raffo](https://togithub.com/Raffo) in [https://github.com/kubernetes-sigs/external-dns/pull/4332](https://togithub.com/kubernetes-sigs/external-dns/pull/4332) - chore: upgrade ExternalDNS to go 1.22 by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4318](https://togithub.com/kubernetes-sigs/external-dns/pull/4318) - build(deps): bump the dev-dependencies group with 13 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4329](https://togithub.com/kubernetes-sigs/external-dns/pull/4329) - build(deps): bump the dev-dependencies group with 5 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4334](https://togithub.com/kubernetes-sigs/external-dns/pull/4334) - build(deps): bump the dev-dependencies group with 9 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4349](https://togithub.com/kubernetes-sigs/external-dns/pull/4349) - build(deps): bump the dev-dependencies group with 1 update by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4341](https://togithub.com/kubernetes-sigs/external-dns/pull/4341) - Add `dnsendpoint` CRD to Helm chart by [@​onedr0p](https://togithub.com/onedr0p) in [https://github.com/kubernetes-sigs/external-dns/pull/4322](https://togithub.com/kubernetes-sigs/external-dns/pull/4322) - build(deps): bump the dev-dependencies group with 13 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4361](https://togithub.com/kubernetes-sigs/external-dns/pull/4361) - build(deps): bump GrantBirki/json-yaml-validate from 2.6.1 to 2.6.2 in the dev-dependencies group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4364](https://togithub.com/kubernetes-sigs/external-dns/pull/4364) - chore(chart): Released chart for v0.14.1 by [@​stevehipwell](https://togithub.com/stevehipwell) in [https://github.com/kubernetes-sigs/external-dns/pull/4357](https://togithub.com/kubernetes-sigs/external-dns/pull/4357) - chore: alphabetical order on providers by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4350](https://togithub.com/kubernetes-sigs/external-dns/pull/4350) - doc: advertise current plan on providers by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4365](https://togithub.com/kubernetes-sigs/external-dns/pull/4365) - Fix(ipv6): support ipv6 shortener and expander equal by [@​dongjiang1989](https://togithub.com/dongjiang1989) in [https://github.com/kubernetes-sigs/external-dns/pull/4351](https://togithub.com/kubernetes-sigs/external-dns/pull/4351) - feat(WebhookProvider): Let WebhookProvider return `SoftError` on response status codes >= 500 by [@​SimonKienzler](https://togithub.com/SimonKienzler) in [https://github.com/kubernetes-sigs/external-dns/pull/4319](https://togithub.com/kubernetes-sigs/external-dns/pull/4319) - Webhook provider: Use correct error gauge in `AdjustEndpoints()` func by [@​SimonKienzler](https://togithub.com/SimonKienzler) in [https://github.com/kubernetes-sigs/external-dns/pull/4374](https://togithub.com/kubernetes-sigs/external-dns/pull/4374) - build(deps): bump the dev-dependencies group with 18 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4381](https://togithub.com/kubernetes-sigs/external-dns/pull/4381) - Add exclude domains value in Chart by [@​bford-evs](https://togithub.com/bford-evs) in [https://github.com/kubernetes-sigs/external-dns/pull/4380](https://togithub.com/kubernetes-sigs/external-dns/pull/4380) - docs(aws): fix typo and upgrade cleanup flow by [@​franzudev](https://togithub.com/franzudev) in [https://github.com/kubernetes-sigs/external-dns/pull/4389](https://togithub.com/kubernetes-sigs/external-dns/pull/4389) - docs(gke): detail how to configure workload identity by [@​userbradley](https://togithub.com/userbradley) in [https://github.com/kubernetes-sigs/external-dns/pull/4373](https://togithub.com/kubernetes-sigs/external-dns/pull/4373) - chore(ci): fix failing test by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4397](https://togithub.com/kubernetes-sigs/external-dns/pull/4397) - chore: Update controller-tools version to v0.14.0 by [@​dongjiang1989](https://togithub.com/dongjiang1989) in [https://github.com/kubernetes-sigs/external-dns/pull/4400](https://togithub.com/kubernetes-sigs/external-dns/pull/4400) - chore(ci): update golangci-lint to v1.57.2 by [@​dongjiang1989](https://togithub.com/dongjiang1989) in [https://github.com/kubernetes-sigs/external-dns/pull/4406](https://togithub.com/kubernetes-sigs/external-dns/pull/4406) - chore: upgrade ExternalDNS to go 1.22.2 by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4414](https://togithub.com/kubernetes-sigs/external-dns/pull/4414) - build(deps): bump the dev-dependencies group across 1 directory with 4 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4412](https://togithub.com/kubernetes-sigs/external-dns/pull/4412) - build(deps): bump the dev-dependencies group across 1 directory with 24 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4416](https://togithub.com/kubernetes-sigs/external-dns/pull/4416) - custom Azure Active Directory Authority Host by [@​Jeremy-Boyle](https://togithub.com/Jeremy-Boyle) in [https://github.com/kubernetes-sigs/external-dns/pull/4210](https://togithub.com/kubernetes-sigs/external-dns/pull/4210) - feat(DNSimple): User API tokens by [@​IntegralProgrammer](https://togithub.com/IntegralProgrammer) in [https://github.com/kubernetes-sigs/external-dns/pull/4274](https://togithub.com/kubernetes-sigs/external-dns/pull/4274) - docs: annotation placement for azuredns tutorial by [@​jonas-budde](https://togithub.com/jonas-budde) in [https://github.com/kubernetes-sigs/external-dns/pull/4415](https://togithub.com/kubernetes-sigs/external-dns/pull/4415) - feat(azure): add zone name filter for Azure Private DNS by [@​khuedoan](https://togithub.com/khuedoan) in [https://github.com/kubernetes-sigs/external-dns/pull/4346](https://togithub.com/kubernetes-sigs/external-dns/pull/4346) - test: detect no change necessary with provider specific config by [@​szuecs](https://togithub.com/szuecs) in [https://github.com/kubernetes-sigs/external-dns/pull/4189](https://togithub.com/kubernetes-sigs/external-dns/pull/4189) - docs: add setup example with helm chart on some providers by [@​omerap12](https://togithub.com/omerap12) in [https://github.com/kubernetes-sigs/external-dns/pull/4405](https://togithub.com/kubernetes-sigs/external-dns/pull/4405) - test: controller run() and successfully shutdown by [@​szuecs](https://togithub.com/szuecs) in [https://github.com/kubernetes-sigs/external-dns/pull/3639](https://togithub.com/kubernetes-sigs/external-dns/pull/3639) - fix syntax on cloudflare externalDNS by [@​ilyesAj](https://togithub.com/ilyesAj) in [https://github.com/kubernetes-sigs/external-dns/pull/4436](https://togithub.com/kubernetes-sigs/external-dns/pull/4436) - build(deps): bump the dev-dependencies group across 1 directory with 11 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4440](https://togithub.com/kubernetes-sigs/external-dns/pull/4440) - chore(chart): Adding extra containers by [@​omerap12](https://togithub.com/omerap12) in [https://github.com/kubernetes-sigs/external-dns/pull/4432](https://togithub.com/kubernetes-sigs/external-dns/pull/4432) - aws: add ca-west-1 region by [@​jeremy-albuixech](https://togithub.com/jeremy-albuixech) in [https://github.com/kubernetes-sigs/external-dns/pull/4444](https://togithub.com/kubernetes-sigs/external-dns/pull/4444) - fix: duplicated endpoint per hosted zone by [@​leonardocaylent](https://togithub.com/leonardocaylent) in [https://github.com/kubernetes-sigs/external-dns/pull/4296](https://togithub.com/kubernetes-sigs/external-dns/pull/4296) - build(deps): bump actions/checkout from 4.1.4 to 4.1.5 in the dev-dependencies group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4438](https://togithub.com/kubernetes-sigs/external-dns/pull/4438) - Add IPv6 AAAA record support to PiHole provider by [@​PseudoResonance](https://togithub.com/PseudoResonance) in [https://github.com/kubernetes-sigs/external-dns/pull/4324](https://togithub.com/kubernetes-sigs/external-dns/pull/4324) - fix: soft error on cloudflare rate limits by [@​ebachle](https://togithub.com/ebachle) in [https://github.com/kubernetes-sigs/external-dns/pull/4437](https://togithub.com/kubernetes-sigs/external-dns/pull/4437) - Update cloudflare.md by [@​mfreeman451](https://togithub.com/mfreeman451) in [https://github.com/kubernetes-sigs/external-dns/pull/4449](https://togithub.com/kubernetes-sigs/external-dns/pull/4449) - Fix headings, whitespace by [@​stefanlasiewski](https://togithub.com/stefanlasiewski) in [https://github.com/kubernetes-sigs/external-dns/pull/4457](https://togithub.com/kubernetes-sigs/external-dns/pull/4457) - docs: add reference to anexia webhook provider by [@​ProbstenHias](https://togithub.com/ProbstenHias) in [https://github.com/kubernetes-sigs/external-dns/pull/4441](https://togithub.com/kubernetes-sigs/external-dns/pull/4441) - fix logline mentioning plugin api by [@​Raffo](https://togithub.com/Raffo) in [https://github.com/kubernetes-sigs/external-dns/pull/4459](https://togithub.com/kubernetes-sigs/external-dns/pull/4459) - docs: lint gke docs + make terraform config more secure by [@​DrFaust92](https://togithub.com/DrFaust92) in [https://github.com/kubernetes-sigs/external-dns/pull/4456](https://togithub.com/kubernetes-sigs/external-dns/pull/4456) - build(deps): bump action-stars/install-tool-from-github-release from 0.2.2 to 0.2.3 in the dev-dependencies group by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4464](https://togithub.com/kubernetes-sigs/external-dns/pull/4464) - changed documentation to include more details description when using API Tokens by [@​rhjensen79](https://togithub.com/rhjensen79) in [https://github.com/kubernetes-sigs/external-dns/pull/4474](https://togithub.com/kubernetes-sigs/external-dns/pull/4474) - fix: add clarification to endpoint unit tests by [@​leonardocaylent](https://togithub.com/leonardocaylent) in [https://github.com/kubernetes-sigs/external-dns/pull/4462](https://togithub.com/kubernetes-sigs/external-dns/pull/4462) - build(deps): bump the dev-dependencies group across 1 directory with 19 updates by [@​mloiseleur](https://togithub.com/mloiseleur) in [https://github.com/kubernetes-sigs/external-dns/pull/4476](https://togithub.com/kubernetes-sigs/external-dns/pull/4476) - build(deps): bump the dev-dependencies group across 1 directory with 19 updates by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/kubernetes-sigs/external-dns/pull/4475](https://togithub.com/kubernetes-sigs/external-dns/pull/4475) #### New Contributors - [@​onedr0p](https://togithub.com/onedr0p) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4322](https://togithub.com/kubernetes-sigs/external-dns/pull/4322) - [@​SimonKienzler](https://togithub.com/SimonKienzler) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4319](https://togithub.com/kubernetes-sigs/external-dns/pull/4319) - [@​bford-evs](https://togithub.com/bford-evs) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4380](https://togithub.com/kubernetes-sigs/external-dns/pull/4380) - [@​franzudev](https://togithub.com/franzudev) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4389](https://togithub.com/kubernetes-sigs/external-dns/pull/4389) - [@​userbradley](https://togithub.com/userbradley) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4373](https://togithub.com/kubernetes-sigs/external-dns/pull/4373) - [@​Jeremy-Boyle](https://togithub.com/Jeremy-Boyle) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4210](https://togithub.com/kubernetes-sigs/external-dns/pull/4210) - [@​IntegralProgrammer](https://togithub.com/IntegralProgrammer) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4274](https://togithub.com/kubernetes-sigs/external-dns/pull/4274) - [@​jonas-budde](https://togithub.com/jonas-budde) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4415](https://togithub.com/kubernetes-sigs/external-dns/pull/4415) - [@​khuedoan](https://togithub.com/khuedoan) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4346](https://togithub.com/kubernetes-sigs/external-dns/pull/4346) - [@​omerap12](https://togithub.com/omerap12) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4405](https://togithub.com/kubernetes-sigs/external-dns/pull/4405) - [@​ilyesAj](https://togithub.com/ilyesAj) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4436](https://togithub.com/kubernetes-sigs/external-dns/pull/4436) - [@​jeremy-albuixech](https://togithub.com/jeremy-albuixech) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4444](https://togithub.com/kubernetes-sigs/external-dns/pull/4444) - [@​leonardocaylent](https://togithub.com/leonardocaylent) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4296](https://togithub.com/kubernetes-sigs/external-dns/pull/4296) - [@​PseudoResonance](https://togithub.com/PseudoResonance) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4324](https://togithub.com/kubernetes-sigs/external-dns/pull/4324) - [@​ebachle](https://togithub.com/ebachle) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4437](https://togithub.com/kubernetes-sigs/external-dns/pull/4437) - [@​mfreeman451](https://togithub.com/mfreeman451) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4449](https://togithub.com/kubernetes-sigs/external-dns/pull/4449) - [@​ProbstenHias](https://togithub.com/ProbstenHias) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4441](https://togithub.com/kubernetes-sigs/external-dns/pull/4441) - [@​DrFaust92](https://togithub.com/DrFaust92) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4456](https://togithub.com/kubernetes-sigs/external-dns/pull/4456) - [@​rhjensen79](https://togithub.com/rhjensen79) made their first contribution in [https://github.com/kubernetes-sigs/external-dns/pull/4474](https://togithub.com/kubernetes-sigs/external-dns/pull/4474) **Full Changelog**: kubernetes-sigs/external-dns@v0.14.1...v0.14.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM2OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbImF1dG9tZXJnZSIsInVwZGF0ZS9kb2NrZXIvZ2VuZXJhbC9ub24tbWFqb3IiXX0=-->
Description
Updates the Helm chart documentation for ExternalDNS to include a detailed example of how to configure ExternalDNS with the CloudFlare provider.
Fixes #4396
Checklist