-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds missing KUBERNETES_CLUSTER_DOMAIN environment variable to docs (#…
…252) * add cluster domain env var docs * add cli page to index * remove docker examples
- Loading branch information
1 parent
25ef3cc
commit ad63fdc
Showing
3 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
14 changes: 14 additions & 0 deletions
14
docs/modules/listener-operator/pages/reference/commandline-parameters.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
36 changes: 36 additions & 0 deletions
36
docs/modules/listener-operator/pages/reference/environment-variables.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters