common

Documentation

Index

• func GetDriverName() string
• func GetDriverVersion() string
• func GetVersionJSON() (string, error)
• func MergeConfig(driverConfig *Config, driverSecrets map[string]string, ...) map[string]string
• func NormalizeConfigKey(key string) string
• func ParseCSIEndpoint(endpoint string) (string, string, error)
• func ParsePoolServerEndpoint(endpoint string) (string, string, error)
• func RedactConfig(config map[string]string) map[string]string
• type Config
• type VersionInfo
  • func GetVersion() VersionInfo

Functions

func GetDriverName

func GetDriverName() string

GetDriverName returns driver name

func GetDriverVersion

func GetDriverVersion() string

GetDriverVersion returns driver version in string

func GetVersionJSON

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

func MergeConfig

func MergeConfig(driverConfig *Config, driverSecrets map[string]string, volSecrets map[string]string, volParams map[string]string) map[string]string

MergeConfig merges configuration params

func NormalizeConfigKey

func NormalizeConfigKey(key string) string

NormalizeConfigKey normalizes config key

func ParseCSIEndpoint

func ParseCSIEndpoint(endpoint string) (string, string, error)

ParseCSIEndpoint parses endpoint string (TCP or UNIX)

func ParsePoolServerEndpoint

func ParsePoolServerEndpoint(endpoint string) (string, string, error)

ParsePoolServerEndpoint parses endpoint string

func RedactConfig

func RedactConfig(config map[string]string) map[string]string

RedactConfig redacts sensitive values

Types

type Config

type Config struct {
	Endpoint               string // CSI endpoint
	NodeID                 string // node ID
	SecretPath             string // Secret mount path
	PoolServiceEndpoint    string // iRODS FS Pool Service endpoint
	PrometheusExporterPort int    // Prometheus Exporter Service port
	StoragePath            string // Path to storage dir (for saving volume info and etc)
}

Config holds the parameters list which can be configured

type VersionInfo

type VersionInfo struct {
	DriverVersion string `json:"driverVersion"`
	GitCommit     string `json:"gitCommit"`
	BuildDate     string `json:"buildDate"`
	GoVersion     string `json:"goVersion"`
	Compiler      string `json:"compiler"`
	Platform      string `json:"platform"`
}

VersionInfo object contains version related info

func GetVersion

func GetVersion() VersionInfo

GetVersion returns VersionInfo object