utils

Documentation

Index

• Constants
• Variables
• func BridgeByName(name string) (*netlink.Bridge, error)
• func CheckBrInUse(brname string) (bool, error)
• func ContainerNSToPID(cID string) (int, error)
• func ConvertEnvs(m map[string]string) []string
• func CopyFile(src, dst string, mode os.FileMode) (err error)
• func CopyFileContents(src, dst string, mode os.FileMode) (err error)
• func CreateDirectory(path string, perm os.FileMode)
• func CreateFile(file, content string) (err error)
• func DeleteLinkByName(name string) error
• func DeleteNetnsSymlink(n string) error
• func EthtoolTXOff(name string) error
• func ExpandEnvVarsInStrSlice(s []string)
• func ExpandHome(p string) string
• func FileExists(filename string) bool
• func FilenameForURL(rawUrl string) string
• func FirstLinkIPs(ln string) (v4, v6 string, err error)
• func GenMac(oui string) string
• func GetCNIBinaryPath() string
• func GetCanonicalImageName(imageName string) string
• func IsHttpUri(s string) bool
• func IsKernelModuleLoaded(name string) (bool, error)
• func LinkContainerNS(nspath, containerName string) error
• func LinkIPs(ln string) (v4addrs, v6addrs []netlink.Addr, err error)
• func LoadEnvVarFiles(basefolder string, files []string) (map[string]string, error)
• func MergeMaps(dicts ...map[string]interface{}) map[string]interface{}
• func MergeStringMaps(maps ...map[string]string) map[string]string
• func MergeStringSlices(ss ...[]string) []string
• func PauseProcessGroup(pgid int) error
• func ReadFileContent(file string) ([]byte, error)
• func ReadPasswordFromTerminal() (string, error)
• func ResolvePath(p, base string) string
• func SpawnCLIviaExec(platformName, contName, runtime string) (*network.Driver, error)
• func StringInSlice(slice []string, val string) (int, bool)
• func ToEnvKey(s string) string
• func UnpauseProcessGroup(pgid int) error
• type EthtoolValue
• type IFReqData
• type KernelVersion
  • func GetKernelVersion() (*KernelVersion, error)
  • func (kv *KernelVersion) GreaterOrEqual(cmpKv *KernelVersion) bool
  • func (kv *KernelVersion) String() string

Constants

const (
	SIOCETHTOOL     = 0x8946     // linux/sockios.h
	ETHTOOL_GTXCSUM = 0x00000016 // linux/ethtool.h
	ETHTOOL_STXCSUM = 0x00000017 // linux/ethtool.h
	IFNAMSIZ        = 16         // linux/if.h
)

const (
	UndefinedFileName = "undefined"
)

Variables

var (
	// map of commands per platform which start a CLI app.
	NetworkOSCLICmd = map[string]string{
		"arista_eos":    "Cli",
		"nokia_srlinux": "sr_cli",
	}

	// map of the cli exec command and its argument per runtime
	// which is used to spawn CLI session.
	CLIExecCommand = map[string]map[string]string{
		"docker": {
			"exec": "docker",
			"open": "exec -it",
		},
		"containerd": {
			"exec": "ctr",
			"open": "-n clab task exec -t --exec-id clab",
		},
	}
)

var IfWaitScript string = `` /* 440-byte string literal not displayed */

IfWaitScript is used in ENTRYPOINT/CMD of the nodes that need to ensure that all of the clab links/interfaces are available in the container before calling the main process.

Functions

func BridgeByName

func BridgeByName(name string) (*netlink.Bridge, error)

BridgeByName returns a *netlink.Bridge referenced by its name.

func CheckBrInUse

func CheckBrInUse(brname string) (bool, error)

func ContainerNSToPID

func ContainerNSToPID(cID string) (int, error)

ContainerNSToPID resolves the name of a container via the "/run/netns/<CONTAINERNAME>" to its PID.

func ConvertEnvs

func ConvertEnvs(m map[string]string) []string

ConvertEnvs converts env variables passed as a map to a list of them.

func CopyFile

func CopyFile(src, dst string, mode os.FileMode) (err error)

CopyFile copies a file from src to dst. If src and dst files exist, and are the same, then return success. Otherwise, copy the file contents from src to dst. mode is the desired target file permissions, e.g. "0644".

func CopyFileContents

func CopyFileContents(src, dst string, mode os.FileMode) (err error)

CopyFileContents copies the contents of the file named src to the file named by dst. The file will be created if it does not already exist. If the destination file exists, all it's contents will be replaced by the contents of the source file. src can be an http(s) URL as well.

func CreateDirectory

func CreateDirectory(path string, perm os.FileMode)

CreateDirectory creates a directory by a path with a mode/permission specified by perm. If directory exists, the function does not do anything.

func CreateFile

func CreateFile(file, content string) (err error)

CreateFile writes content to a file by path `file`.

func DeleteLinkByName

func DeleteLinkByName(name string) error

func DeleteNetnsSymlink

func DeleteNetnsSymlink(n string) error

DeleteNetnsSymlink deletes a network namespace and removes the symlink created by LinkContainerNS func.

func EthtoolTXOff

func EthtoolTXOff(name string) error

EthtoolTXOff disables TX checksum offload on specified interface.

func ExpandEnvVarsInStrSlice

func ExpandEnvVarsInStrSlice(s []string)

ExpandEnvVarsInStrSlice makes an in-place expansion of env vars in a slice of strings.

func ExpandHome

func ExpandHome(p string) string

ExpandHome expands `~` char in the path to home path of a current user in provided path p. When sudo is used, it expands to home dir of a sudo user.

func FileExists

func FileExists(filename string) bool

FileExists returns true if a file referenced by filename exists & accessible.

func FilenameForURL

func FilenameForURL(rawUrl string) string

FilenameForURL extracts a filename from a given url returns "undefined" when unsuccessful.

func FirstLinkIPs

func FirstLinkIPs(ln string) (v4, v6 string, err error)

FirstLinkIPs returns string representation of the first IPv4/v6 address found for a link referenced by name.

func GenMac

func GenMac(oui string) string

GenMac generates a random MAC address for a given OUI.

func GetCNIBinaryPath

func GetCNIBinaryPath() string

func GetCanonicalImageName

func GetCanonicalImageName(imageName string) string

GetCanonicalImageName produces a canonical image name. if the input name did not specify a tag, the implicit "latest" tag is returned.

func IsHttpUri

func IsHttpUri(s string) bool

IsHttpUri check if the url is a downloadable uri.

func IsKernelModuleLoaded

func IsKernelModuleLoaded(name string) (bool, error)

IsKernelModuleLoaded checks if a kernel module is loaded by parsing /proc/modules file.

func LinkContainerNS

func LinkContainerNS(nspath, containerName string) error

LinkContainerNS creates a symlink for containers network namespace so that it can be managed by iproute2 utility.

func LinkIPs

func LinkIPs(ln string) (v4addrs, v6addrs []netlink.Addr, err error)

LinkIPs returns IPv4/IPv6 addresses assigned to a link referred by its name.

func LoadEnvVarFiles

func LoadEnvVarFiles(basefolder string, files []string) (map[string]string, error)

LoadEnvVarFiles load EnvVars from the given files, resolving relative paths.

func MergeMaps

func MergeMaps(dicts ...map[string]interface{}) map[string]interface{}

MergeMaps merges all dictionaries and return a new dictionary recursively if matching keys are both dictionaries.

func MergeStringMaps

func MergeStringMaps(maps ...map[string]string) map[string]string

MergeStringMaps merges all string maps and return a new map maps that are passed for merging will not be changed merging to empty maps return an empty map merging nils return nil.

func MergeStringSlices

func MergeStringSlices(ss ...[]string) []string

MergeStringSlices merges string slices with duplicates removed.

func PauseProcessGroup

func PauseProcessGroup(pgid int) error

PauseProcessGroup sends the SIGSTOP signal to a process group, causing all the processes within the group to be Paused e.g. SRL runs multilpe processes, if the container is meant to be stopped, all the related processes must be paused. To me it seams like the ProcessGroupID is set correctly so we can count on that field. The syscall.Kill interpretes negative ints as a PGID and not as a common PID.

func ReadFileContent

func ReadFileContent(file string) ([]byte, error)

func ReadPasswordFromTerminal

func ReadPasswordFromTerminal() (string, error)

func ResolvePath

func ResolvePath(p, base string) string

ResolvePath resolves a string path by expanding `~` to home dir or resolving a relative path by joining it with the base path.

func SpawnCLIviaExec

func SpawnCLIviaExec(platformName, contName, runtime string) (*network.Driver, error)

SpawnCLIviaExec spawns a CLI session over container runtime exec function end ensures the CLI is available to be used for sending commands over.

func StringInSlice

func StringInSlice(slice []string, val string) (int, bool)

StringInSlice checks if a slice contains `val` string and returns slice index if true.

func ToEnvKey

func ToEnvKey(s string) string

ToEnvKey capitalizes and removes special chars from a string to is used as an environment variable key.

func UnpauseProcessGroup

func UnpauseProcessGroup(pgid int) error

UnpauseProcessGroup send the SIGCONT to the given ProcessGroup identified by its ID.

Types

type EthtoolValue

type EthtoolValue struct {
	Cmd  uint32
	Data uint32
}

EthtoolValue linux/ethtool.h 'struct ethtool_value'.

type IFReqData

type IFReqData struct {
	Name [IFNAMSIZ]byte
	Data uintptr
}

IFReqData linux/if.h 'struct ifreq'.

type KernelVersion

type KernelVersion struct {
	Major     int
	Minor     int
	Revision  int
	Remainder string // the rest of the version string, e.g. "-amd64"
}

KernelVersion holds the parsed OS kernel version.

func GetKernelVersion

func GetKernelVersion() (*KernelVersion, error)

GetKernelVersion returns the parsed OS kernel version.

func (*KernelVersion) GreaterOrEqual

func (kv *KernelVersion) GreaterOrEqual(cmpKv *KernelVersion) bool

GreaterOrEqual returns true if the Kernel version is greater or equal to the compared Kernel version.

func (*KernelVersion) String

func (kv *KernelVersion) String() string

String returns the Kernel version as string.