Skip to content

Commit c393f5c

Browse files
Add configuring cluster domain guide (#673)
* initial cluster domain docs * add note in kubernetes section for cluster domain * fix link * fixes * Apply suggestions from code review Co-authored-by: Sebastian Bernauer <[email protected]> * rename to kubernetes-cluster-domain.adoc * fix typo * review comments * remove auto-dectection explanation * Update modules/guides/pages/kubernetes-cluster-domain.adoc Co-authored-by: Sebastian Bernauer <[email protected]> --------- Co-authored-by: Sebastian Bernauer <[email protected]> Co-authored-by: Sebastian Bernauer <[email protected]>
1 parent d18753e commit c393f5c

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

modules/ROOT/pages/kubernetes/index.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,8 @@ Kubernetes control plane is running at https://127.0.0.1:6443
7777
CoreDNS is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
7878
Metrics-server is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/https:metrics-server:https/proxy
7979
----
80+
81+
=== Configuring the cluster domain
82+
83+
In case a non-default cluster domain is used as described in https://kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/[Customizing DNS Service],
84+
Stackable operators can be configured accordingly. This is described in detail in the xref:guides:kubernetes-cluster-domain.adoc[Configuring the Kubernetes cluster domain] guide.

modules/guides/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
** xref:running-stackable-in-an-airgapped-environment.adoc[]
55
** xref:viewing-and-verifying-sboms.adoc[]
66
** xref:enabling-verification-of-image-signatures.adoc[]
7+
** xref:kubernetes-cluster-domain.adoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
= Configuring the Kubernetes cluster domain
2+
:description: Configure Stackable operators to use a different cluster domain other than 'cluster.local'.
3+
:dns-custom-nameservers: https://kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/
4+
:dns-pod-service: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/
5+
6+
Stackable operators allow the configuration of a non-default cluster domain as described in {dns-custom-nameservers}[Customizing DNS Service] (and more in {dns-pod-service}[DNS for Services and Pods]).
7+
8+
The cluster domain can be configured using an environment variable `KUBERNETES_CLUSTER_DOMAIN` set on the operators.
9+
This environment variable can be configured via the helm values property `kubernetesClusterDomain` during the installation of the operators.
10+
11+
```
12+
helm install <product>-operator stackable-stable/<product>-operator --set kubernetesClusterDomain="my-cluster.local"
13+
```
14+
15+
If the environment variable `KUBERNETES_CLUSTER_DOMAIN` (or the helm property `kubernetesClusterDomain`) are not set / overriden, the operator will default the cluster domain to `cluster.local`.

0 commit comments

Comments
 (0)