Commit Graph

656 Commits

Author SHA1 Message Date
Michel Loiseleur
7ae03cdfc7
docs: refactor title and organisation 2024-09-05 09:09:48 +02:00
Michel Loiseleur
9ceca8fa81
review with Raffo 2024-09-04 13:51:29 +02:00
Michel Loiseleur
74a8cdad85
chore: remove unmaintained providers 2024-09-03 08:53:23 +02:00
Michael Shen
b43ad1c432
Add tutorial to DynamoDB registry docs
The existing docs described how to configure the DynamoDB registry, but
didn't have a tutorial for someone to walk through.

Signed-off-by: Michael Shen <mishen@umich.edu>
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
2024-08-21 19:36:31 -04:00
Michael Shen
4595e0d5ef
Annotation key/value pairs must be strings
As-is, following the docs results in the following error:

```
json: cannot unmarshal number into Go struct field ObjectMeta.metadata.annotations of type string
```

Signed-off-by: Michael Shen <mishen@umich.edu>
2024-08-15 22:39:29 -04:00
Thibault Jamet
a6ab2badce
Update docs/tutorials/aws.md 2024-08-14 11:36:47 +02:00
Thibault Jamet
2955e5d456
Apply suggestions from code review
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
2024-08-14 10:21:00 +02:00
Thibault Jamet
089744c6ff
Add cache at provider level
**Description**

In the current implementation, DNS providers are called to list all
records on every loop. This is expensive in terms of number of requests
to the provider and may result in being rate limited, as reported in 1293
and 3397.

In our case, we have approximately 20,000 records in our AWS Hosted Zone.
The ListResourceRecordSets API call allows a maximum of 300 items per call.
That requires 67 API calls per external-dns deployment during every sync period

With this, we introduce an optional generic caching mechanism at the provider
level, that re-uses the latest known list of records for a given time.

This prevents from expensive Provider calls to list all records for each
object modification that does not change the actual record (annotations,
statuses, ingress routing, ...)

This introduces 2 trade-offs:

1. Any changes or corruption directly on the provider side will be
longer to detect and to resolve, up to the cache time

2. Any conflicting records in the DNS provider (such as a different
external-dns instance) injected during the cache validity will cause
the first iteration of the next reconcile loop to fail, and hence add a
delay until the next retry

**Checklist**

- [X] Unit tests updated
- [X] End user documentation updated

Change-Id: I0bdcfa994ac1b76acedb05d458a97c080284c5aa
2024-08-14 10:20:56 +02:00
Kubernetes Prow Robot
c875e65d8d
Merge pull request #3400 from tjamet/min-event-sync
Improve MinEventInterval compliance with docs
2024-08-13 06:22:13 -07:00
Kubernetes Prow Robot
852087e21c
Merge pull request #4577 from pier-oliviert/helm-route-53-docs
AWS: Change documentation to use Helm values
2024-08-09 02:57:44 -07:00
Orgad Shaneh
f7e8ca19b3
azure-private-dns: Fix LoadBalancer example
annotations should be inside the metadata object.
2024-08-07 08:05:06 +03:00
Thibault Jamet
1b5ed44e48
Improve documentation 2024-08-06 08:52:30 +02:00
Andy Bursavich
2daa842eb7 docs/gateway-api: update supported API versions 2024-07-14 09:07:17 -07:00
Tobia Bocchi
8728b25f71
Update cloudflare.md
Hey! I was trying out external-dns using cloudflare. I followed your docs and managed to deploy it successfully on my k3s cluster. While reading the docs and copying pasting the yaml files I noticed there was some inconsistencies with the indentation.. 
I am no kubernetes expert, I just fixed the problems that were not allowing me to deploy this service and checked the files using yamllint.com
While I was at it I also noticed a few errors on the syntax highlighting for code blocks, some had shell where the content was yaml, I fixed those too.. 
I hope this helps, thank you for this amazing project!
2024-06-29 15:39:52 +02:00
Pier-Olivier Thibault
bbaa3eb290 Attempts at making the docs more clear with secret volume
The secret includes keys/value pair and a secret, when mounted as a
volume, will generate a file for each of the pair where the name of the
file is the key and the content of the file, the value.

This hopefully makes the doc clear on how to configured credentials.
2024-06-27 12:14:05 -04:00
Pier-Olivier Thibault
4c86e53d01
Update docs/tutorials/aws.md
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
2024-06-27 11:48:45 -04:00
Pier-Olivier Thibault
e49c141ced
Update docs/tutorials/aws.md
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
2024-06-27 11:48:41 -04:00
Pier-Olivier Thibault
edb2513a06 Add configuration option for non-eks with Helm 2024-06-27 09:59:40 -04:00
Pier-Olivier Thibault
dd0667849c Change header to be consistent within the section 2024-06-27 09:56:44 -04:00
Pier-Olivier Thibault
c7138b8a15
Update docs/tutorials/aws.md
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
2024-06-27 09:44:32 -04:00
Pier-Olivier Thibault
ebd3a7eafb AWS: Change documentation to use Helm values
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.
2024-06-26 10:46:34 -04:00
Kubernetes Prow Robot
8245b89891
Merge pull request #4283 from angeloxx/feature/rfc-2136-ptr
feat(rfc2136): add PTR optional support
2024-06-20 00:44:17 -07:00
Kubernetes Prow Robot
b84fc93843
Merge pull request #4378 from mloiseleur/docs/upgrade-mkdocs
docs: upgrade mkdocs and fix broken links
2024-06-11 00:26:01 -07:00
Kubernetes Prow Robot
0ba14d8873
Merge pull request #3973 from c445/roehrijn/aws-profiles
feat(aws): use AWS profiles using .credentials file
2024-06-10 13:59:23 -07:00
Alessandro Zanatta
cd4ad36873 Add documentation about etcd HTTPS for CoreDNS provider 2024-06-09 08:53:27 +02:00
Michel Loiseleur
3773411a5a docs: upgrade mkdocs and fix warnings 2024-06-07 08:15:44 +02:00
Michel Loiseleur
84da6be1dd chore: Remove infoblox in-tree provider 2024-05-29 16:01:45 +02:00
matthieugouel
57c351b66f feat(coredns): etcd authentication 2024-05-27 11:36:17 +02:00
Kubernetes Prow Robot
b4eea99efe
Merge pull request #4458 from Raffo/webhook-annotations
feat(webhooks): pass webhook-* annotations to webhook providers
2024-05-24 08:51:11 -07:00
Raffaele Di Fazio
bfa4e0620d
custom metrics docs 2024-05-24 17:31:44 +02:00
Raffaele Di Fazio
226dbb931f update docs to v0.14.2 2024-05-18 18:32:35 +02:00
Robert Jensen
5084f3e234
changed documentation to include more details description when using api tokens 2024-05-15 13:42:43 +02:00
Kubernetes Prow Robot
551ee96c23
Merge pull request #4456 from DrFaust92/gke-docs
docs: lint gke docs + make terraform config more secure
2024-05-13 00:19:45 -07:00
Stefan Lasiewski
d3212c36a9
Fix headings, whitespace
Fixed headings around "Secure Updates" .
Also fixed a couple of whitespace issues.
2024-05-10 18:51:11 -07:00
Kubernetes Prow Robot
6b510682ed
Merge pull request #4449 from mfreeman451/patch-1
Update cloudflare.md
2024-05-10 04:31:27 -07:00
Kubernetes Prow Robot
fac5b44cfc
Merge pull request #4324 from PseudoResonance/master
Add IPv6 AAAA record support to PiHole provider
2024-05-10 04:07:45 -07:00
drfaust92
113b775f02 lint gke docs + make tf config more secure
Signed-off-by: drfaust92 <ilia.lazebnik@gmail.com>
2024-05-10 13:06:24 +03:00
Michael Freeman
e0799293c3
Update cloudflare.md
missing clear instructions on where to find the chart, without this the upgrade command will not work.
2024-05-08 00:47:37 -05:00
ilyes Ajroud
7a9af84300
fix syntax on cloudflare externalDNS 2024-05-06 20:48:21 +01:00
Kubernetes Prow Robot
b416018b34
Merge pull request #4405 from omerap12/docs/helm-documentation
docs: add setup example with helm chart on some providers
2024-04-30 13:09:48 -07:00
Omer
82fd2773be Remove version flag from helm command 2024-04-27 08:23:57 +03:00
Omer
9d41b48146 removed unused files 2024-04-27 00:36:29 +03:00
Omer
51b35cb0ac Add spaces 2024-04-27 00:35:12 +03:00
Omer
a37d4972a3 Add spaces 2024-04-27 00:32:56 +03:00
Omer
4e655fbc2e Add spaces 2024-04-27 00:31:17 +03:00
Omer
5ca2a29119 Add spaces 2024-04-27 00:30:57 +03:00
Omer
689f9ffa4f Add spaces 2024-04-27 00:29:38 +03:00
Omer
c3e8e0997c Add spaces 2024-04-27 00:23:55 +03:00
Omer
a6585190f4 Add spaces 2024-04-27 00:23:21 +03:00
Omer
bd44a29ac6 Add spaces 2024-04-27 00:22:46 +03:00