utils

Documentation

Index

• func CopyDetachable(dst io.Writer, src io.Reader, keys []byte) (written int64, err error)
• func ExecCmd(name string, args ...string) (string, error)
• func ExecCmdWithStdStreams(stdin io.Reader, stdout, stderr io.Writer, name string, args ...string) error
• func GenerateID() (string, error)
• func GeneratePasswd(username string, uid, gid uint32, homedir, rootfs, rundir string) (string, error)
• func GetDiskUsageStats(path string) (dirSize, inodeCount uint64, err error)
• func GetUserInfo(rootfs, userName string) (uid, gid uint32, additionalGids []uint32, err error)
• func Int32Ptr(i int32) *int32
• func IsDirectory(path string) error
• func RunUnderSystemdScope(pid int, slice, unitName string) error
• func StatusToExitCode(status int) int
• func WriteGoroutineStacks(w io.Writer) error
• func WriteGoroutineStacksToFile(path string) error
• type DetachError
  • func (DetachError) Error() string

Functions

func CopyDetachable

func CopyDetachable(dst io.Writer, src io.Reader, keys []byte) (written int64, err error)

CopyDetachable is similar to io.Copy but support a detach key sequence to break out.

func ExecCmd

func ExecCmd(name string, args ...string) (string, error)

ExecCmd executes a command with args and returns its output as a string along with an error, if any

func ExecCmdWithStdStreams

func ExecCmdWithStdStreams(stdin io.Reader, stdout, stderr io.Writer, name string, args ...string) error

ExecCmdWithStdStreams execute a command with the specified standard streams.

func GenerateID

func GenerateID() (string, error)

GenerateID generates a random unique id.

func GeneratePasswd

func GeneratePasswd(username string, uid, gid uint32, homedir, rootfs, rundir string) (string, error)

GeneratePasswd generates a container specific passwd file, iff uid is not defined in the containers /etc/passwd

func GetDiskUsageStats

func GetDiskUsageStats(path string) (dirSize, inodeCount uint64, err error)

GetDiskUsageStats accepts a path to a directory or file and returns the number of bytes and inodes used by the path

func GetUserInfo

func GetUserInfo(rootfs, userName string) (uid, gid uint32, additionalGids []uint32, err error)

GetUserInfo returns UID, GID and additional groups for specified user by looking them up in /etc/passwd and /etc/group

func Int32Ptr

func Int32Ptr(i int32) *int32

Int32Ptr is a utility function to assign to integer pointer variables

func IsDirectory

func IsDirectory(path string) error

IsDirectory tests whether the given path exists and is a directory. It follows symlinks.

func RunUnderSystemdScope

func RunUnderSystemdScope(pid int, slice, unitName string) error

RunUnderSystemdScope adds the specified pid to a systemd scope

func StatusToExitCode

func StatusToExitCode(status int) int

StatusToExitCode converts wait status code to an exit code

func WriteGoroutineStacks

func WriteGoroutineStacks(w io.Writer) error

WriteGoroutineStacks writes out the goroutine stacks of the caller. Up to 32 MB is allocated to print the stack.

func WriteGoroutineStacksToFile

func WriteGoroutineStacksToFile(path string) error

WriteGoroutineStacksToFile write goroutine stacks to the specified file.

Types

type DetachError

type DetachError struct{}

DetachError is special error which returned in case of container detach.

func (DetachError) Error

func (DetachError) Error() string