Skip to content

Commit ad63fdc

Browse files
authored
Adds missing KUBERNETES_CLUSTER_DOMAIN environment variable to docs (#252)
* add cluster domain env var docs * add cli page to index * remove docker examples
1 parent 25ef3cc commit ad63fdc

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
= Command line parameters
2+
3+
This operator accepts the following command line parameters:
4+
5+
== --csi-endpoint
6+
7+
*Required*: true
8+
9+
*Multiple values*: false
10+
11+
*Environment variable:* `CSI_ENDPOINT`
12+
13+
The path to the https://github.com/container-storage-interface/spec/blob/master/spec.md[Container Storage Interface] Unix Domain Socket
14+
that the operator should listen on.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
= Environment variables
2+
3+
This operator accepts the following environment variables:
4+
5+
== CSI_ENDPOINT
6+
7+
*Required*: true
8+
9+
*Multiple values*: false
10+
11+
The path to the https://github.com/container-storage-interface/spec/blob/master/spec.md[Container Storage Interface] Unix Domain Socket
12+
that the operator should listen on.
13+
14+
[source]
15+
----
16+
export CSI_ENDPOINT=unix:///csi.sock
17+
cargo run -- run
18+
----
19+
20+
== KUBERNETES_CLUSTER_DOMAIN
21+
22+
*Default value*: cluster.local
23+
24+
*Required*: false
25+
26+
*Multiple values*: false
27+
28+
This instructs the operator, which value it should use for the Kubernetes `clusterDomain` setting.
29+
Make sure to keep this in sync with whatever setting your cluster uses.
30+
Please see the documentation xref:guides:kubernetes-cluster-domain.adoc[on configuring the Kubernetes cluster domain] for more information on this feature.
31+
32+
[source]
33+
----
34+
export KUBERNETES_CLUSTER_DOMAIN=mycluster.local
35+
cargo run -- run
36+
----

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
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.
7+
* The xref:reference/commandline-parameters.adoc[] accepted by the operator.

0 commit comments

Comments
 (0)