Skip to content

Commit 4942623

Browse files
committed
add cluster domain env var docs
1 parent 25ef3cc commit 4942623

File tree

3 files changed

+82
-0
lines changed

3 files changed

+82
-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: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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+
or via docker:
21+
22+
[source]
23+
----
24+
docker run \
25+
--name listener-operator \
26+
--network host \
27+
--env KUBECONFIG=/home/stackable/.kube/config \
28+
--env CSI_ENDPOINT=unix:///csi.sock controller \
29+
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
30+
docker.stackable.tech/stackable/listener-operator:0.0.0-dev
31+
----
32+
33+
== KUBERNETES_CLUSTER_DOMAIN
34+
35+
*Default value*: cluster.local
36+
37+
*Required*: false
38+
39+
*Multiple values*: false
40+
41+
This instructs the operator, which value it should use for the Kubernetes `clusterDomain` setting.
42+
Make sure to keep this in sync with whatever setting your cluster uses.
43+
Please see the documentation xref:guides:kubernetes-cluster-domain.adoc[on configuring the Kubernetes cluster domain] for more information on this feature.
44+
45+
[source]
46+
----
47+
export KUBERNETES_CLUSTER_DOMAIN=mycluster.local
48+
cargo run -- run --csi-endpoint unix:///csi.sock controller
49+
----
50+
51+
or via docker:
52+
53+
[source]
54+
----
55+
docker run \
56+
--name listener-operator \
57+
--network host \
58+
--env KUBECONFIG=/home/stackable/.kube/config \
59+
--env KUBERNETES_CLUSTER_DOMAIN=mycluster.local \
60+
--mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
61+
docker.stackable.tech/stackable/listener-operator:0.0.0-dev \
62+
run --csi-endpoint unix:///csi.sock controller
63+
----

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +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.
7+
8+
== Command line parameters
9+
10+
At the moment this operator accepts no command line parameters.

0 commit comments

Comments
 (0)