external-dns icon indicating copy to clipboard operation
external-dns copied to clipboard

docs: add setup example with helm chart on some providers

Open omerap12 opened this issue 1 year ago • 15 comments
trafficstars

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
  • [x] End user documentation updated

omerap12 avatar Apr 23 '24 12:04 omerap12

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: omerap12 / name: Omer Aplatony (3e547466813b6b43fd964cc67b313df3231b59d6, 19f149f66010c2db0618c1d261121e3a5f81b713, dcbcdd5084efc0d455dc2911b6288177f43951d8, 689f9ffa4f6a02a6a22fcad8714a23564b86bc14, a7e487d413ec84ba5c70129ff8f91fd84bd2064d, 739993c69d24e8afcb162bcaeaef7597a4f6bb89, 83b3ed110abe1cf44952651ea942cd1eed931e03, 513c00fbe3ff5f6b4acad2325493fb9f2d335d2c, 2c87289ee65340dd72a1a9f183b40c83d345162a, de07d9dbdab6c1fc4a304d7829a5ef98d4f8747e, c3e8e0997c8bb3105fd5c567eaed8fde2ac1ffae, 8d6e87ff1cdd355abe7b00cf2169df2d07a233c7, 66592c7b2516d2a288523e33d4502c2bca07c5d1, 0a1f6d77ef22c26cabc5dfaa65627fde0e35e2e8, 1b275fc3f4863f8d6b086e3a524dc2d3cdace170, 399940f985077206cfbdba9b96794c14cd1108a9, a6585190f461a76aabef61c7bd5eb42c36476ed9, 5ca2a2911944bade2bd73239fe37214643fcd032, 4e655fbc2ef44cb95b90f839d7662adb7600ae86, bd44a29ac69839335050af3bfe86ae332a4f29a9, a37d4972a3d64e33b690537ba677b0d72701b90d, 7e7d452de5b292aa02fa46a12779b3034cc19282, 9d41b4814683055160ca0302899321c48bea8b0e, ef5c582046440eb2a15bb949e26431a98d74f45b, 51b35cb0acb0e9aa5ec34032ed10f88846298cc4, cbf2e787d9c07fa13eab13d517955a5d912e440e, 82fd2773be9a295bca45608bdd5876e489d580ab, 592aab227fe4f562321f24cf61db7469f0d8c324, ab86ac702228ac8412429a37388e7b59471df180)

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. :smiley:

k8s-ci-robot avatar Apr 23 '24 12:04 k8s-ci-robot

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 avatar Apr 23 '24 12:04 k8s-ci-robot

Thanks for this PR. mmmh :thinking: 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 ?

mloiseleur avatar Apr 23 '24 14:04 mloiseleur

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.

omerap12 avatar Apr 23 '24 16:04 omerap12

@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 avatar Apr 23 '24 18:04 stevehipwell

@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 avatar Apr 23 '24 18:04 omerap12

Updated some providers and README template, please let me know if thats ok or or if to add more providers :) @mloiseleur

omerap12 avatar Apr 26 '24 20:04 omerap12

@omerap12 Waow. That's helpful :+1: . You'll just need to add an (empty) new line before and after block code and it should be good. See here if you need more details.

mloiseleur avatar Apr 26 '24 20:04 mloiseleur

@mloiseleur Cool, Ill fix it and let you know :)

omerap12 avatar Apr 26 '24 21:04 omerap12

@mloiseleur Done

omerap12 avatar Apr 26 '24 21:04 omerap12

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

mloiseleur avatar Apr 27 '24 09:04 mloiseleur

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

mloiseleur avatar Apr 27 '24 09:04 mloiseleur

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

stevehipwell avatar Apr 30 '24 13:04 stevehipwell

@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

omerap12 avatar Apr 30 '24 15:04 omerap12

/ok-to-test

mloiseleur avatar Apr 30 '24 15:04 mloiseleur

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

/lgtm

stevehipwell avatar Apr 30 '24 16:04 stevehipwell

This will clearly help users :+1:. /approve

mloiseleur avatar Apr 30 '24 20:04 mloiseleur

[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 avatar Apr 30 '24 20:04 k8s-ci-robot