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.

Sign up for GitHub

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

Jump to bottom

docs: add setup example with helm chart on some providers #4405

Merged
merged 29 commits into from
Apr 30, 2024
Merged

docs: add setup example with helm chart on some providers #4405

merged 29 commits into from
Apr 30, 2024

Conversation

omerap12
Copy link
Contributor

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

  • Unit tests updated
  • End user documentation updated

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Apr 23, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 23, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @omerap12!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 23, 2024
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 23, 2024
mloiseleur
mloiseleur reviewed Apr 23, 2024
View reviewed changes
charts/external-dns/README.md Outdated
Comment on lines 46 to 47
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

@mloiseleur
Copy link
Contributor

Thanks for this PR.
mmmh 🤔 I'm unsure about where this should go. Maybe this kind of documentation should go to the provider documentation page, not the chart.

@stevehipwell Wdyt ?

@omerap12
Copy link
Contributor Author

Hey @mloiseleur, no problem!
Initially, I was considering adding this type of documentation to each provider, or at least to most of them.
I'm happy to add this to the provider docs instead, if that works better.

@stevehipwell
Copy link
Contributor

@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.

@omerap12
Copy link
Contributor Author

omerap12 commented Apr 23, 2024 •
edited
Loading

@stevehipwell understood.
So how about I'll add this documentation in the associate provider docs and add links to the provider documentation where it's been written to the README template?

@omerap12
Copy link
Contributor Author

@mloiseleur Done

@mloiseleur
Copy link
Contributor

/lgtm
@stevehipwell Would you please take a look for approval ?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 27, 2024
@mloiseleur
Copy link
Contributor

/retitle docs: add setup example with helm chart on some providers

@k8s-ci-robot k8s-ci-robot changed the title docs: Add setup example for CloudFlare provider in Helm chart docs: add setup example with helm chart on some providers Apr 27, 2024
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 29, 2024
@stevehipwell
Copy link
Contributor

@omerap12 this looks good to me but you'll need to run helm-docs locally to update the README so the checks will pass.

@omerap12
Copy link
Contributor Author

@omerap12 this looks good to me but you'll need to run helm-docs locally to update the README so the checks will pass.

Done

@mloiseleur
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 30, 2024
@stevehipwell
Copy link
Contributor

This LGTM, @mloiseleur you can approve when you're ready.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 30, 2024
@mloiseleur
Copy link
Contributor

This will clearly help users 👍.
/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 30, 2024
@k8s-ci-robot k8s-ci-robot merged commit b416018 into kubernetes-sigs:master Apr 30, 2024
15 checks passed
truecharts-admin added a commit to truecharts/charts that referenced this pull request May 17, 2024
@truecharts-admin
chore(deps): update container image registry.k8s.io/external-dns/exte…
a5aaa11 
…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://github.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://github.com/kubernetes-sigs/external-dns/releases/tag/v0.14.2)

[Compare
Source](https://github.com/kubernetes-sigs/external-dns/compare/v0.14.1...v0.14.2)

#### What's Changed

- kustomize-v0.14.1 by [@&#8203;Raffo](https://github.com/Raffo) in
[kubernetes-sigs/external-dns#4331
- replace all links in tutorials for v0.14.1 by
[@&#8203;Raffo](https://github.com/Raffo) in
[kubernetes-sigs/external-dns#4332
- chore: upgrade ExternalDNS to go 1.22 by
[@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4318
- build(deps): bump the dev-dependencies group with 13 updates by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4329
- build(deps): bump the dev-dependencies group with 5 updates by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4334
- build(deps): bump the dev-dependencies group with 9 updates by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4349
- build(deps): bump the dev-dependencies group with 1 update by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4341
- Add `dnsendpoint` CRD to Helm chart by
[@&#8203;onedr0p](https://github.com/onedr0p) in
[kubernetes-sigs/external-dns#4322
- build(deps): bump the dev-dependencies group with 13 updates by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4361
- build(deps): bump GrantBirki/json-yaml-validate from 2.6.1 to 2.6.2 in
the dev-dependencies group by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4364
- chore(chart): Released chart for v0.14.1 by
[@&#8203;stevehipwell](https://github.com/stevehipwell) in
[kubernetes-sigs/external-dns#4357
- chore: alphabetical order on providers by
[@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4350
- doc: advertise current plan on providers by
[@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4365
- Fix(ipv6): support ipv6 shortener and expander equal by
[@&#8203;dongjiang1989](https://github.com/dongjiang1989) in
[kubernetes-sigs/external-dns#4351
- feat(WebhookProvider): Let WebhookProvider return `SoftError` on
response status codes >= 500 by
[@&#8203;SimonKienzler](https://github.com/SimonKienzler) in
[kubernetes-sigs/external-dns#4319
- Webhook provider: Use correct error gauge in `AdjustEndpoints()` func
by [@&#8203;SimonKienzler](https://github.com/SimonKienzler) in
[kubernetes-sigs/external-dns#4374
- build(deps): bump the dev-dependencies group with 18 updates by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4381
- Add exclude domains value in Chart by
[@&#8203;bford-evs](https://github.com/bford-evs) in
[kubernetes-sigs/external-dns#4380
- docs(aws): fix typo and upgrade cleanup flow by
[@&#8203;franzudev](https://github.com/franzudev) in
[kubernetes-sigs/external-dns#4389
- docs(gke): detail how to configure workload identity by
[@&#8203;userbradley](https://github.com/userbradley) in
[kubernetes-sigs/external-dns#4373
- chore(ci): fix failing test by
[@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4397
- chore: Update controller-tools version to v0.14.0 by
[@&#8203;dongjiang1989](https://github.com/dongjiang1989) in
[kubernetes-sigs/external-dns#4400
- chore(ci): update golangci-lint to v1.57.2 by
[@&#8203;dongjiang1989](https://github.com/dongjiang1989) in
[kubernetes-sigs/external-dns#4406
- chore: upgrade ExternalDNS to go 1.22.2 by
[@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4414
- build(deps): bump the dev-dependencies group across 1 directory with 4
updates by [@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4412
- build(deps): bump the dev-dependencies group across 1 directory with
24 updates by [@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4416
- custom Azure Active Directory Authority Host by
[@&#8203;Jeremy-Boyle](https://github.com/Jeremy-Boyle) in
[kubernetes-sigs/external-dns#4210
- feat(DNSimple): User API tokens by
[@&#8203;IntegralProgrammer](https://github.com/IntegralProgrammer) in
[kubernetes-sigs/external-dns#4274
- docs: annotation placement for azuredns tutorial by
[@&#8203;jonas-budde](https://github.com/jonas-budde) in
[kubernetes-sigs/external-dns#4415
- feat(azure): add zone name filter for Azure Private DNS by
[@&#8203;khuedoan](https://github.com/khuedoan) in
[kubernetes-sigs/external-dns#4346
- test: detect no change necessary with provider specific config by
[@&#8203;szuecs](https://github.com/szuecs) in
[kubernetes-sigs/external-dns#4189
- docs: add setup example with helm chart on some providers by
[@&#8203;omerap12](https://github.com/omerap12) in
[kubernetes-sigs/external-dns#4405
- test: controller run() and successfully shutdown by
[@&#8203;szuecs](https://github.com/szuecs) in
[kubernetes-sigs/external-dns#3639
- fix syntax on cloudflare externalDNS by
[@&#8203;ilyesAj](https://github.com/ilyesAj) in
[kubernetes-sigs/external-dns#4436
- build(deps): bump the dev-dependencies group across 1 directory with
11 updates by [@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4440
- chore(chart): Adding extra containers by
[@&#8203;omerap12](https://github.com/omerap12) in
[kubernetes-sigs/external-dns#4432
- aws: add ca-west-1 region by
[@&#8203;jeremy-albuixech](https://github.com/jeremy-albuixech) in
[kubernetes-sigs/external-dns#4444
- fix: duplicated endpoint per hosted zone by
[@&#8203;leonardocaylent](https://github.com/leonardocaylent) in
[kubernetes-sigs/external-dns#4296
- build(deps): bump actions/checkout from 4.1.4 to 4.1.5 in the
dev-dependencies group by
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4438
- Add IPv6 AAAA record support to PiHole provider by
[@&#8203;PseudoResonance](https://github.com/PseudoResonance) in
[kubernetes-sigs/external-dns#4324
- fix: soft error on cloudflare rate limits by
[@&#8203;ebachle](https://github.com/ebachle) in
[kubernetes-sigs/external-dns#4437
- Update cloudflare.md by
[@&#8203;mfreeman451](https://github.com/mfreeman451) in
[kubernetes-sigs/external-dns#4449
- Fix headings, whitespace by
[@&#8203;stefanlasiewski](https://github.com/stefanlasiewski) in
[kubernetes-sigs/external-dns#4457
- docs: add reference to anexia webhook provider by
[@&#8203;ProbstenHias](https://github.com/ProbstenHias) in
[kubernetes-sigs/external-dns#4441
- fix logline mentioning plugin api by
[@&#8203;Raffo](https://github.com/Raffo) in
[kubernetes-sigs/external-dns#4459
- docs: lint gke docs + make terraform config more secure by
[@&#8203;DrFaust92](https://github.com/DrFaust92) in
[kubernetes-sigs/external-dns#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
[@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4464
- changed documentation to include more details description when using
API Tokens by [@&#8203;rhjensen79](https://github.com/rhjensen79) in
[kubernetes-sigs/external-dns#4474
- fix: add clarification to endpoint unit tests by
[@&#8203;leonardocaylent](https://github.com/leonardocaylent) in
[kubernetes-sigs/external-dns#4462
- build(deps): bump the dev-dependencies group across 1 directory with
19 updates by [@&#8203;mloiseleur](https://github.com/mloiseleur) in
[kubernetes-sigs/external-dns#4476
- build(deps): bump the dev-dependencies group across 1 directory with
19 updates by [@&#8203;dependabot](https://github.com/dependabot) in
[kubernetes-sigs/external-dns#4475

#### New Contributors

- [@&#8203;onedr0p](https://github.com/onedr0p) made their first
contribution in
[kubernetes-sigs/external-dns#4322
- [@&#8203;SimonKienzler](https://github.com/SimonKienzler) made their
first contribution in
[kubernetes-sigs/external-dns#4319
- [@&#8203;bford-evs](https://github.com/bford-evs) made their first
contribution in
[kubernetes-sigs/external-dns#4380
- [@&#8203;franzudev](https://github.com/franzudev) made their first
contribution in
[kubernetes-sigs/external-dns#4389
- [@&#8203;userbradley](https://github.com/userbradley) made their
first contribution in
[kubernetes-sigs/external-dns#4373
- [@&#8203;Jeremy-Boyle](https://github.com/Jeremy-Boyle) made their
first contribution in
[kubernetes-sigs/external-dns#4210
- [@&#8203;IntegralProgrammer](https://github.com/IntegralProgrammer)
made their first contribution in
[kubernetes-sigs/external-dns#4274
- [@&#8203;jonas-budde](https://github.com/jonas-budde) made their
first contribution in
[kubernetes-sigs/external-dns#4415
- [@&#8203;khuedoan](https://github.com/khuedoan) made their first
contribution in
[kubernetes-sigs/external-dns#4346
- [@&#8203;omerap12](https://github.com/omerap12) made their first
contribution in
[kubernetes-sigs/external-dns#4405
- [@&#8203;ilyesAj](https://github.com/ilyesAj) made their first
contribution in
[kubernetes-sigs/external-dns#4436
- [@&#8203;jeremy-albuixech](https://github.com/jeremy-albuixech) made
their first contribution in
[kubernetes-sigs/external-dns#4444
- [@&#8203;leonardocaylent](https://github.com/leonardocaylent) made
their first contribution in
[kubernetes-sigs/external-dns#4296
- [@&#8203;PseudoResonance](https://github.com/PseudoResonance) made
their first contribution in
[kubernetes-sigs/external-dns#4324
- [@&#8203;ebachle](https://github.com/ebachle) made their first
contribution in
[kubernetes-sigs/external-dns#4437
- [@&#8203;mfreeman451](https://github.com/mfreeman451) made their
first contribution in
[kubernetes-sigs/external-dns#4449
- [@&#8203;ProbstenHias](https://github.com/ProbstenHias) made their
first contribution in
[kubernetes-sigs/external-dns#4441
- [@&#8203;DrFaust92](https://github.com/DrFaust92) made their first
contribution in
[kubernetes-sigs/external-dns#4456
- [@&#8203;rhjensen79](https://github.com/rhjensen79) made their first
contribution in
[kubernetes-sigs/external-dns#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://github.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMSIsInVwZGF0ZWRJblZlciI6IjM3LjM2OC4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbImF1dG9tZXJnZSIsInVwZGF0ZS9kb2NrZXIvZ2VuZXJhbC9ub24tbWFqb3IiXX0=-->
@omerap12 omerap12 mentioned this pull request May 23, 2024
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szuecs szuecs Awaiting requested review from szuecs

@mloiseleur mloiseleur Awaiting requested review from mloiseleur

@stevehipwell stevehipwell Awaiting requested review from stevehipwell

Assignees

@stevehipwell stevehipwell

@mloiseleur mloiseleur

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Helm documentation includes no examples for providers
4 participants
@omerap12 @k8s-ci-robot @mloiseleur @stevehipwell