utils

Documentation

Overview

Package utils offers functions of general utility in other parts of the system

Index

• func DurationMillSeconds(d time.Duration) string
• func DurationSeconds(d time.Duration) string
• func GetBooleanEnvVar(envVar string, defaultValue bool) bool
• func GetInt32EnvVar(envVar string, defaultValue int32) int32
• func GetStringEnvVar(envVar string, defaultValue string) string
• func HasHostNetwork(pod corev1.Pod) bool
• func HasPort(pod corev1.Pod, port uint) bool
• func MapPort(service corev1.Service, port uint, pod corev1.Pod) (uint, error)
• func PodIP(pod corev1.Pod) (string, error)
• func Retry(timeout time.Duration, backoff time.Duration, f func() (bool, error)) error

Functions

func DurationMillSeconds

func DurationMillSeconds(d time.Duration) string

DurationMillSeconds returns the duration is milliseconds (e.g. "15ms")

func DurationSeconds

func DurationSeconds(d time.Duration) string

DurationSeconds returns the duration is seconds with a precession of 2 decimals, removing trailing zeros (e.g. "1.5s")

func GetBooleanEnvVar

func GetBooleanEnvVar(envVar string, defaultValue bool) bool

GetBooleanEnvVar returns a boolean environment variable. If variable is not set or invalid value, returns the default value

func GetInt32EnvVar

func GetInt32EnvVar(envVar string, defaultValue int32) int32

GetInt32EnvVar returns an integer environment variable. If variable is not set or invalid value, returns the default value

func GetStringEnvVar

func GetStringEnvVar(envVar string, defaultValue string) string

GetStringEnvVar returns a string environment variable. If variable is not set returns the default value

func HasHostNetwork

func HasHostNetwork(pod corev1.Pod) bool

HasHostNetwork returns whether a pod has HostNetwork enabled, i.e. it shares the host's network namespace.

func HasPort

func HasPort(pod corev1.Pod, port uint) bool

HasPort verifies if a pods listen to the given port

func MapPort

func MapPort(service corev1.Service, port uint, pod corev1.Pod) (uint, error)

MapPort returns the port in the Pod that maps to the given service port

func PodIP

func PodIP(pod corev1.Pod) (string, error)

PodIP returns the pod IP for the supplied pod, or an error if it has no IP (yet).

func Retry

func Retry(timeout time.Duration, backoff time.Duration, f func() (bool, error)) error

Retry retries a function until it returns true, error, or the timeout expires. If the function returns false, a new attempt is tried after the backoff period