utils

Documentation

Index

• Constants
• Variables
• func CallerWithCondLock[T any](cond *sync.Cond, f func() T) T
• func ContainsIgnoredCase(s []string, k string) bool
• func ForceUmountWithTimeout(path string, timeout time.Duration) error
• func GetFullDevPath(shortPath string) string
• func GetHostNamespacePath(hostProcPath string) string
• func IsFSCorrupted(err error) bool
• func IsHostProcMounted() (bool, error)
• func IsSupportedFileSystem(fsType string) bool
• func MakeExt4DiskFormatting(devPath, uuid string) error
• func MatchesIgnoredCase(s []string, k string) bool
• func MountDisk(devPath, mountPoint string) error
• func UmountDisk(path string) error
• func XMLWriter(targetFilePath string, xmlData any) error
• type Disk
  • func DiskXMLReader(filePath string) (Disk, error)
• type Driver
• type Executor
  • func NewExecutor() *Executor
  • func NewExecutorWithNS(ns string) (*Executor, error)
  • func (exec *Executor) Execute(cmd string, args []string) (string, error)
  • func (exec *Executor) SetTimeout(timeout time.Duration)
• type Source
• type Target

Constants

const (
	DockerdProcess        = "dockerd"
	ContainerdProcess     = "containerd"
	ContainerdProcessShim = "containerd-shim"
)

const (
	// ProcPath is a vfs storing process info for Linux.
	ProcPath = "/proc"
	// HostProcPath is the convention path where host `/proc` is mounted.
	HostProcPath = "/host/proc"
	// DiskRemoveTag indicates a Longhorn is pending to remove.
	DiskRemoveTag = "harvester-ndm-disk-remove"
)

const (
	NSBinary = "nsenter"
)

Variables

var CmdTimeoutError error

Functions

func CallerWithCondLock

func CallerWithCondLock[T any](cond *sync.Cond, f func() T) T

CallerWithLock is a helper function to call a function with a condition lock

func ContainsIgnoredCase

func ContainsIgnoredCase(s []string, k string) bool

ContainsIgnoredCase checks if the item of string slice contains the key with case-insensitive

func ForceUmountWithTimeout

func ForceUmountWithTimeout(path string, timeout time.Duration) error

ForceUmountWithTimeout umounts the specific device with timeout to the specified path

func GetFullDevPath

func GetFullDevPath(shortPath string) string

GetFullDevPath will return full path with `/dev/` prefix

func GetHostNamespacePath

func GetHostNamespacePath(hostProcPath string) string

func IsFSCorrupted

func IsFSCorrupted(err error) bool

IsFSCorrupted checks if the error is caused by a corrupted filesystem

func IsHostProcMounted

func IsHostProcMounted() (bool, error)

IsHostProcMounted checks if host's proc info `/proc` is mounted on `/host/proc`

func IsSupportedFileSystem

func IsSupportedFileSystem(fsType string) bool

IsSupportedFileSystem checks if the filesystem type is supported

func MakeExt4DiskFormatting

func MakeExt4DiskFormatting(devPath, uuid string) error

MakeExt4DiskFormatting formats the specified volume device to ext4 with the specified UUID return error if failed

func MatchesIgnoredCase

func MatchesIgnoredCase(s []string, k string) bool

MatchesIgnoredCase checks if the item of string slice fully match the key with case-insensitive

func MountDisk

func MountDisk(devPath, mountPoint string) error

MountDisk mounts the specified ext4 volume device to the specified path

func UmountDisk

func UmountDisk(path string) error

UmountDisk unmounts the specified volume device to the specified path

func XMLWriter

func XMLWriter(targetFilePath string, xmlData any) error

XMLWriter write XML to target file, make sure your xmlData should valid

Types

type Disk

type Disk struct {
	XMLName xml.Name `xml:"disk"`
	Type    string   `xml:"type,attr"`
	Device  string   `xml:"device,attr"`
	Driver  Driver   `xml:"driver"`
	Source  Source   `xml:"source"`
	Target  Target   `xml:"target"`
	WWN     string   `xml:"wwn"`
	VENDOR  string   `xml:"vendor"`
}

func DiskXMLReader

func DiskXMLReader(filePath string) (Disk, error)

DiskXMLReader can read the libvirt disk xml file and return a Disk struct

type Driver

type Driver struct {
	Name string `xml:"name,attr"`
	Type string `xml:"type,attr"`
}

type Executor

type Executor struct {
	// contains filtered or unexported fields
}

func NewExecutor

func NewExecutor() *Executor

func NewExecutorWithNS

func NewExecutorWithNS(ns string) (*Executor, error)

func (*Executor) Execute

func (exec *Executor) Execute(cmd string, args []string) (string, error)

func (*Executor) SetTimeout

func (exec *Executor) SetTimeout(timeout time.Duration)

type Source

type Source struct {
	File string `xml:"file,attr"`
}

type Target

type Target struct {
	Dev string `xml:"dev,attr"`
	Bus string `xml:"bus,attr"`
}