util

Documentation

Index

• Constants
• func AppendLabels(src, dest map[string]string) map[string]string
• func AppendZeroWithTruncate(outFile *os.File, start, length int64) error
• func AppendZeroWithWrite(outFile *os.File, start, length int64) error
• func CalculateOverheadSpace(filesystemOverhead float64, availableSpace int64) int64
• func CopyDir(source string, dest string) error
• func CopyFile(src, dst string) error
• func GetAvailableSpace(path string) (int64, error)
• func GetAvailableSpaceBlock(deviceName string) (int64, error)
• func GetAvailableSpaceByVolumeMode(volumeMode v1.PersistentVolumeMode) (int64, error)
• func GetNamespace() string
• func GetRecommendedInstallerLabelsFromCr(cr *cdiv1.CDI) map[string]string
• func GetUsableSpace(filesystemOverhead float64, availableSpace int64) int64
• func IsDevice(deviceName string) (bool, error)
• func LinkFile(source, target string) error
• func Md5sum(filePath string) (string, error)
• func MergeLabels(src, dest map[string]string) map[string]string
• func MinQuantity(availableSpace, imageSize *resource.Quantity) resource.Quantity
• func OpenFileOrBlockDevice(fileName string) (*os.File, error)
• func ParseEnvVar(envVarName string, decode bool) (string, error)
• func PunchHole(outFile *os.File, start, length int64) error
• func RandAlphaNum(n int) string
• func ResolveVolumeMode(volumeMode *v1.PersistentVolumeMode) v1.PersistentVolumeMode
• func RoundDown(number, multiple int64) int64
• func RoundUp(number, multiple int64) int64
• func SetRecommendedLabels(obj metav1.Object, installerLabels map[string]string, controllerName string)
• func StreamDataToFile(r io.Reader, fileName string, preallocate bool) (int64, int64, error)
• func UnArchiveTar(reader io.Reader, destDir string) error
• func WriteTerminationMessage(message string) error
• func WriteTerminationMessageToFile(file, message string) error
• type CountingReader
  • func (r *CountingReader) Close() error
  • func (r *CountingReader) Read(p []byte) (n int, err error)

Constants

const (

	// DefaultAlignBlockSize is the alignment size we use to align disk images, its a multiple of all known hardware block sizes 512/4k/8k/32k/64k.
	DefaultAlignBlockSize = 1024 * 1024
)

Functions

func AppendLabels

func AppendLabels(src, dest map[string]string) map[string]string

AppendLabels append dest labels to source (update if key has existed)

func AppendZeroWithTruncate

func AppendZeroWithTruncate(outFile *os.File, start, length int64) error

AppendZeroWithTruncate resizes the file to append zeroes, meant only for newly-created (empty and zero-length) regular files.

func AppendZeroWithWrite

func AppendZeroWithWrite(outFile *os.File, start, length int64) error

AppendZeroWithWrite just does normal file writes to the destination, a slow but reliable fallback option.

func CalculateOverheadSpace

func CalculateOverheadSpace(filesystemOverhead float64, availableSpace int64) int64

func CopyDir

func CopyDir(source string, dest string) error

CopyDir copies a dir from one location to another.

func CopyFile

func CopyFile(src, dst string) error

CopyFile copies a file from one location to another.

func GetAvailableSpace

func GetAvailableSpace(path string) (int64, error)

GetAvailableSpace gets the amount of available space at the path specified.

func GetAvailableSpaceBlock

func GetAvailableSpaceBlock(deviceName string) (int64, error)

GetAvailableSpaceBlock gets the amount of available space at the block device path specified.

func GetAvailableSpaceByVolumeMode

func GetAvailableSpaceByVolumeMode(volumeMode v1.PersistentVolumeMode) (int64, error)

GetAvailableSpaceByVolumeMode calls another method based on the volumeMode parameter to get the amount of available space at the path specified.

func GetNamespace

func GetNamespace() string

GetNamespace returns the namespace the pod is executing in

func GetRecommendedInstallerLabelsFromCr

func GetRecommendedInstallerLabelsFromCr(cr *cdiv1.CDI) map[string]string

GetRecommendedInstallerLabelsFromCr returns the recommended labels to set on CDI resources

func GetUsableSpace

func GetUsableSpace(filesystemOverhead float64, availableSpace int64) int64

GetUsableSpace calculates usable space to use taking file system overhead into account

func IsDevice

func IsDevice(deviceName string) (bool, error)

IsDevice returns true if it's a device file

func LinkFile

func LinkFile(source, target string) error

LinkFile symlinks the source to the target

func Md5sum

func Md5sum(filePath string) (string, error)

Md5sum calculates the md5sum of a given file. Do not use this for security-sensitive use cases.

func MergeLabels

func MergeLabels(src, dest map[string]string) map[string]string

MergeLabels adds source labels to destination (does not change existing ones)

func MinQuantity

func MinQuantity(availableSpace, imageSize *resource.Quantity) resource.Quantity

MinQuantity calculates the minimum of two quantities.

func OpenFileOrBlockDevice

func OpenFileOrBlockDevice(fileName string) (*os.File, error)

OpenFileOrBlockDevice opens the destination data file, whether it is a block device or regular file

func ParseEnvVar

func ParseEnvVar(envVarName string, decode bool) (string, error)

ParseEnvVar provides a wrapper to attempt to fetch the specified env var

func PunchHole

func PunchHole(outFile *os.File, start, length int64) error

PunchHole attempts to zero a range in a file with fallocate, for block devices and pre-allocated files.

func RandAlphaNum

func RandAlphaNum(n int) string

RandAlphaNum provides an implementation to generate a random alpha numeric string of the specified length This generator is not cryptographically secure.

func ResolveVolumeMode

func ResolveVolumeMode(volumeMode *v1.PersistentVolumeMode) v1.PersistentVolumeMode

ResolveVolumeMode returns the volume mode if set, otherwise defaults to file system mode

func RoundDown

func RoundDown(number, multiple int64) int64

RoundDown returns the number rounded down to the nearest multiple.

func RoundUp

func RoundUp(number, multiple int64) int64

RoundUp returns the number rounded up to the nearest multiple.

func SetRecommendedLabels

func SetRecommendedLabels(obj metav1.Object, installerLabels map[string]string, controllerName string)

SetRecommendedLabels sets the recommended labels on CDI resources (does not get rid of existing ones)

func StreamDataToFile

func StreamDataToFile(r io.Reader, fileName string, preallocate bool) (int64, int64, error)

func UnArchiveTar

func UnArchiveTar(reader io.Reader, destDir string) error

UnArchiveTar unarchives a tar file and streams its files using the specified io.Reader to the specified destination.

func WriteTerminationMessage

func WriteTerminationMessage(message string) error

WriteTerminationMessage writes the passed in message to the default termination message file

func WriteTerminationMessageToFile

func WriteTerminationMessageToFile(file, message string) error

WriteTerminationMessageToFile writes the passed in message to the passed in message file

Types

type CountingReader

type CountingReader struct {
	Reader  io.ReadCloser
	Current uint64
	Done    bool
}

CountingReader is a reader that keeps track of how much has been read

func (*CountingReader) Close

func (r *CountingReader) Close() error

Close closes the stream

func (*CountingReader) Read

func (r *CountingReader) Read(p []byte) (n int, err error)

Read reads bytes from the stream and updates the prometheus clone_progress metric according to the progress.