Several aspects of StorageOS behaviour can be controlled via environment variables. These can be injected in via any of the usual mechanisms such as ConfigMaps.
JOIN: Required A join token and/or list of cluster nodes to join. The first node will bootstrap the cluster. See cluster discovery. There is no default; this must be set for multiple-node clusters.
HOSTNAME: Hostname of the node, only if you wish to override it. In Kubernetes environments, typically set to
ADVERTISE_IP: IP address of the node for incoming connections. Defaults to first non-loopback address.
DESCRIPTION: The node description for display purposes only. Default is unset.
LABELS: Comma separated list of node labels. e.g.
LABELS=country=us,env=prod. Default is unset.
USERNAME: Username to authenticate to the API with. Defaults to
PASSWORD: Password to authenticate to the API with. Defaults to
DEVICE_DIR: Where the volumes are exported. This directory must be shared into the container using the rshared volume mount option. Defaults to
API_PORT: Port for the API to listen on. Defaults to
NATS_PORT: Port for NATS messaging to listen on. Defaults to
NATS_HTTP_PORT: Port for the NATS HTTP server to listen on. Defaults to
NATS_CLUSTER_PORT: Port for the NATS cluster service to listen on. Defaults to
SERF_PORT: Port for the Serf protocol to listen on. Defaults to
DFS_PORT: Port for DirectFS to listen on. Defaults to
KV_PEER_PORT: Port for the embedded Key/Value store. Defaults to
KV_CLIENT_PORT: Port for the embedded Key/Value store. Defaults to
KV_BACKEND: Type of KV store to use. Defaults to
etcdis supported with
KV_ADDRset to an external etcd instance.
KV_ADDR: Comma separated list of etcd targets, in the form ip[:port]. Must be specified with
KV_BACKEND=etcd. Prefer multiple direct endpoints over a single load-balanced endpoint.
LOG_LEVEL: One of
error. Defaults to
LOG_FORMAT: Logging output format, one of
json. Defaults to
LOG_FILTER: Used to discard log messages based on category. e.g.
LOG_FILTER=cp=info,dp=info,etcd=debug. Default is unset.
DISABLE_TELEMETRY: To disable anonymous usage reporting across the cluster, set to
true. Defaults to
false. To help improve the product, data such as API usage and StorageOS configuration information is collected.
DISABLE_ERROR_REPORTING: To disable error reporting across the cluster, set to
true. Defaults to
false. Errors are reported to help identify and resolve potential issues that may occur.
IN_K8S_CLUSTER: Toggles enhanced Kubernetes integration. Defaults to
trueand will be disabled automatically if Kubernetes API is not accessible. Requires StorageOS to be deployed as a DaemonSet or Pod.
KUBECONFIG: Path to local kubeconfig file. Not normally required. Default is unset.
NAMESPACE: The orchestrator namespace that StorageOS is running in. Used as the location to store encryption keys in. Defaults to
CSI_ENDPOINT: If set, CSI compatibility is enabled. Typically set to
unix://var/lib/kubelet/plugins_registry/storageos/csi.sock. Default is unset.
CSI_VERSION: Added in
1.1.0to define what version of CSI to use. Can be set to
v1, defaults to