Skip to content

docs: add hint regarding cluster domain to improve DNS performance #698

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

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions modules/guides/pages/kubernetes-cluster-domain.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Configuring the Kubernetes cluster domain
:description: Configure Stackable operators to use a different cluster domain other than 'cluster.local'.
:description: Configure Stackable operators to use a different cluster domain other than 'cluster.local.'.
:dns-custom-nameservers: https://kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/
:dns-pod-service: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/

Expand All @@ -9,7 +9,9 @@ The cluster domain can be configured using an environment variable `KUBERNETES_C
This environment variable can be configured via the helm values property `kubernetesClusterDomain` during the installation of the operators.

```
helm install <product>-operator stackable-stable/<product>-operator --set kubernetesClusterDomain="my-cluster.local"
helm install <product>-operator stackable-stable/<product>-operator --set kubernetesClusterDomain="my.domain."
```

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`.
Note that if you specify a custom cluster domain we recommend adding a trailing dot (`my.domain.` instead of `my.domain`) to reduce DNS requests (see https://github.com/stackabletech/issues/issues/656 for details).

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.`.
Loading