Skip to content

docs(aws): tutorial with kind and localstack#6048

Merged
k8s-ci-robot merged 13 commits intokubernetes-sigs:masterfrom
gofogo:docs-add-tutorial-aws-localstack
Mar 24, 2026
Merged

docs(aws): tutorial with kind and localstack#6048
k8s-ci-robot merged 13 commits intokubernetes-sigs:masterfrom
gofogo:docs-add-tutorial-aws-localstack

Conversation

@ivankatliarchuk
Copy link
Copy Markdown
Member

@ivankatliarchuk ivankatliarchuk commented Dec 21, 2025

What does it do ?

Similar tutorial to #5926

External DNS + AWS localstack. Tested step by step, all works on Mac

How to run mkdocs https://github.com/kubernetes-sigs/external-dns/blob/master/docs/contributing/dev-guide.md#contribute-to-documentation

follow-up:

Motivation

Knowledge share

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

@k8s-ci-robot k8s-ci-robot added docs cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 21, 2025
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk ivankatliarchuk force-pushed the docs-add-tutorial-aws-localstack branch from b1c9c3c to d000d41 Compare December 21, 2025 16:27
@coveralls
Copy link
Copy Markdown

coveralls commented Dec 21, 2025

Pull Request Test Coverage Report for Build 23479221178

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.005%) to 78.225%

Files with Coverage Reduction New Missed Lines %
openshift_route.go 1 82.93%
Totals Coverage Status
Change from base Build 23465423601: -0.005%
Covered Lines: 16414
Relevant Lines: 20983

💛 - Coveralls

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Copy Markdown
Member Author

Removed dependency bump

* master:
  somehow single test was not fixed (kubernetes-sigs#6059)
  refactore(registry): move registry selector to registry package (kubernetes-sigs#6047)
  fix(domain-exclusion): domain exclusion filter fix (kubernetes-sigs#6050)
  chore(wrapper): centralized endpoint validation (kubernetes-sigs#6041)
  test(coverage): improve code coverage for different files (kubernetes-sigs#6045)
  chore(lint): configure modernize linter (kubernetes-sigs#6035)
  docs(proposal): Gateway API annotation placement clarity proposal (kubernetes-sigs#5919)
  fix(scripts): helm plugins install disable verify (kubernetes-sigs#6057)
  feat(cli): remove cobra cli support (kubernetes-sigs#6034)
  fix(chart): ptsc indentation (kubernetes-sigs#6054)
  chore(deps): bump renovatebot/github-action (kubernetes-sigs#6051)
  feat(aws): enable support for NAPTR records (kubernetes-sigs#6022)
  refactor: extract normalizeDNSName to idna package for reuse (kubernetes-sigs#6043)
mkdocs.yml Outdated
j2_comment_start_string: '[[#'
j2_comment_end_string: '#]]'
- tags:
tags_file: tags.md
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

There is no tags.md in the tree. 🤔 Isn't this missing from this PR?
Anyway, it would probably be better to introduce a tag system in external docs in a dedicated PR, and not this PR.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'll create a separate PR. You are right.

It also creates TXT records for ownership tracking. When the Service is deleted, ExternalDNS automatically cleans up the DNS records.

```mermaid
sequenceDiagram
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Non-blocking comment, just a thought: to me, in this diagram, User & Kubectl looks quite similar. Wdyt about simplifying the diagram and remove one of them ?

The ownership mechanism ensures ExternalDNS only modifies records it created.

```mermaid
flowchart TD
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In this diagram, the green and the pink are not readable:

Image Image

You'll need to either change the background color or the text color.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Strange. This is how it lookg on github

Screenshot 2026-03-24 at 07 25 37

I've changed color-scheme a bit

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Screenshot 2026-03-24 at 07 32 41

ivankatliarchuk and others added 5 commits March 24, 2026 07:19
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@mloiseleur
Copy link
Copy Markdown
Collaborator

mloiseleur commented Mar 24, 2026

Thanks 👍 .
I guess that's different because I'm using the "dark default" theme (see here)
Pink is now ok; the green one is still hard to read:

image

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Copy Markdown
Member Author

Made the text black as well

Copy link
Copy Markdown
Collaborator

@mloiseleur mloiseleur left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 24, 2026
@k8s-ci-robot
Copy link
Copy Markdown
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

Details 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 Mar 24, 2026
@k8s-ci-robot k8s-ci-robot merged commit 2c46340 into kubernetes-sigs:master Mar 24, 2026
18 checks passed
@ivankatliarchuk ivankatliarchuk deleted the docs-add-tutorial-aws-localstack branch March 24, 2026 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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. docs lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants