Skip to content
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

Add configuring cluster domain guide #673

Merged
merged 10 commits into from
Oct 23, 2024
Merged

Add configuring cluster domain guide #673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cfa8574
initial cluster domain docs
maltesander Oct 17, 2024
85f5b12
add note in kubernetes section for cluster domain
maltesander Oct 17, 2024
7a0e4f7
fix link
maltesander Oct 17, 2024
c95fb51
fixes
maltesander Oct 17, 2024
884bc37
Apply suggestions from code review
maltesander Oct 18, 2024
48798fb
rename to kubernetes-cluster-domain.adoc
maltesander Oct 18, 2024
e82c01f
fix typo
maltesander Oct 18, 2024
fa9b6f4
review comments
sbernauer Oct 18, 2024
8acb55b
remove auto-dectection explanation
maltesander Oct 22, 2024
e8c8918
Update modules/guides/pages/kubernetes-cluster-domain.adoc
maltesander Oct 23, 2024
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
5 changes: 5 additions & 0 deletions modules/ROOT/pages/kubernetes/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,8 @@ Kubernetes control plane is running at https://127.0.0.1:6443
CoreDNS is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
Metrics-server is running at https://127.0.0.1:6443/api/v1/namespaces/kube-system/services/https:metrics-server:https/proxy
----

=== Configuring the cluster domain

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],
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.
1 change: 1 addition & 0 deletions modules/guides/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
** xref:running-stackable-in-an-airgapped-environment.adoc[]
** xref:viewing-and-verifying-sboms.adoc[]
** xref:enabling-verification-of-image-signatures.adoc[]
** xref:kubernetes-cluster-domain.adoc[]
15 changes: 15 additions & 0 deletions modules/guides/pages/kubernetes-cluster-domain.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
= Configuring the Kubernetes cluster domain
: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/

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]).

The cluster domain can be configured using an environment variable `KUBERNETES_CLUSTER_DOMAIN` set on the operators.
sbernauer marked this conversation as resolved.
Show resolved Hide resolved
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"
```

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