OS Manuals

/usr/bin/cinder-csi-plugin

Cinder-CSI-Plugin is a Kubernetes CSI driver for provisioning and managing OpenStack Cinder volumes

From cinder-csi-plugin-fips 1.37.1-r2 (enterprise-packages), captured 2026-11-08 by running cinder-csi-plugin --help (exit 0). permalink

CSI based Cinder driver

Usage:
  cinder-csi-plugin [flags]

Flags:
      --additional-topology stringToString   Additional CSI driver topology keys, for example topology.kubernetes.io/region=REGION1. This option can be specified multiple times to add multiple additional topology keys. (default [])
      --attach-mode string                   Volume attach mode: 'nova' uses Nova attach/detach, 'direct' uses Cinder Attachment API with os-brick sidecar for direct attachment (typically bare-metal nodes) (default "nova")
      --cloud-config strings                 CSI driver cloud config. This option can be given multiple times
      --cloud-name strings                   Cloud name to instruct CSI driver to read additional OpenStack cloud credentials from the configuration subsections. This option can be specified multiple times to manage multiple OpenStack clouds.
      --cluster string                       The identifier of the cluster that the plugin is running in.
      --endpoint string                      CSI endpoint
  -h, --help                                 help for cinder-csi-plugin
      --http-endpoint :8080                  The TCP network address where the HTTP server for providing metrics for diagnostics, 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. (default 10)
      --kube-api-qps float32                 QPS to use while communicating with the kubernetes apiserver. (default 5)
      --kubeconfig string                    Absolute path to the kubeconfig file. Either this or master needs to be set if the provisioner is being run out of cluster.
      --log-flush-frequency duration         Maximum number of seconds between log flushes (default 5s)
      --master string                        Master URL to build a client config from. Either this or kubeconfig needs to be set if the provisioner is being run out of cluster.
      --min-resync-period duration           The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod. (default 12h0m0s)
      --provide-controller-service           If set to true then the CSI driver does provide the controller service (default: true) (default true)
      --provide-node-service                 If set to true then the CSI driver does provide the node service (default: true) (default true)
      --pvc-annotations                      Enable support for PVC annotations in the controller's CreateVolume CSI method (enabling this flag requires enabling the --extra-create-metadata flag in csi-provisioner)
      --user-agent stringArray               Extra data to add to gophercloud user-agent. Use multiple times to add more than one component.
  -v, --v Level                              number for the log level verbosity
      --version                              version for cinder-csi-plugin
      --vmodule moduleSpec                   comma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format)
      --with-topology                        cluster is topology-aware (default true)
Options (22)
OptionDescriptionSource
--additional-topology stringToStringAdditional CSI driver topology keys, for example topology.kubernetes.io/region=REGION1.help
--attach-mode stringVolume attach mode: 'nova' uses Nova attach/detach, 'direct' uses Cinder Attachment API with os-brick sidecar for direct attachment (typically bare-metal nodes) (default "nova")help
--cloud-config stringsCSI driver cloud config.help
--cloud-name stringsCloud name to instruct CSI driver to read additional OpenStack cloud credentials from the configuration subsections.help
--cluster stringThe identifier of the cluster that the plugin is running in.help
--endpoint stringCSI endpointhelp
-h, --helphelp for cinder-csi-pluginhelp
--http-endpoint :8080The TCP network address where the HTTP server for providing metrics for diagnostics, will listen (example: :8080).help
--kube-api-burst intBurst to use while communicating with the kubernetes apiserver.help
--kube-api-qps float32QPS to use while communicating with the kubernetes apiserver.help
--kubeconfig stringAbsolute path to the kubeconfig file.help
--log-flush-frequency durationMaximum number of seconds between log flushes (default 5s)help
--master stringMaster URL to build a client config from.help
--min-resync-period durationThe resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.help
--provide-controller-serviceIf set to true then the CSI driver does provide the controller service (default: true) (default true)help
--provide-node-serviceIf set to true then the CSI driver does provide the node service (default: true) (default true)help
--pvc-annotationsEnable support for PVC annotations in the controller's CreateVolume CSI method (enabling this flag requires enabling the --extra-create-metadata flag in csi-provisioner)help
--user-agent stringArrayExtra data to add to gophercloud user-agent.help
-v, --v Levelnumber for the log level verbosityhelp
--versionversion for cinder-csi-pluginhelp
--vmodule moduleSpeccomma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format)help
--with-topologycluster is topology-aware (default true)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.