Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

utils

package

Go to main page

Versions in this module

v1

v1.0.3

Nov 10, 2022

v1.0.2

Nov 10, 2022

v1.0.1

Nov 10, 2022

v1.0.0

Nov 10, 2022

v0

v0.0.2

Nov 10, 2022

v0.0.1

Nov 10, 2022

Changes in this version

+ const Centos

+ const Darwin

+ const Debian

+ const Linux

+ const PrepCompleted

+ const PrepFailed

+ const PrepOutdated

+ const PrepPending

+ const PrepPreConfigured

+ const PrepRunning

+ const REDACTED

+ const RHEL

+ const SMB

+ const Ubuntu

+ const Windows

+ var NFSVersionMajorMinorRegex = regexp.MustCompile(`^(nfsvers|vers)=(?P<major>\d)\.(?P<minor>\d)$`)

+ var NFSVersionMajorRegex = regexp.MustCompile(`^(nfsvers|vers)=(?P<major>\d)$`)

+ var NFSVersionMinorRegex = regexp.MustCompile(`^minorversion=(?P<minor>\d)$`)

+ func AppendToStringList(stringList, newItem, sep string) string

+ func AreMountOptionsInList(mountOptions string, optionList []string) bool

+ func AttachBlockOnFileVolume(ctx context.Context, mountPath string, publishInfo *VolumePublishInfo) (string, string, error)

+ func AttachISCSIVolume(ctx context.Context, name, mountpoint string, publishInfo *VolumePublishInfo, ...) error

+ func AttachISCSIVolumeRetry(ctx context.Context, name, mountpoint string, publishInfo *VolumePublishInfo, ...) error

+ func AttachNFSVolume(ctx context.Context, name, mountpoint string, publishInfo *VolumePublishInfo) error

+ func AttachSMBVolume(ctx context.Context, name, mountpoint, username, password string, ...) error

+ func AuthError(message string) error

+ func BootstrapError(err error) error

+ func CheckMountOptions(ctx context.Context, procMount MountInfo, mountOptions string) error

+ func ConsistentRead(filename string, attempts int) ([]byte, error)

+ func ConvertSizeToBytes(s string) (string, error)

+ func ConvertToReconcileIncompleteError(err error) error

+ func CountSpacesBeforeText(text string) int

+ func DecryptStringWithAES(encryptedText string, key []byte) (string, error)

+ func DeleteResourceAtPath(ctx context.Context, resource string) error

+ func DetachBlockOnFileVolume(ctx context.Context, loopDevice, loopFile string) error

+ func EncryptStringWithAES(plainText string, key []byte) (string, error)

+ func EnsureDirExists(ctx context.Context, path string) error

+ func EnsureFileExists(ctx context.Context, path string) error

+ func EnsureISCSISessionWithPortalDiscovery(ctx context.Context, hostDataIP string) error

+ func EnsureISCSISessions(ctx context.Context, publishInfo *VolumePublishInfo, portals []string) (bool, error)

+ func EnsureISCSISessionsWithPortalDiscovery(ctx context.Context, hostDataIPs []string) error

+ func EnsureLUKSDevice(ctx context.Context, device, volumeId, luksPassphrase string) (bool, string, error) — darwin/amd64, linux/amd64, windows/amd64

+ func EnsureLUKSDeviceClosed(ctx context.Context, luksDevicePath string) error — darwin/amd64, linux/amd64, windows/amd64

+ func ExpandFilesystemOnNode(ctx context.Context, publishInfo *VolumePublishInfo, ...) (int64, error)

+ func FilterIPs(ctx context.Context, ips, cidrs []string) ([]string, error)

+ func FoundError(message string) error

+ func GenerateAESKey() (string, error)

+ func GenerateVolumePublishName(volumeID, nodeID string) string

+ func GetAllLoopDeviceBackFiles(ctx context.Context) ([]string, error)

+ func GetDeviceFilePath(ctx context.Context, _, volumeId string) (string, error) — darwin/amd64, windows/amd64

+ func GetDeviceFilePath(ctx context.Context, path, volumeId string) (string, error) — linux/amd64

+ func GetDeviceNameFromMount(ctx context.Context, mountpath string) (string, int, error)

+ func GetFilesystemStats(ctx context.Context, _ string) (int64, int64, int64, int64, int64, int64, error) — darwin/amd64

+ func GetFilesystemStats(ctx context.Context, path string) (available, capacity, usage, inodes, inodesFree, inodesUsed int64, err error) — linux/amd64

+ func GetFilesystemStats(ctx context.Context, path string) (int64, int64, int64, int64, int64, int64, error) — windows/amd64

+ func GetFindMultipathValue(text string) string

+ func GetIPAddresses(ctx context.Context) ([]string, error)

+ func GetISCSIHostSessionMapForTarget(ctx context.Context, iSCSINodeName string) map[int]int

+ func GetInitiatorIqns(ctx context.Context) ([]string, error)

+ func GetMountedLoopDevices(ctx context.Context) ([]string, error)

+ func GetNFSVersionFromMountOptions(mountOptions, defaultVersion string, supportedVersions []string) (string, error)

+ func GetNFSVersionMountOptions(mountOptions string) []string

+ func GetPrintableBoolPtrValue(bPtr *bool) string

+ func GetRandomNumber(max int) int

+ func GetRegexSubmatches(r *regexp.Regexp, s string) map[string]string

+ func GetTargetFilePath(ctx context.Context, resourcePath, arg string) string — darwin/amd64, linux/amd64, windows/amd64

+ func GetUnmountPath(ctx context.Context, resourcePath, arg string) (string, error) — darwin/amd64, linux/amd64, windows/amd64

+ func GetV(opts map[string]string, keys, defaultValue string) string

+ func GetVerifiedBlockFsType(filesystemType string) (string, error)

+ func GetVolumeSizeBytes(ctx context.Context, opts map[string]string, defaultVolumeSize string) (uint64, error)

+ func GetYAMLTagWithSpaceCount(text, tagName string) (string, int)

+ func HasUnsupportedCapacityRangeError(err error) (bool, *unsupportedCapacityRangeError)

+ func IPv6Check(ip string) bool

+ func ISCSIActiveOnHost(ctx context.Context, host HostSystem) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func ISCSILogout(ctx context.Context, targetIQN, targetPortal string) error

+ func ISCSIRescanDevices(ctx context.Context, targetIQN string, lunID int32, minSize int64) error

+ func ISCSISupported(ctx context.Context) bool

+ func ISCSITargetHasMountedDevice(ctx context.Context, targetIQN string) (bool, error)

+ func InvalidInputError(message string) error

+ func IsAlreadyAttached(ctx context.Context, lunID int, targetIqn string) bool

+ func IsAuthError(err error) bool

+ func IsBootstrapError(err error) bool

+ func IsCompatible(ctx context.Context, protocol string) error — darwin/amd64, linux/amd64, windows/amd64

+ func IsFoundError(err error) bool

+ func IsInvalidInputError(err error) bool

+ func IsLUKSDeviceOpen(ctx context.Context, luksDevicePath string) (bool, error) — linux/amd64

+ func IsLikelyDir(mountpoint string) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func IsLikelyNotMountPoint(ctx context.Context, mountpoint string) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func IsLoopDeviceAttachedToFile(ctx context.Context, loopDevice, loopFile string) (bool, error)

+ func IsLoopDeviceMounted(ctx context.Context, deviceName string) (mounted bool, err error)

+ func IsMaxLimitReachedError(err error) bool

+ func IsMounted(ctx context.Context, sourceDevice, mountpoint, mountOptions string) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func IsNFSShareMounted(ctx context.Context, exportPath, mountpoint string) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func IsNotFoundError(err error) bool

+ func IsNotReadyError(err error) bool

+ func IsOpenLUKSDevice(ctx context.Context, devicePath string) (bool, error) — darwin/amd64, windows/amd64

+ func IsReconcileDeferredError(err error) bool

+ func IsReconcileFailedError(err error) bool

+ func IsReconcileIncompleteError(err error) bool

+ func IsResourceNotFoundError(err error) bool

+ func IsTempOperatorError(err error) bool

+ func IsTimeoutError(err error) bool

+ func IsTooManyRequestsError(err error) bool

+ func IsUnsupportedConfigError(err error) bool

+ func IsUnsupportedError(err error) bool

+ func IsUnsupportedKubernetesVersionError(err error) bool

+ func IsVolumeCreatingError(err error) bool

+ func IsVolumeDeletingError(err error) bool

+ func Lock(ctx context.Context, lockContext, lockID string)

+ func LogHTTPRequest(request *http.Request, requestBody []byte, redactBody bool)

+ func LogHTTPResponse(ctx context.Context, response *http.Response, responseBody []byte, ...)

+ func Max(x, y int64) int64

+ func MaxLimitReachedError(message string) error

+ func MinInt64(a, b int64) int64

+ func MountDevice(ctx context.Context, device, mountpoint, options string, isMountPointFile bool) (err error) — darwin/amd64, linux/amd64, windows/amd64

+ func NFSActiveOnHost(ctx context.Context) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func NewCSIProxyUtils() (*csiProxyUtils, error) — windows/amd64

+ func NotFoundError(message string) error

+ func NotReadyError() error

+ func PKCS7Pad(input []byte, blockSize int) []byte

+ func PKCS7Unpad(input []byte) ([]byte, error)

+ func PathExists(path string) (bool, error)

+ func Pow(x int64, y int) int64

+ func PrepareDeviceAtMountPathForRemoval(ctx context.Context, mountpoint string, unmount, unsafe, force bool) error

+ func PrepareDeviceForRemoval(ctx context.Context, lunID int, iSCSINodeName string, unsafe, force bool) error

+ func RandomString(strSize int) string

+ func ReconcileDeferredError(err error) error

+ func ReconcileFailedError(err error) error

+ func ReconcileIncompleteError() error

+ func RedactSecretsFromString(stringToSanitize string, replacements map[string]string, useRegex bool) string

+ func RemountDevice(ctx context.Context, mountpoint, options string) (err error) — darwin/amd64, linux/amd64, windows/amd64

+ func RemoveMountPoint(ctx context.Context, mountPointPath string) error — darwin/amd64, linux/amd64, windows/amd64

+ func RemoveMountPointRetry(ctx context.Context, mountPointPath string) error

+ func RemoveStringFromSlice(slice []string, s string) (result []string)

+ func RemoveStringFromSliceConditionally(slice []string, s string, fn func(string, string) bool) (result []string)

+ func ReplaceAtIndex(in string, r rune, index int) (string, error)

+ func ReplaceImageRegistry(image, registry string) string

+ func ResizeLoopDevice(ctx context.Context, loopDevice, loopFile string, requiredBytes int64) error

+ func RunningInContainer() bool

+ func SMBActiveOnHost(ctx context.Context) (bool, error) — darwin/amd64, linux/amd64, windows/amd64

+ func SafeToLogOut(ctx context.Context, hostNumber, sessionNumber int) bool

+ func SafeToRemoveNFSMount(ctx context.Context, nfsMountPoint string) bool

+ func SanitizeMountOptions(mountOptions string, removeMountOptions []string) string

+ func ServiceActiveOnHost(ctx context.Context, service string) (bool, error) — linux/amd64

+ func SetChrootPathPrefix(prefix string)

+ func SetNFSVersionMountOptions(mountOptions, newNFSVersionMountOption string) string

+ func SliceContains(genericSlice, genericElement interface{}) bool

+ func SliceContainsElements(genericSlice, genericElements interface{}) (bool, bool)

+ func SliceContainsString(slice []string, s string) bool

+ func SliceContainsStringCaseInsensitive(slice []string, s string) bool

+ func SliceContainsStringConditionally(slice []string, s string, fn func(string, string) bool) bool

+ func Split(r rune) bool — windows/amd64

+ func SplitImageDomain(name string) (domain, remainder string)

+ func SplitString(_ context.Context, s, sep string) []string

+ func StringInSlice(s string, list []string) bool

+ func TempOperatorError(err error) error

+ func TimeoutError(message string) error

+ func Title(str string) string

+ func ToStringRedacted(structPointer interface{}, redactList []string, configVal interface{}) (out string)

+ func TooManyRequestsError(message string) error

+ func TypeAssertionError(assertion string) error

+ func Umount(ctx context.Context, mountpoint string) (err error) — darwin/amd64, linux/amd64

+ func Umount(ctx context.Context, mountpoint string) error — windows/amd64

+ func UmountAndRemoveMountPoint(ctx context.Context, mountPoint string) error — darwin/amd64, linux/amd64, windows/amd64

+ func UmountAndRemoveTemporaryMountPoint(ctx context.Context, mountPath string) error — darwin/amd64, linux/amd64, windows/amd64

+ func UmountSMBPath(ctx context.Context, mappingPath, path string) (err error) — windows/amd64

+ func UmountSMBPath(ctx context.Context, mappingPath, target string) (err error) — linux/amd64

+ func UmountSMBPath(ctx context.Context, mappingPath, target string) error — darwin/amd64

+ func Unlock(ctx context.Context, lockContext, lockID string)

+ func UnsupportedCapacityRangeError(err error) error

+ func UnsupportedConfigError(err error) error

+ func UnsupportedError(message string) error

+ func UnsupportedKubernetesVersionError(err error) error

+ func ValidateCIDRs(ctx context.Context, cidrs []string) error

+ func ValidateOctalUnixPermissions(perms string) error

+ func VerifyFilesystemSupport(fs string) (string, error)

+ func VolumeCreatingError(message string) error

+ func VolumeDeletingError(message string) error

+ func VolumeSizeWithinTolerance(requestedSize, currentSize, delta int64) (bool, error)

+ func WaitForLoopDeviceDetach(ctx context.Context, nfsMountpoint, loopFile string, maxDuration time.Duration) error

+ func WaitForResourceDeletionAtPath(ctx context.Context, resource string, maxDuration time.Duration) error

+ func WindowsBindMount(ctx context.Context, source, target string, options []string) (err error) — linux/amd64, windows/amd64

+ func WindowsBindMount(ctx context.Context, source, target string, options []string) error — darwin/amd64

+ type CSIProxyUtils interface

+ EvalHostSymlinks func(context.Context, string) (string, error)

+ ExistsPath func(context.Context, string) (bool, error)

+ GetAPIVersions func(ctx context.Context) string

+ GetFilesystemUsage func(context.Context, string) (int64, int64, error)

+ IsMountPointMatch func(context.Context, mount.MountPoint, string) bool

+ MakeDir func(context.Context, string) error

+ Rmdir func(context.Context, string) error

+ SMBMount func(context.Context, string, string, string, string, string) error

+ SMBUnmount func(context.Context, string, string) error

+ type CertInfo struct

+ CACert string

+ CAKey string

+ ClientCert string

+ ClientKey string

+ ServerCert string

+ ServerKey string

+ func MakeHTTPCertInfo(caCertName, serverCertName, clientCertName string) (*CertInfo, error)

+ type DFInfo struct

+ Source string

+ Target string

+ func GetDFOutput(ctx context.Context) ([]DFInfo, error)

+ type HTTPError struct

+ Status string

+ StatusCode int

+ func NewHTTPError(response *http.Response) *HTTPError

+ func (e HTTPError) Error() string

+ type HostSystem struct

+ OS SystemOS

+ Services []string

+ func GetHostSystemInfo(ctx context.Context) (*HostSystem, error)

+ type ISCSIDiscoveryInfo struct

+ Portal string

+ PortalIP string

+ TargetName string

+ type ISCSISessionInfo struct

+ Portal string

+ PortalIP string

+ SID string

+ TargetName string

+ type IscsiAccessInfo struct

+ IscsiIgroup string

+ IscsiInterface string

+ IscsiLunNumber int32

+ IscsiLunSerial string

+ IscsiPortals []string

+ IscsiTargetIQN string

+ IscsiTargetPortal string

+ IscsiVAGs []int64

+ type IscsiChapInfo struct

+ IscsiInitiatorSecret string

+ IscsiTargetSecret string

+ IscsiTargetUsername string

+ IscsiUsername string

+ UseCHAP bool

+ func (i IscsiChapInfo) String() string

+ type LUKSDevice struct

+ func (d *LUKSDevice) Close(ctx context.Context) error

+ func (d *LUKSDevice) DevicePath() string

+ func (d *LUKSDevice) IsLUKSFormatted(ctx context.Context) (bool, error)

+ func (d *LUKSDevice) IsOpen(ctx context.Context) (bool, error)

+ func (d *LUKSDevice) LUKSDeviceName() string

+ func (d *LUKSDevice) LUKSDevicePath() string

+ func (d *LUKSDevice) LUKSFormat(ctx context.Context, luksPassphrase string) error

+ func (d *LUKSDevice) Open(ctx context.Context, luksPassphrase string) error

+ type LUKSDeviceInterface interface

+ DevicePath func() string

+ IsLUKSFormatted func(ctx context.Context) (bool, error)

+ IsOpen func(ctx context.Context) (bool, error)

+ LUKSDeviceName func() string

+ LUKSDevicePath func() string

+ LUKSFormat func(ctx context.Context, luksPassphrase string) error

+ Open func(ctx context.Context, luksPassphrase string) error

+ type LoopDevice struct

+ BackFile string

+ Name string

+ func GetLoopDeviceAttachedToFile(ctx context.Context, loopFile string) (bool, *LoopDevice, error)

+ type LoopDevicesResponse struct

+ LoopDevices []LoopDevice

+ type MountInfo struct

+ DeviceId string

+ FsType string

+ MountId int

+ MountOptions []string

+ MountPoint string

+ MountSource string

+ ParentId int

+ Root string

+ SuperOptions []string

+ func GetHostMountInfo(ctx context.Context) ([]MountInfo, error)

+ func GetSelfMountInfo(ctx context.Context) ([]MountInfo, error)

+ type MountPoint struct

+ Device string

+ Freq int

+ Opts []string

+ Pass int

+ Path string

+ Type string

+ type NfsAccessInfo struct

+ NfsPath string

+ NfsServerIP string

+ NfsUniqueID string

+ type NfsBlockAccessInfo struct

+ NFSMountpoint string

+ SubvolumeMountOptions string

+ SubvolumeName string

+ type Node struct

+ Deleted bool

+ HostInfo *HostSystem

+ IPs []string

+ IQN string

+ Name string

+ NodePrep *NodePrep

+ TopologyLabels map[string]string

+ type NodePrep struct

+ Enabled bool

+ ISCSI NodePrepStatus

+ ISCSIStatusMessage string

+ NFS NodePrepStatus

+ NFSStatusMessage string

+ type NodePrepBreadcrumb struct

+ ISCSI string

+ NFS string

+ TridentVersion string

+ type NodePrepStatus string

+ type SMBAccessInfo struct

+ SMBPath string

+ SMBServer string

+ type ScsiDeviceInfo struct

+ Channel string

+ Devices []string

+ Filesystem string

+ Host string

+ HostSessionMap map[int]int

+ IQN string

+ LUN string

+ MultipathDevice string

+ Target string

+ func GetISCSIDevices(ctx context.Context) ([]*ScsiDeviceInfo, error)

+ func GetMountedISCSIDevices(ctx context.Context) ([]*ScsiDeviceInfo, error)

+ type SystemOS struct

+ Distro string

+ Release string

+ Version string

+ type Version struct

+ func MustParseDate(str string) *Version

+ func MustParseGeneric(str string) *Version

+ func MustParseMajorMinorVersion(str string) *Version

+ func MustParseSemantic(str string) *Version

+ func ParseDate(str string) (*Version, error)

+ func ParseGeneric(str string) (*Version, error)

+ func ParseSemantic(str string) (*Version, error)

+ func (v *Version) AtLeast(min *Version) bool

+ func (v *Version) BuildMetadata() string

+ func (v *Version) Compare(other string) (int, error)

+ func (v *Version) GreaterThan(other *Version) bool

+ func (v *Version) LessThan(other *Version) bool

+ func (v *Version) MajorVersion() uint

+ func (v *Version) MajorVersionString() string

+ func (v *Version) MinorVersion() uint

+ func (v *Version) MinorVersionString() string

+ func (v *Version) PatchVersion() uint

+ func (v *Version) PreRelease() string

+ func (v *Version) ShortString() string

+ func (v *Version) ShortStringWithRelease() string

+ func (v *Version) String() string

+ func (v *Version) ToMajorMinorString() string

+ func (v *Version) ToMajorMinorVersion() *Version

+ type VolumeAccessInfo struct

+ AccessMode int32

+ MountOptions string

+ PublishEnforcement bool

+ ReadOnly bool

+ type VolumePublication struct

+ AccessMode int32

+ Name string

+ NodeName string

+ NotSafeToAttach bool

+ ReadOnly bool

+ Unpublished bool

+ VolumeName string

+ func (v *VolumePublication) ConstructExternal() *VolumePublicationExternal

+ type VolumePublicationExternal struct

+ AccessMode int32

+ Name string

+ NodeName string

+ NotSafeToAttach bool

+ ReadOnly bool

+ VolumeName string

+ type VolumePublishInfo struct

+ BackendUUID string

+ DevicePath string

+ FilesystemType string

+ HostIP []string

+ HostIQN []string

+ HostName string

+ LUKSEncryption string

+ Localhost bool

+ Nodes []*Node

+ SharedTarget bool

+ StagingMountpoint string

+ TridentUUID string

+ Unmanaged bool

+ type VolumeTrackingPublishInfo struct

+ StagingTargetPath string