constants

Documentation

Index

• Constants

Constants

const (
	// PluginName is the name of the CSI plug-in.
	PluginName = "csi-isilon.dellemc.com"

	// DefaultAccessZone is "System"
	DefaultAccessZone = "System"
	// ModeNode is csi driver's "mode "deployment mode
	ModeNode = "node"
	// ModeController is csi driver's "controller "deployment mode
	ModeController = "controller"

	// DefaultVolumeSizeInBytes is default volume sgolang/protobuf/blob/master/ptypesize to create on an Isilon
	// cluster when no size is given, expressed in bytes
	DefaultVolumeSizeInBytes = 3 * BytesInGiB

	// BytesInGiB is the number of bytes in a gibibyte
	BytesInGiB = 1024 * 1024 * 1024
	// TRUE constant
	TRUE = "TRUE"
	// FALSE constant
	FALSE = "FALSE"

	// DefaultPortNumber is the port number in default to set the HTTPS port number of the Isilon OneFS API server
	DefaultPortNumber = "8080"

	// DefaultIsiPath is the default isiPath which will be used if there's
	// no proper isiPath value set in neither storageclass.yaml nor values.yaml
	DefaultIsiPath = "/ifs"

	// DefaultIsiVolumePathPermissions are the default permissions for volume directory path
	DefaultIsiVolumePathPermissions = "0777"

	// MaxIsiConnRetries is the max number of retries to validate connection to PowerScale Array
	MaxIsiConnRetries = 10

	// KubeConfig of kubernetes cluster
	KubeConfig = "KUBECONFIG"

	// VolumeSnapshotsPath is the snapshot directory base path on PowerScale array
	VolumeSnapshotsPath = "/ifs/.snapshot"

	//IsilonConfigFile isilon-creds file with credential info of isilon clusters
	IsilonConfigFile = "/isilon-configs/config"

	//DefaultLogLevel for csi logs
	DefaultLogLevel = logrus.DebugLevel

	//ParamCSILogLevel csi driver log level
	ParamCSILogLevel = "CSI_LOG_LEVEL"

	//DefaultPodmonAPIPortNumber is the port number in default to expose internal health APIs
	DefaultPodmonAPIPortNumber = "8083"

	//DefaultPodmonPollRate is the default polling frequency to check for array connectivity
	DefaultPodmonPollRate = 60
)

const (

	// EnvCSIEndpoint is the name of the unix domain socket that the csi driver is listening on
	EnvCSIEndpoint = "CSI_ENDPOINT"

	// EnvPort is the name of the enviroment variable used to set the
	// HTTPS port number of the Isilon OneFS API server
	EnvPort = "X_CSI_ISI_PORT"

	// EnvSkipCertificateValidation is the name of the enviroment variable used to specify
	// that the Isilon OneFS API server's certificate chain and host name should not
	// be verified
	EnvSkipCertificateValidation = "X_CSI_ISI_SKIP_CERTIFICATE_VALIDATION"

	// EnvIsiAuthType sets the default Authentication method as Basic Authentication
	EnvIsiAuthType = "X_CSI_ISI_AUTH_TYPE"

	// EnvPath is the root path under which all the volumes (directories) will be provisioned, e.g. /ifs/engineering
	EnvPath = "X_CSI_ISI_PATH"

	// EnvIsiVolumePathPermissions is the default permissions for volume directory path, e.g. 0777
	EnvIsiVolumePathPermissions = "X_CSI_ISI_VOLUME_PATH_PERMISSIONS"

	// EnvIgnoreUnresolvableHosts exhibits default OneFS behavior of failing to add export if any of existing hosts from
	// same export is unresolvable
	EnvIgnoreUnresolvableHosts = "X_CSI_ISI_IGNORE_UNRESOLVABLE_HOSTS"

	// EnvAutoProbe is the name of the environment variable used to specify
	// that the controller service should automatically probe itself if it
	// receives incoming requests before having been probed, in direct
	// violation of the CSI spec
	EnvAutoProbe = "X_CSI_ISI_AUTOPROBE"

	// EnvGOCSIDebug indicates whether to print REQUESTs and RESPONSEs of all CSI method calls(from gocsi)
	EnvGOCSIDebug = "X_CSI_DEBUG"

	// EnvVerbose indicates whether the driver should log OneFS REST API response body content
	EnvVerbose = "X_CSI_VERBOSE"

	// EnvQuotaEnabled is the boolean flag that indicates whether the provisioner should attempt to set (later unset) quota on a newly provisioned volume
	EnvQuotaEnabled = "X_CSI_ISI_QUOTA_ENABLED"

	// EnvAccessZone is the name of the access zone a volume can be created in, e.g. "System"
	EnvAccessZone = "X_CSI_ISI_ACCESS_ZONE"

	// EnvNoProbeOnStart indicates whether a probe should be attempted upon start
	EnvNoProbeOnStart = "X_CSI_ISI_NO_PROBE_ON_START"

	// EnvNodeName is the name of a k8s node
	EnvNodeName = "X_CSI_NODE_NAME"

	// EnvNodeIP is the ip address of a k8s node
	EnvNodeIP = "X_CSI_NODE_IP"

	// EnvCustomTopologyEnabled indicates if custom topology has to be used by CSI Driver
	EnvCustomTopologyEnabled = "X_CSI_CUSTOM_TOPOLOGY_ENABLED"

	// EnvKubeConfigPath indicates kubernetes configuration that has to be used by CSI Driver
	EnvKubeConfigPath = "KUBECONFIG"

	// EnvAllowedNetworks indicates list of networks on which NFS traffic is allowed
	EnvAllowedNetworks = "X_CSI_ALLOWED_NETWORKS"

	// EnvIsilonConfigFile specifies the filepath containing Isilon cluster's config details
	EnvIsilonConfigFile = "X_CSI_ISI_CONFIG_PATH"

	// EnvMaxVolumesPerNode specifies maximum number of volumes that controller can publish to the node.
	EnvMaxVolumesPerNode = "X_CSI_MAX_VOLUMES_PER_NODE"

	// EnvIsHealthMonitorEnabled specifies if health monitor is enabled.
	EnvIsHealthMonitorEnabled = "X_CSI_HEALTH_MONITOR_ENABLED"

	// EnvReplicationContextPrefix enables sidecars to read required information from volume context
	EnvReplicationContextPrefix = "X_CSI_REPLICATION_CONTEXT_PREFIX"

	// EnvReplicationPrefix is used as a prefix to find out if replication is enabled
	EnvReplicationPrefix = "X_CSI_REPLICATION_PREFIX"

	//EnvPodmonEnabled indicates that podmon is enabled
	EnvPodmonEnabled = "X_CSI_PODMON_ENABLED"

	//EnvPodmonAPIPORT indicates the port to be used for exposing podmon API health
	EnvPodmonAPIPORT = "X_CSI_PODMON_API_PORT"

	//EnvPodmonArrayConnectivityPollRate indicates the polling frequency to check array connectivity
	EnvPodmonArrayConnectivityPollRate = "X_CSI_PODMON_ARRAY_CONNECTIVITY_POLL_RATE"
)