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.

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

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

Merged
merged 29 commits into from
Apr 30, 2024
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
1b275fc
docs: Add setup example for CloudFlare provider in ExternalDNS Helm c…
omerap12 Apr 23, 2024
a7e487d
Revert changes to charts/external-dns/README.md and add helm docs for…
omerap12 Apr 24, 2024
de07d9d
Set all credentials in secrets
omerap12 Apr 24, 2024
83b3ed1
Added helm docks to akami-edgedns
omerap12 Apr 24, 2024
739993c
Added helm docs to ns1
omerap12 Apr 26, 2024
dcbcdd5
Fixed typo
omerap12 Apr 26, 2024
3e54746
Fixed typo
omerap12 Apr 26, 2024
19f149f
Added helm docs to digitalocean
omerap12 Apr 26, 2024
66592c7
Added helm docs to godaddy
omerap12 Apr 26, 2024
8d6e87f
Added helm docs to aws
omerap12 Apr 26, 2024
2c87289
Added helm docs to vult
omerap12 Apr 26, 2024
399940f
Added helm docs to plural
omerap12 Apr 26, 2024
0a1f6d7
Change secret name
omerap12 Apr 26, 2024
513c00f
Added helm docs to README for hekm
omerap12 Apr 26, 2024
ef5c582
Update README template for helm
omerap12 Apr 26, 2024
7e7d452
Add spaces
omerap12 Apr 26, 2024
bd44a29
Add spaces
omerap12 Apr 26, 2024
a658519
Add spaces
omerap12 Apr 26, 2024
c3e8e09
Add spaces
omerap12 Apr 26, 2024
689f9ff
Add spaces
omerap12 Apr 26, 2024
5ca2a29
Add spaces
omerap12 Apr 26, 2024
4e655fb
Add spaces
omerap12 Apr 26, 2024
a37d497
Add spaces
omerap12 Apr 26, 2024
51b35cb
Add spaces
omerap12 Apr 26, 2024
9d41b48
removed unused files
omerap12 Apr 26, 2024
82fd277
Remove version flag from helm command
omerap12 Apr 27, 2024
cbf2e78
Moved charts docs under #Providers
omerap12 Apr 29, 2024
592aab2
Set new heading 'Other Providers' on README.md.gotmpl
omerap12 Apr 29, 2024
ab86ac7
Run helm-docs
omerap12 Apr 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions charts/external-dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,35 @@ helm upgrade --install external-dns external-dns/external-dns --version 1.14.4
Configuring the _ExternalDNS_ provider should be done via the `provider.name` value with provider specific configuration being set via the `provider.<name>.<key>` values, where supported, and the `extraArgs` value. For legacy support `provider` can be set to the name of the provider with all additional configuration being set via the `extraArgs` value.
See [documentation](https://kubernetes-sigs.github.io/external-dns/#new-providers) for more info on available providers and tutorials.

### Provider Example
#### Setting Up ExternalDNS with CloudFlare
To deploy ExternalDNS configured for the CloudFlare DNS provider, begin by creating a Kubernetes secret to securely store your CloudFlare API key. This key will enable ExternalDNS to authenticate with CloudFlare:
omerap12 marked this conversation as resolved.
Show resolved Hide resolved
```shell
kubectl create secret generic cloudflare-api-key --from-literal=apiKey=YOUR_API_KEY
```
Ensure to replace YOUR_API_KEY with your actual CloudFlare API key.
omerap12 marked this conversation as resolved.
Show resolved Hide resolved

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

omerap12 marked this conversation as resolved.
Show resolved Hide resolved
provider:
name: cloudflare
env:
- name: CF_API_KEY
valueFrom:
secretKeyRef:
name: cloudflare-api-key
key: apiKey
- name: CF_API_EMAIL
value: "example@example.com"
```
Replace your-email@example.com with the email associated with your CloudFlare account.
omerap12 marked this conversation as resolved.
Show resolved Hide resolved

Finally, install the ExternalDNS chart with Helm using the configuration specified in your values.yaml file:
```shell
omerap12 marked this conversation as resolved.
Show resolved Hide resolved
helm upgrade --install external-dns external-dns/external-dns --version 1.14.4 --values values.yaml
```
This command will configure ExternalDNS to manage DNS records using CloudFlare, based on resources present in your Kubernetes cluster.
omerap12 marked this conversation as resolved.
Show resolved Hide resolved

### Providers with Specific Configuration Support

| Provider | Supported |
Expand Down