Skip to content

docs: Consistency review on namespaced configs in chart readme #6146

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.

Sign up for GitHub

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

Merged
k8s-ci-robot merged 3 commits into from
Mar 14, 2026
+16 −18
Merged

docs: Consistency review on namespaced configs in chart readme #6146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9dd7726
Consistency review on namespaced configs in chart readme
josemaia Jan 28, 2026
9b02d0a
Merge branch 'master' into patch-1
josemaia Feb 27, 2026
76f72e4
fix linting issues
josemaia Feb 27, 2026
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
17 changes: 8 additions & 9 deletions charts/external-dns/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,22 @@ For set up for a specific provider using the Helm chart, see the following links
* [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
## Namespace 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`.
`external-dns` supports running on a namespace-only scope, too.
If `namespaced=true` is defined, the Helm chart will setup `Roles` and `RoleBindings` instead of `ClusterRoles` and `ClusterRoleBindings`.

Note: When using Gateway API sources in namespaced mode, a cluster-scoped permission to list namespaces is required, unless you also set `gatewayNamespace`. If you set `gatewayNamespace`, all RBAC remains namespaced and no `ClusterRole`/`ClusterRoleBinding` is created.

### Limited Supported
### Namespace-only limitations

Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
Not all sources are supported in namespace-only scope, since some sources depend 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`.

Sources like `istio-virtualservice` only work if all resources like `Gateway` and `VirtualService` are present in the same
namespace 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`).
If `namespaced` is set to `true`, please ensure that `sources` only contains supported sources (Default: `service,ingress`).

### Support Matrix

Expand Down
17 changes: 8 additions & 9 deletions charts/external-dns/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,22 @@ For set up for a specific provider using the Helm chart, see the following links
* [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
## Namespace 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`.
`external-dns` supports running on a namespace-only scope, too.
If `namespaced=true` is defined, the Helm chart will setup `Roles` and `RoleBindings` instead of `ClusterRoles` and `ClusterRoleBindings`.

Note: When using Gateway API sources in namespaced mode, a cluster-scoped permission to list namespaces is required, unless you also set `gatewayNamespace`. If you set `gatewayNamespace`, all RBAC remains namespaced and no `ClusterRole`/`ClusterRoleBinding` is created.

### Limited Supported
### Namespace-only limitations

Not all sources are supported in namespaced scope, since some sources depends on cluster-wide resources.
Not all sources are supported in namespace-only scope, since some sources depend 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`.

Sources like `istio-virtualservice` only work if all resources like `Gateway` and `VirtualService` are present in the same
namespace 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`).
If `namespaced` is set to `true`, please ensure that `sources` only contains supported sources (Default: `service,ingress`).

### Support Matrix

Expand Down
Loading