Skip to content

Adds missing KUBERNETES_CLUSTER_DOMAIN environment variable to docs #305

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

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Adds missing KUBERNETES_CLUSTER_DOMAIN environment variable to docs #305

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
802bc15
add cluster domain env var docs
maltesander Nov 15, 2024
bb69658
remove docker example
maltesander Nov 15, 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
34 changes: 34 additions & 0 deletions docs/modules/commons-operator/pages/reference/environment-variables.adoc
View file
Open in desktop
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
View file
Open in desktop
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.
Loading