sigs.k8s.io/external-dns@v0.14.1/charts/external-dns/README.md.gotmpl (about)

     1  {{ template "chart.header" . }}
     2  {{ template "chart.deprecationWarning" . }}
     3  
     4  {{ template "chart.badgesSection" . }}
     5  
     6  {{ template "chart.description" . }}
     7  
     8  {{ template "chart.homepageLine" . }}
     9  
    10  {{ template "chart.maintainersSection" . }}
    11  
    12  {{ template "chart.sourcesSection" . }}
    13  
    14  ## Installing the Chart
    15  
    16  Before you can install the chart you will need to add the `external-dns` repo to [Helm](https://helm.sh/).
    17  
    18  ```shell
    19  helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
    20  ```
    21  
    22  After you've installed the repo you can install the chart.
    23  
    24  ```shell
    25  helm upgrade --install {{ template "chart.name" . }} external-dns/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
    26  ```
    27  
    28  ## Providers
    29  
    30  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.
    31  See [documentation](https://kubernetes-sigs.github.io/external-dns/#new-providers) for more info on available providers and tutorials.
    32  
    33  ### Providers with Specific Configuration Support
    34  
    35  | Provider               | Supported  |
    36  |------------------------|------------|
    37  | `webhook`              | ✅         |
    38  
    39  ## Namespaced Scoped Installation
    40  
    41  external-dns supports running on a namespaced only scope, too.
    42  If `namespaced=true` is defined, the helm chart will setup `Roles` and `RoleBindings` instead `ClusterRoles` and `ClusterRoleBindings`.
    43  
    44  ### Limited Supported
    45  
    46  Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
    47  For example: Source `node` isn't supported, since `kind: Node` has scope `Cluster`.
    48  Sources like `istio-virtualservice` only work, if all resources like `Gateway` and `VirtualService` are present in the same
    49  namespaces as `external-dns`.
    50  
    51  The annotation `external-dns.alpha.kubernetes.io/endpoints-type: NodeExternalIP` is not supported.
    52  
    53  If `namespaced` is set to `true`, please ensure that `sources` my only contains supported sources (Default: `service,ingress`).
    54  
    55  ### Support Matrix
    56  
    57  | Source                 | Supported  | Infos                  |
    58  |------------------------|------------|------------------------|
    59  | `ingress`              | ✅         |                        |
    60  | `istio-gateway`        | ✅         |                        |
    61  | `istio-virtualservice` | ✅         |                        |
    62  | `crd`                  | ✅         |                        |
    63  | `kong-tcpingress`      | ✅         |                        |
    64  | `openshift-route`      | ✅         |                        |
    65  | `skipper-routegroup`   | ✅         |                        |
    66  | `gloo-proxy`           | ✅         |                        |
    67  | `contour-httpproxy`    | ✅         |                        |
    68  | `service`              | ⚠️️         | NodePort not supported |
    69  | `node`                 | ❌         |                        |
    70  | `pod`                  | ❌         |                        |
    71  
    72  
    73  {{ template "chart.requirementsSection" . }}
    74  
    75  {{ template "chart.valuesSection" . }}
    76  
    77  ----------------------------------------------
    78  
    79  Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs/).