util

Documentation

Index

• Constants
• func ConfigureMaxProcs(logger klog.Logger) error
• func Contains[T comparable](s []T, e T) bool
• func CreateHTTPClient(timeout time.Duration, unsafeSsl bool) *http.Client
• func CreateHTTPTransport(unsafeSsl bool) *http.Transport
• func CreateHTTPTransportWithTLSConfig(config *tls.Config) *http.Transport
• func CreateTLSClientConfig(unsafeSsl bool) *tls.Config
• func GetClusterObjectNamespace() (string, error)
• func GetMinTLSVersion() uint16
• func GetPodNamespace() string
• func GetRestrictSecretAccess() string
• func GetValueByPath(data map[string]interface{}, path string) (interface{}, error)
• func GetWatchNamespaces() (map[string]cache.Config, error)
• func IgnoreOtherNamespaces() predicate.Predicate
• func NewTLSConfig(clientCert, clientKey, caCert string, unsafeSsl bool) (*tls.Config, error)
• func NewTLSConfigWithPassword(clientCert, clientKey, clientKeyPassword, caCert string, unsafeSsl bool) (*tls.Config, error)
• func NormalizeString(s string) string
• func ParseInt32List(pattern string) ([]int32, error)
• func ParseRange(from, to string) ([]int32, error)
• func ParseStringList(pattern string) (map[string]string, error)
• func PrintWelcome(logger logr.Logger, kubeVersion K8sVersion, component string)
• func ResolveOsEnvBool(envName string, defaultValue bool) (bool, error)
• func ResolveOsEnvDuration(envName string) (*time.Duration, error)
• func ResolveOsEnvInt(envName string, defaultValue int) (int, error)
• func SetCACertDirs(caCertDirs []string)
• func StringPointer(v string) *string
• type GinkgoTestReporter
  • func (g GinkgoTestReporter) Errorf(format string, args ...interface{})
  • func (g GinkgoTestReporter) Fatalf(format string, args ...interface{})
• type HTTPDoer
• type K8sVersion
  • func NewK8sVersion(version *version.Info) K8sVersion

Constants

const (
	// Hostname is a constant refers to the hostname part of the url
	Hostname urlPart = "Hostname"
	// Password is a constant that refers to a password portion of the url if there is one
	Password urlPart = "Password"
)

const RestrictSecretAccessEnvVar = "KEDA_RESTRICT_SECRET_ACCESS"

Functions

func ConfigureMaxProcs

func ConfigureMaxProcs(logger klog.Logger) error

ConfigureMaxProcs sets up automaxprocs with proper logging configuration. It wraps the automaxprocs logger to handle structured logging with string keys to prevent panics when automaxprocs tries to pass numeric keys.

func Contains

func Contains[T comparable](s []T, e T) bool

Contains checks if a slice contains a given element.

func CreateHTTPClient

func CreateHTTPClient(timeout time.Duration, unsafeSsl bool) *http.Client

CreateHTTPClient returns a new HTTP client with the timeout set to timeoutMS milliseconds, or 300 milliseconds if timeoutMS <= 0. unsafeSsl parameter allows to avoid tls cert validation if it's required

func CreateHTTPTransport

func CreateHTTPTransport(unsafeSsl bool) *http.Transport

CreateHTTPTransport returns a new HTTP Transport with Proxy, Keep alives unsafeSsl parameter allows to avoid tls cert validation if it's required

func CreateHTTPTransportWithTLSConfig

func CreateHTTPTransportWithTLSConfig(config *tls.Config) *http.Transport

CreateHTTPTransportWithTLSConfig returns a new HTTP Transport with Proxy, Keep alives using given tls.Config

func CreateTLSClientConfig

func CreateTLSClientConfig(unsafeSsl bool) *tls.Config

CreateTLSClientConfig returns a new TLS Config unsafeSsl parameter allows to avoid tls cert validation if it's required

func GetClusterObjectNamespace

func GetClusterObjectNamespace() (string, error)

GetClusterObjectNamespace retrieves the cluster object namespace of KEDA, default is the namespace of KEDA Operator & Metrics Server

func GetMinTLSVersion

func GetMinTLSVersion() uint16

GetMinTLSVersion return the minTLSVersion based on configurations

func GetPodNamespace

func GetPodNamespace() string

GetPodNamespace returns the namespace for the pod

func GetRestrictSecretAccess

func GetRestrictSecretAccess() string

GetRestrictSecretAccess retrieves the value of the environment variable of KEDA_RESTRICT_SECRET_ACCESS

func GetValueByPath

func GetValueByPath(data map[string]interface{}, path string) (interface{}, error)

GetValueByPath retrieves a value from a nested map using a dot-separated path It also supports .number syntax to access array elements.

This is a helper function for niche use cases. Consider using https://pkg.go.dev/k8s.io/apimachinery@v0.29.3/pkg/apis/meta/v1/unstructured#NestedFieldNoCopy instead

Examples:

data := map[string]interface{}{
    "a": map[string]interface{}{
        "b": []interface{}{
            map[string]interface{}{"c": 1},
            map[string]interface{}{"c": 2},
        },
    },
}

GetValueByPath(data, "a.b.0.c") // 1 GetValueByPath(data, "not.found") // error

func GetWatchNamespaces

func GetWatchNamespaces() (map[string]cache.Config, error)

GetWatchNamespaces returns the namespaces the operator should be watching for changes

func IgnoreOtherNamespaces

func IgnoreOtherNamespaces() predicate.Predicate

IgnoreOtherNamespaces returns the predicate for watched events that will filter out those that are not coming from a watched namespace (empty namespace or unset env var denotes all)

func NewTLSConfig

func NewTLSConfig(clientCert, clientKey, caCert string, unsafeSsl bool) (*tls.Config, error)

NewTLSConfig returns a *tls.Config using the given ceClient cert, ceClient key, and CA certificate. If none are appropriate, a nil *tls.Config is returned.

func NewTLSConfigWithPassword

func NewTLSConfigWithPassword(clientCert, clientKey, clientKeyPassword, caCert string, unsafeSsl bool) (*tls.Config, error)

NewTLSConfigWithPassword returns a *tls.Config using the given ceClient cert, ceClient key, and CA certificate. If clientKeyPassword is not empty the provided password will be used to decrypt the given key. If none are appropriate, a nil *tls.Config is returned.

func NormalizeString

func NormalizeString(s string) string

NormalizeString will replace all slashes, dots, colons and percent signs with dashes

func ParseInt32List

func ParseInt32List(pattern string) ([]int32, error)

func ParseRange

func ParseRange(from, to string) ([]int32, error)

func ParseStringList

func ParseStringList(pattern string) (map[string]string, error)

func PrintWelcome

func PrintWelcome(logger logr.Logger, kubeVersion K8sVersion, component string)

func ResolveOsEnvBool

func ResolveOsEnvBool(envName string, defaultValue bool) (bool, error)

func ResolveOsEnvDuration

func ResolveOsEnvDuration(envName string) (*time.Duration, error)

func ResolveOsEnvInt

func ResolveOsEnvInt(envName string, defaultValue int) (int, error)

func SetCACertDirs

func SetCACertDirs(caCertDirs []string)

SetCACertDirs sets location(s) containing CA certificates which should be trusted for all future calls to CreateTLSClientConfig

func StringPointer

func StringPointer(v string) *string

StringPointer returns a pointer to the string value passed in.

Types

type GinkgoTestReporter

type GinkgoTestReporter struct{}

func (GinkgoTestReporter) Errorf

func (g GinkgoTestReporter) Errorf(format string, args ...interface{})

func (GinkgoTestReporter) Fatalf

func (g GinkgoTestReporter) Fatalf(format string, args ...interface{})

type HTTPDoer

type HTTPDoer interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPDoer is an interface that matches the Do method on (net/http).Client. It should be used in function signatures instead of raw *http.Clients wherever possible

type K8sVersion

type K8sVersion struct {
	Version       *version.Info
	MinorVersion  int
	PrettyVersion string
	Parsed        bool
}

K8sVersion holds parsed data from a K8s version

func NewK8sVersion

func NewK8sVersion(version *version.Info) K8sVersion

NewK8sVersion will parse a version info and return a struct