config

Documentation

Index

• type Config
  • func Default() *Config

Types

type Config

type Config struct {
	// DriverName to be registered at CSI
	DriverName string

	// PluginType flags if the driver is
	// it is a node plugin or controller
	// plugin
	PluginType string

	// Version of the CSI controller/node driver
	Version string

	// Endpoint on which requests are made by kubelet
	// or external provisioner
	//
	// NOTE:
	//  - Controller/node plugin will listen on this
	//  - This will be a unix based socket
	Endpoint string

	// NodeID helps in differentiating the nodes on
	// which node drivers are running. This is useful
	// in case of topologies and publishing or
	// unpublishing volumes on nodes
	NodeID string

	// ListenAddress denotes the tcp address serving prometheus metrics. (example: ":9080").
	// Default is empty string, which means metrics are disabled.
	ListenAddress string

	// MetricsPath denotes the http path where prometheus metrics will be exposed.
	// Default is /metrics
	MetricsPath string

	// Excludes additional process or go runtime related metrics (i.e process_*, go_*).
	// Default is true
	DisableExporterMetrics bool

	// Ignore the Block devices by specifying the matching Regular Expression
	IgnoreBlockDevicesRegex string
}

Config struct fills the parameters of request or user input

func Default

func Default() *Config

Default returns a new instance of config required to initialize a driver instance