util

Documentation

Index

• func CopyDir(source string, dest string) (err 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 MinQuantity(availableSpace, imageSize *resource.Quantity) resource.Quantity
• func ParseEnvVar(envVarName string, decode bool) (string, error)
• func RandAlphaNum(n int) string
• func RoundDown(number, multiple int64) int64
• func RoundUp(number, multiple int64) int64
• func StreamDataToFile(r io.Reader, fileName string) error
• func UnArchiveTar(reader io.Reader, destDir string, arg ...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)

Functions

func CopyDir

func CopyDir(source string, dest string) (err 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 MinQuantity

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

MinQuantity calculates the minimum of two quantities.

func ParseEnvVar

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

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

func RandAlphaNum

func RandAlphaNum(n int) string

RandAlphaNum provides an implementation to generate a random alpha numeric string of the specified length

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 StreamDataToFile

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

StreamDataToFile provides a function to stream the specified io.Reader to the specified local file

func UnArchiveTar

func UnArchiveTar(reader io.Reader, destDir string, arg ...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.