95 lines
4.1 KiB
Go Template
95 lines
4.1 KiB
Go Template
{{ template "chart.header" . }}
|
||
{{ template "chart.deprecationWarning" . }}
|
||
|
||
{{ template "chart.badgesSection" . }}
|
||
|
||
{{ template "chart.description" . }}
|
||
|
||
{{ template "chart.homepageLine" . }}
|
||
|
||
{{ template "chart.maintainersSection" . }}
|
||
|
||
{{ template "chart.sourcesSection" . }}
|
||
|
||
## Installing the Chart
|
||
|
||
Before you can install the chart you will need to add the `external-dns` repo to [Helm](https://helm.sh/).
|
||
|
||
```shell
|
||
helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
|
||
```
|
||
|
||
After you've installed the repo you can install the chart.
|
||
|
||
```shell
|
||
helm upgrade --install {{ template "chart.name" . }} external-dns/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
|
||
```
|
||
|
||
## Providers
|
||
|
||
> Legacy support of setting `provider: <name>` is deprecated.
|
||
|
||
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.
|
||
|
||
See [documentation](https://kubernetes-sigs.github.io/external-dns/#new-providers) for more info on available providers and tutorials.
|
||
|
||
### Providers with Specific Configuration Support
|
||
|
||
| Provider | Supported |
|
||
|------------------------|------------|
|
||
| `webhook` | ✅ |
|
||
|
||
### Other Providers
|
||
|
||
For set up for a specific provider using the Helm chart, see the following links:
|
||
|
||
* [AWS](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/aws.md#using-helm-with-oidc)
|
||
* [akamai-edgedns](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/akamai-edgedns.md#using-helm)
|
||
* [cloudflare](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/cloudflare.md#using-helm)
|
||
* [digitalocean](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/digitalocean.md#using-helm)
|
||
* [godaddy](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/godaddy.md#using-helm)
|
||
* [ns1](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/ns1.md#using-helm)
|
||
* [plural](https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/plural.md#using-helm)
|
||
|
||
## Namespaced Scoped Installation
|
||
|
||
external-dns supports running on a namespaced only scope, too.
|
||
If `namespaced=true` is defined, the helm chart will setup `Roles` and `RoleBindings` instead `ClusterRoles` and `ClusterRoleBindings`.
|
||
|
||
### Limited Supported
|
||
|
||
Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
|
||
For example: Source `node` isn't supported, since `kind: Node` has scope `Cluster`.
|
||
Sources like `istio-virtualservice` only work, if all resources like `Gateway` and `VirtualService` are present in the same
|
||
namespaces as `external-dns`.
|
||
|
||
The annotation `external-dns.alpha.kubernetes.io/endpoints-type: NodeExternalIP` is not supported.
|
||
|
||
If `namespaced` is set to `true`, please ensure that `sources` my only contains supported sources (Default: `service,ingress`).
|
||
|
||
### Support Matrix
|
||
|
||
| Source | Supported | Infos |
|
||
|------------------------|------------|------------------------|
|
||
| `ingress` | ✅ | |
|
||
| `istio-gateway` | ✅ | |
|
||
| `istio-virtualservice` | ✅ | |
|
||
| `crd` | ✅ | |
|
||
| `kong-tcpingress` | ✅ | |
|
||
| `openshift-route` | ✅ | |
|
||
| `skipper-routegroup` | ✅ | |
|
||
| `gloo-proxy` | ✅ | |
|
||
| `contour-httpproxy` | ✅ | |
|
||
| `service` | ⚠️️ | NodePort not supported |
|
||
| `node` | ❌ | |
|
||
| `pod` | ❌ | |
|
||
|
||
|
||
{{ template "chart.requirementsSection" . }}
|
||
|
||
{{ template "chart.valuesSection" . }}
|
||
|
||
----------------------------------------------
|
||
|
||
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).
|