Skip to content

Commit

Permalink
Adds missing KUBERNETES_CLUSTER_DOMAIN environment variable to docs (#…
Browse files Browse the repository at this point in the history
…252)

* add cluster domain env var docs

* add cli page to index

* remove docker examples
  • Loading branch information
maltesander authored Nov 18, 2024
1 parent 25ef3cc commit ad63fdc
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
= Command line parameters

This operator accepts the following command line parameters:

== --csi-endpoint

*Required*: true

*Multiple values*: false

*Environment variable:* `CSI_ENDPOINT`

The path to the https://github.com/container-storage-interface/spec/blob/master/spec.md[Container Storage Interface] Unix Domain Socket
that the operator should listen on.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
= Environment variables

This operator accepts the following environment variables:

== CSI_ENDPOINT

*Required*: true

*Multiple values*: false

The path to the https://github.com/container-storage-interface/spec/blob/master/spec.md[Container Storage Interface] Unix Domain Socket
that the operator should listen on.

[source]
----
export CSI_ENDPOINT=unix:///csi.sock
cargo run -- run
----

== 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
----
2 changes: 2 additions & 0 deletions docs/modules/listener-operator/pages/reference/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
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.
* The xref:reference/commandline-parameters.adoc[] accepted by the operator.

0 comments on commit ad63fdc

Please sign in to comment.