OS Manuals

/usr/bin/csi-snapshotter

Sidecar container that watches Kubernetes Snapshot CRD objects and triggers CreateSnapshot/DeleteSnapshot against a CSI endpoint

From kubernetes-csi-external-snapshotter-8.3 8.3.0-r33 (enterprise-packages), captured 2026-11-08 by running csi-snapshotter --help (exit 0). permalink

Usage of /usr/bin/csi-snapshotter:
  -automaxprocs
    	automatically set GOMAXPROCS to match Linux container CPU quota
  -csi-address string
    	Address of the CSI driver socket. (default "/run/csi/socket")
  -extra-create-metadata
    	If set, add snapshot metadata to plugin snapshot requests as parameters.
  -feature-gates value
    	Comma-seprated list of key=value pairs that describe feature gates for alpha/experimental features. Options are:
    	AllAlpha=true|false (ALPHA - default=false)
    	AllBeta=true|false (BETA - default=false)
    	CSIVolumeGroupSnapshot=true|false (BETA - default=false)
  -groupsnapshot-name-prefix string
    	Prefix to apply to the name of a created group snapshot (default "groupsnapshot")
  -groupsnapshot-name-uuid-length int
    	Length in characters for the generated uuid of a created group snapshot. Defaults behavior is to NOT truncate. (default -1)
  -http-endpoint :8080
    	The TCP network address where the HTTP server for diagnostics, including metrics and leader election health check, will listen (example: :8080). The default is empty string, which means the server is disabled. Only one of `--metrics-address` and `--http-endpoint` can be set.
  -kube-api-burst int
    	Burst to use while communicating with the kubernetes apiserver. Defaults to 10. (default 10)
  -kube-api-qps float
    	QPS to use while communicating with the kubernetes apiserver. Defaults to 5.0. (default 5)
  -kubeconfig string
    	Absolute path to the kubeconfig file. Required only when running out of cluster.
  -leader-election
    	Enables leader election.
  -leader-election-lease-duration duration
    	Duration, in seconds, that non-leader candidates will wait to force acquire leadership. Defaults to 15 seconds. (default 15s)
  -leader-election-namespace string
    	The namespace where the leader election resource exists. Defaults to the pod namespace if not set.
  -leader-election-renew-deadline duration
    	Duration, in seconds, that the acting leader will retry refreshing leadership before giving up. Defaults to 10 seconds. (default 10s)
  -leader-election-retry-period duration
    	Duration, in seconds, the LeaderElector clients should wait between tries of actions. Defaults to 5 seconds. (default 5s)
  -log-flush-frequency duration
    	Maximum number of seconds between log flushes (default 5s)
  -log-json-info-buffer-size value
    	[Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.
  -log-json-split-stream
    	[Alpha] In JSON format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.
  -log-text-info-buffer-size value
    	[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance. The default value of zero bytes disables buffering. The size can be specified as number of bytes (512), multiples of 1000 (1K), multiples of 1024 (2Ki), or powers of those (3M, 4G, 5Mi, 6Gi). Enable the LoggingAlphaOptions feature gate to use this.
  -log-text-split-stream
    	[Alpha] In text format, write error messages to stderr and info messages to stdout. The default is to write a single stream to stdout. Enable the LoggingAlphaOptions feature gate to use this.
  -logging-format string
    	Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
  -metrics-address :8080
    	(deprecated) The TCP network address where the prometheus metrics endpoint will listen (example: :8080). The default is empty string, which means metrics endpoint is disabled. Only one of `--metrics-address` and `--http-endpoint` can be set.
  -metrics-path /metrics
    	The HTTP path where prometheus metrics will be exposed. Default is /metrics. (default "/metrics")
  -node-deployment
    	Enables deploying the sidecar controller together with a CSI driver on nodes to manage snapshots for node-local volumes.
  -resync-period duration
    	Resync interval of the controller. Default is 15 minutes (default 15m0s)
  -retry-interval-max duration
    	Maximum retry interval of failed volume snapshot creation or deletion. Default is 5 minutes. (default 5m0s)
  -retry-interval-start duration
    	Initial retry interval of failed volume snapshot creation or deletion. It doubles with each failure, up to retry-interval-max. Default is 1 second. (default 1s)
  -snapshot-name-prefix string
    	Prefix to apply to the name of a created snapshot (default "snapshot")
  -snapshot-name-uuid-length int
    	Length in characters for the generated uuid of a created snapshot. Defaults behavior is to NOT truncate. (default -1)
  -timeout duration
    	The timeout for any RPCs to the CSI driver. Default is 1 minute. (default 1m0s)
  -v value
    	number for the log level verbosity
  -version
    	Show version.
  -vmodule value
    	comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
  -worker-threads int
    	Number of worker threads. (default 10)
Options (34)
OptionDescriptionSource
-automaxprocsautomatically set GOMAXPROCS to match Linux container CPU quotahelp
-csi-address stringAddress of the CSI driver socket.help
-extra-create-metadataIf set, add snapshot metadata to plugin snapshot requests as parameters.help
-feature-gates valueComma-seprated list of key=value pairs that describe feature gates for alpha/experimental features.help
-groupsnapshot-name-prefix stringPrefix to apply to the name of a created group snapshot (default "groupsnapshot")help
-groupsnapshot-name-uuid-length intLength in characters for the generated uuid of a created group snapshot.help
-http-endpoint :8080The TCP network address where the HTTP server for diagnostics, including metrics and leader election health check, will listen (example: :8080).help
-kube-api-burst intBurst to use while communicating with the kubernetes apiserver.help
-kube-api-qps floatQPS to use while communicating with the kubernetes apiserver.help
-kubeconfig stringAbsolute path to the kubeconfig file.help
-leader-electionEnables leader election.help
-leader-election-lease-duration durationDuration, in seconds, that non-leader candidates will wait to force acquire leadership.help
-leader-election-namespace stringThe namespace where the leader election resource exists.help
-leader-election-renew-deadline durationDuration, in seconds, that the acting leader will retry refreshing leadership before giving up.help
-leader-election-retry-period durationDuration, in seconds, the LeaderElector clients should wait between tries of actions.help
-log-flush-frequency durationMaximum number of seconds between log flushes (default 5s)help
-log-json-info-buffer-size value[Alpha] In JSON format with split output streams, the info messages can be buffered for a while to increase performance.help
-log-json-split-stream[Alpha] In JSON format, write error messages to stderr and info messages to stdout.help
-log-text-info-buffer-size value[Alpha] In text format with split output streams, the info messages can be buffered for a while to increase performance.help
-log-text-split-stream[Alpha] In text format, write error messages to stderr and info messages to stdout.help
-logging-format stringSets the log format.help
-metrics-address :8080(deprecated) The TCP network address where the prometheus metrics endpoint will listen (example: :8080).help
-metrics-path /metricsThe HTTP path where prometheus metrics will be exposed.help
-node-deploymentEnables deploying the sidecar controller together with a CSI driver on nodes to manage snapshots for node-local volumes.help
-resync-period durationResync interval of the controller.help
-retry-interval-max durationMaximum retry interval of failed volume snapshot creation or deletion.help
-retry-interval-start durationInitial retry interval of failed volume snapshot creation or deletion.help
-snapshot-name-prefix stringPrefix to apply to the name of a created snapshot (default "snapshot")help
-snapshot-name-uuid-length intLength in characters for the generated uuid of a created snapshot.help
-timeout durationThe timeout for any RPCs to the CSI driver.help
-v valuenumber for the log level verbosityhelp
-versionShow version.help
-vmodule valuecomma-separated list of pattern=N settings for file-filtered logging (only works for text log format)help
-worker-threads intNumber of worker threads.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.