util

Documentation

Index

• Variables
• func GetConfigMapFromVolume(selector *corev1.ConfigMapKeySelector) (string, error)
• func GetConfigMapVolumePath(selector *corev1.ConfigMapKeySelector) (string, error)
• func GetIsbSvcEnvVars(isbSvcConfig dfv1.BufferServiceConfig) (dfv1.ISBSvcType, []corev1.EnvVar)
• func GetSaramaConfigFromYAMLString(yaml string) (*sarama.Config, error)
• func GetSecretFromVolume(selector *corev1.SecretKeySelector) (string, error)
• func GetSecretVolumePath(selector *corev1.SecretKeySelector) (string, error)
• func GetTLSConfig(config *dfv1.TLS) (*tls.Config, error)
• func IsWatermarkEnabled() bool
• func LookupEnvStringOr(key, defaultValue string) string
• func MustHash(v interface{}) string
• func MustJSON(in interface{}) string
• func MustUnJSON(v interface{}, in interface{})
• func RandomLowerCaseString(length int) string
• func RandomString(length int) string
• func StringSliceContains(list []string, str string) bool
• func VolumesFromSecretsAndConfigMaps(obj interface{}) ([]corev1.Volume, []corev1.VolumeMount)

Variables

var DefaultRetryBackoff = wait.Backoff{
	Steps:    10,
	Duration: 5 * time.Second,
	Factor:   2.0,
	Jitter:   0.1,
}

Functions

func GetConfigMapFromVolume

func GetConfigMapFromVolume(selector *corev1.ConfigMapKeySelector) (string, error)

GetConfigMapFromVolume retrieves the value of mounted config map volume "/var/numaflow/config/${configMapRef.name}/${configMapRef.key}" is expected to be the file path

func GetConfigMapVolumePath

func GetConfigMapVolumePath(selector *corev1.ConfigMapKeySelector) (string, error)

GetConfigMapVolumePath returns the path of the mounted configmap

func GetIsbSvcEnvVars

func GetIsbSvcEnvVars(isbSvcConfig dfv1.BufferServiceConfig) (dfv1.ISBSvcType, []corev1.EnvVar)

GetIsbSvcEnvVars is helper function to get the ISB service type and generate corresponnding environment variables

func GetSaramaConfigFromYAMLString

func GetSaramaConfigFromYAMLString(yaml string) (*sarama.Config, error)

GetSaramaConfigFromYAMLString parse yaml string to sarama.config

func GetSecretFromVolume

func GetSecretFromVolume(selector *corev1.SecretKeySelector) (string, error)

GetSecretFromVolume retrieves the value of mounted secret volume "/var/numaflow/secrets/${secretRef.name}/${secretRef.key}" is expected to be the file path

func GetSecretVolumePath

func GetSecretVolumePath(selector *corev1.SecretKeySelector) (string, error)

GetSecretVolumePath returns the path of the mounted secret

func GetTLSConfig

func GetTLSConfig(config *dfv1.TLS) (*tls.Config, error)

A utility function to get tls.Config

func IsWatermarkEnabled

func IsWatermarkEnabled() bool

IsWatermarkEnabled returns true of watermark has been enabled.

func LookupEnvStringOr

func LookupEnvStringOr(key, defaultValue string) string

func MustHash

func MustHash(v interface{}) string

func MustJSON

func MustJSON(in interface{}) string

func MustUnJSON

func MustUnJSON(v interface{}, in interface{})

MustUnJSON unmarshalls JSON or panics. v - must be []byte or string in - must be a pointer.

func RandomLowerCaseString

func RandomLowerCaseString(length int) string

func RandomString

func RandomString(length int) string

generate a random string with given length

func StringSliceContains

func StringSliceContains(list []string, str string) bool

func VolumesFromSecretsAndConfigMaps

func VolumesFromSecretsAndConfigMaps(obj interface{}) ([]corev1.Volume, []corev1.VolumeMount)

VolumesFromSecretsOrConfigMaps builds volumes and volumeMounts spec based on the obj and its children's secretKeyselector and configMapKeySelector