consts

Documentation

Index

• Constants
• Variables
• type DependencyModuleType
• type OperatingSystem

Constants

const (
	// Binary names
	CmdLonghornctlLocal  = "longhornctl-local"
	CmdLonghornctlRemote = "longhornctl"
)

const (
	// The first layer of subcommands (verb)
	SubCmdCheck   = "check"
	SubCmdExport  = "export"
	SubCmdGet     = "get"
	SubCmdInstall = "install"
	SubCmdTrim    = "trim"

	// The second layer of subcommands (noun)
	SubCmdPreflight = "preflight"
	SubCmdReplica   = "replica"
	SubCmdVolume    = "volume"

	// The third layer of subcommands (action to the previous layers)
	SubCmdStop = "stop"

	// Other subcommands
	SubCmdVersion = "version"
)

const (
	// Global options
	CmdOptKubeConfigPath = "kube-config"
	CmdOptLogLevel       = "log-level"
	CmdOptImage          = "image"

	// General options
	CmdOptName            = "name"
	CmdOptNodeId          = "node-id"
	CmdOptOperatingSystem = "operating-system"
	CmdOptOutputFile      = "output-file"
	CmdOptTargetDirectory = "target-dir"
	CmdOptUpdatePackages  = "update-packages"

	// SPDK options
	CmdOptAllowPci        = "allow-pci"
	CmdOptDriverOverride  = "driver-override"
	CmdOptEnableSpdk      = "enable-spdk"
	CmdOptHugePageSize    = "huge-page-size"
	CmdOptSpdkOptions     = "spdk-options"
	CmdOptUserspaceDriver = "userspace-driver"

	// Longhorn options
	CmdOptLonghornDataDirectory = "data-dir"
	CmdOptLonghornEngineImage   = "engine-image"
	CmdOptLonghornNamespace     = "longhorn-namespace"
	CmdOptLonghornVolumeName    = "volume-name"
)

const (
	EnvCurrentNodeID  = "CURRENT_NODE_ID"
	EnvKubeConfigPath = "KUBECONFIG"
	EnvLogLevel       = "LOG_LEVEL"
	EnvOutputFilePath = "OUTPUT_FILE_PATH"

	EnvLonghornDataDirectory = "LONGHORN_DATA_DIRECTORY"
	EnvLonghornNamespace     = "LONGHORN_NAMESPACE"
	EnvLonghornReplicaName   = "REPLICA_NAME"
	EnvLonghornVolumeName    = "VOLUME_NAME"
)

const (
	EnvDriverOverride    = "DRIVER_OVERRIDE"
	EnvEnableSpdk        = "ENABLE_SPDK"
	EnvHugePageSize      = "HUGEMEM"
	EnvPciAllowed        = "PCI_ALLOWED"
	EnvUserspaceDriver   = "USERSPACE_DRIVER"
	EnvUpdatePackageList = "UPDATE_PACKAGE_LIST"
	EnvSpdkOptions       = "SPDK_OPTIONS"
)

SPDK related environment variables

const (
	ImageBciBase = "registry.suse.com/bci/bci-base:15.5"
	ImagePause   = "registry.k8s.io/pause:3.1"
)

const (
	ContainerName       = "longhornctl"
	ContainerNameEngine = "engine"
	ContainerNameInit   = "init-longhornctl"
	ContainerNameOutput = "output-longhornctl"
	ContainerNamePause  = "pause"
)

const (
	ContainerConditionMaxTolerationLong   = 60 * 10 // 10 minutes: for container responsible for long running tasks. For example: package installation.
	ContainerConditionMaxTolerationMedium = 60 * 5  // 5 minutes: for container responsible for medium running tasks. For example: export replica.
	ContainerConditionMaxTolerationShort  = 60      // 1 minute: for container responsible for short running tasks. For example: print file contents.
)

const (
	VolumeMountHostName      = "host"
	VolumeMountHostDirectory = "/host"

	VolumeMountSharedName      = "shared"
	VolumeMountSharedDirectory = "/shared"

	VolumeMountHostExporterName      = "host-exporter"
	VolumeMountHostExporterDirectory = "/host-exporter"

	VolumeMountEntrypointName      = "entrypoint"
	VolumeMountEntrypointDirectory = "/scripts"

	VolumeMountVolumeName      = "volume"
	VolumeMountVolumeDirectory = "/volume"
)

const (
	FileNamePreStopScript = "pre-stop.sh"
	FileNameOutputJSON    = "output.json"
)

const (
	LogPrefixError = "ERROR: "
	LogPrefixWarn  = "WARN: "
)

const (
	AppNamePreflightChecker              = "longhorn-preflight-checker"
	AppNamePreflightContainerOptimizedOS = "longhorn-gke-cos-node-agent"
	AppNamePreflightInstaller            = "longhorn-preflight-installer"
)

const (
	AppNameReplicaExporter = "longhorn-replica-exporter"
	AppNameReplicaGetter   = "longhorn-replica-getter"
)

const (
	AppNameVolumeTrimmer = "longhorn-volume-trimmer"
)

const CmdOptSeperator = ","

const LonghornDiskConfigFile = "longhorn-disk.cfg"

const LonghornServiceAccountName = "longhorn-service-account"

const SpdkPath = "/tmp/longhorn-spdk"

Variables

var (
	ImageEngine      = fmt.Sprintf("longhornio/longhorn-engine:%s", meta.Version)
	ImageLonghornCli = fmt.Sprintf("longhornio/longhorn-cli:%s", meta.Version)
)

Types

type DependencyModuleType

type DependencyModuleType int

const (
	DependencyModuleDefault DependencyModuleType = iota
	DependencyModuleSpdk
)

type OperatingSystem

type OperatingSystem string

const (
	OperatingSystemContainerOptimizedOS OperatingSystem = "cos"
)