Skip to content

Commit 802bc15

Browse files
committed
add cluster domain env var docs
1 parent 6d71a3e commit 802bc15

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
= Environment variables
2+
3+
This operator accepts the following environment variables:
4+
5+
== KUBERNETES_CLUSTER_DOMAIN
6+
7+
*Default value*: cluster.local
8+
9+
*Required*: false
10+
11+
*Multiple values*: false
12+
13+
This instructs the operator, which value it should use for the Kubernetes `clusterDomain` setting.
14+
Make sure to keep this in sync with whatever setting your cluster uses.
15+
Please see the documentation xref:guides:kubernetes-cluster-domain.adoc[on configuring the Kubernetes cluster domain] for more information on this feature.
16+
17+
[source]
18+
----
19+
export KUBERNETES_CLUSTER_DOMAIN=mycluster.local
20+
cargo run -- run
21+
----
22+
23+
or via docker:
24+
25+
[source]
26+
----
27+
docker run \
28+
--name commons-operator \
29+
--network host \
30+
--env KUBECONFIG=/home/stackable/.kube/config \
31+
--env KUBERNETES_CLUSTER_DOMAIN=mycluster.local \
32+
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
33+
docker.stackable.tech/stackable/commons-operator:0.0.0-dev
34+
----

docs/modules/commons-operator/pages/reference/index.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Consult the reference documentation section to find exhaustive information on:
44

55
* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
6+
* The xref:reference/environment-variables.adoc[] accepted by the operator.
67
7-
== Command line parameters and environment variables
8+
== Command line parameters
89

9-
At the moment this operator accepts no command line parameters and does not read any environment variables.
10+
At the moment this operator accepts no command line parameters.

0 commit comments

Comments
 (0)