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

AWS: Change documentation to use Helm values

Open pier-oliviert opened this issue 1 year ago • 8 comments

Description The Helm section includes templates files that aren't needed as those values can all be generated from the values.yaml file. It seems that the current documentation also missed the role arn annotation so it was added as well.

Checklist

  • [ ] Unit tests updated
  • [x] End user documentation updated

pier-oliviert avatar Jun 26 '24 14:06 pier-oliviert

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: pier-oliviert / name: Pier-Olivier Thibault (ebd3a7eafb30cb3d29904989c7031b976317588c, dd0667849cdfa849694f35f97ecf5405a959c965, edb2513a06b9d90afd8dbba33334f37e405fc3c3, bbaa3eb290d3c2db8f2c3069f35f93749c4382cd, e49c141cedcca834c239d2fe064764e83d427499, c7138b8a15e86bc6788c0ee641b7bb32b47b2c10, 4c86e53d0116c80df35998296842a53f5c5fb8df)

Welcome @pier-oliviert!

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 Jun 26 '24 14:06 k8s-ci-robot

Hi @pier-oliviert. 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-sigs/prow repository.

k8s-ci-robot avatar Jun 26 '24 14:06 k8s-ci-robot

Thanks, It looks good. I left some minor suggestion.

mloiseleur avatar Jun 27 '24 13:06 mloiseleur

Mmmh :thinking: this new documentation only works with EKS. Would you please update this PR to cover both EKS and regular k8s case ?

mloiseleur avatar Jun 27 '24 13:06 mloiseleur

/lgtm

mloiseleur avatar Jun 27 '24 22:06 mloiseleur

cc @stevehipwell

mloiseleur avatar Jun 27 '24 22:06 mloiseleur

This LGTM. Although is it still valid (or worth the additional cognitive load) to document a non-RBAC K8s pattern? I also don't think that you can have EKS without RBAC.

stevehipwell avatar Jul 04 '24 13:07 stevehipwell

/approve

mloiseleur avatar Aug 09 '24 09:08 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 Aug 09 '24 09:08 k8s-ci-robot