OS Manuals

/usr/bin/snapshot-controller

From kubernetes-csi-external-snapshot-controller-8.6 8.6.0-r1 (os), captured 2026-11-05 by running snapshot-controller --help (exit 0). permalink

Also provided by 13 other package versions
Usage of /usr/bin/snapshot-controller:
  -automaxprocs
    	automatically set GOMAXPROCS to match Linux container CPU quota
  -enable-distributed-snapshotting
    	Enables each node to handle snapshotting for the local volumes created on that node
  -feature-gates value
    	Comma-seprated list of key=value pairs that describe feature gates for alpha/experimental features. Options are:
    	APIResponseCompression=true|false (BETA - default=true)
    	APIServerIdentity=true|false (BETA - default=true)
    	APIServingWithRoutine=true|false (ALPHA - default=false)
    	AllAlpha=true|false (ALPHA - default=false)
    	AllBeta=true|false (BETA - default=false)
    	AllowParsingUserUIDFromCertAuth=true|false (BETA - default=true)
    	AllowUnsafeMalformedObjectDeletion=true|false (ALPHA - default=false)
    	CBORServingAndStorage=true|false (ALPHA - default=false)
    	CSIVolumeGroupSnapshot=true|false (BETA - default=false)
    	ComponentFlagz=true|false (BETA - default=true)
    	ComponentStatusz=true|false (BETA - default=true)
    	ConcurrentWatchObjectDecode=true|false (BETA - default=false)
    	ConstrainedImpersonation=true|false (BETA - default=true)
    	CoordinatedLeaderElection=true|false (BETA - default=false)
    	DeclarativeValidationBeta=true|false (BETA - default=true)
    	DetectCacheInconsistency=true|false (BETA - default=true)
    	ListFromCacheSnapshot=true|false (BETA - default=true)
    	ManifestBasedAdmissionControlConfig=true|false (ALPHA - default=false)
    	NativeHistograms=true|false (ALPHA - default=false)
    	OpenAPIEnums=true|false (BETA - default=true)
    	ReleaseLeaderElectionOnExit=true|false (ALPHA - default=false)
    	RemoteRequestHeaderUID=true|false (BETA - default=true)
    	ShardedListAndWatch=true|false (ALPHA - default=false)
    	SizeBasedListCostEstimate=true|false (BETA - default=true)
    	StorageVersionAPI=true|false (ALPHA - default=false)
    	StorageVersionHash=true|false (BETA - default=true)
    	StructuredAuthenticationConfigurationEgressSelector=true|false (BETA - default=true)
    	StructuredAuthenticationConfigurationJWKSMetrics=true|false (BETA - default=true)
    	TokenRequestServiceAccountUIDValidation=true|false (BETA - default=true)
    	UnauthenticatedHTTP2DOSMitigation=true|false (BETA - default=true)
    	UnknownVersionInteroperabilityProxy=true|false (BETA - default=true)
    	WatchCacheInitializationPostStartHook=true|false (BETA - default=true)
    	WatchList=true|false (BETA - default=true)
  -http-endpoint string
    	The TCP network address where the HTTP server for diagnostics, including metrics, will listen (example: :8080). The default is empty string, which means the server is disabled.
  -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-path /metrics
    	The HTTP path where prometheus metrics will be exposed. Default is /metrics. (default "/metrics")
  -prevent-volume-mode-conversion
    	Prevents an unauthorised user from modifying the volume mode when creating a PVC from an existing VolumeSnapshot. (default true)
  -resync-period duration
    	Resync interval of the controller. (default 15m0s)
  -retry-crd-interval-max duration
    	Maximum time to wait for CRDs to appear. The default is 30 seconds. (default 30s)
  -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)
  -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 (28)
OptionDescriptionSource
-automaxprocsautomatically set GOMAXPROCS to match Linux container CPU quotahelp
-enable-distributed-snapshottingEnables each node to handle snapshotting for the local volumes created on that nodehelp
-feature-gates valueComma-seprated list of key=value pairs that describe feature gates for alpha/experimental features.help
-http-endpoint stringThe TCP network address where the HTTP server for diagnostics, including metrics, 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-path /metricsThe HTTP path where prometheus metrics will be exposed.help
-prevent-volume-mode-conversionPrevents an unauthorised user from modifying the volume mode when creating a PVC from an existing VolumeSnapshot.help
-resync-period durationResync interval of the controller.help
-retry-crd-interval-max durationMaximum time to wait for CRDs to appear.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
-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.