Skip to content

Commit

Permalink
add cluster domain env var docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maltesander committed Nov 15, 2024
1 parent 6d71a3e commit 802bc15
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
= Environment variables

This operator accepts the following environment variables:

== KUBERNETES_CLUSTER_DOMAIN

*Default value*: cluster.local

*Required*: false

*Multiple values*: false

This instructs the operator, which value it should use for the Kubernetes `clusterDomain` setting.
Make sure to keep this in sync with whatever setting your cluster uses.
Please see the documentation xref:guides:kubernetes-cluster-domain.adoc[on configuring the Kubernetes cluster domain] for more information on this feature.

[source]
----
export KUBERNETES_CLUSTER_DOMAIN=mycluster.local
cargo run -- run
----

or via docker:

[source]
----
docker run \
--name commons-operator \
--network host \
--env KUBECONFIG=/home/stackable/.kube/config \
--env KUBERNETES_CLUSTER_DOMAIN=mycluster.local \
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
docker.stackable.tech/stackable/commons-operator:0.0.0-dev
----
5 changes: 3 additions & 2 deletions docs/modules/commons-operator/pages/reference/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Consult the reference documentation section to find exhaustive information on:

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

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

0 comments on commit 802bc15

Please sign in to comment.