k8stools

Documentation

Index

• Variables
• func CompareObjectMeta(t *testing.T, got, want metav1.ObjectMeta)
• func FetchConfigMapContentByKey(ctx context.Context, rclient client.Client, cm *corev1.ConfigMap, key string) (string, error)
• func GetCredFromConfigMap(ctx context.Context, rclient client.Client, ns string, ...) (string, error)
• func GetCredFromSecret(ctx context.Context, rclient client.Client, ns string, ...) (string, error)
• func GetTestClientWithObjects(predefinedObjects []runtime.Object) client.Client
• func IsFSGroupChangePolicySupported() bool
• func IsPDBV1APISupported() bool
• func ListObjectsByNamespace[T any, PT interface{ ... }](ctx context.Context, rclient client.Client, nss []string, collect func(PT), ...) error
• func MergePatchContainers(base, patches []corev1.Container) ([]corev1.Container, error)
• func MustConvertObjectVersionsJSON[A, B any](src *A, objectName string) *B
• func NewHPAEmptyObject(opts ...func(obj client.Object)) client.Object
• func NewObjectWatcherForNamespaces[T any, PT interface{ ... }](ctx context.Context, rclient client.WithWatch, crdTypeName string, ...) (watch.Interface, error)
• func NewReadyDeployment(name, namespace string) *appsv1.Deployment
• func RenderPlaceholders[T any](resource *T, placeholders map[string]string) (*T, error)
• func SanitizeVolumeName(name string) string
• func SelectNamespaces(ctx context.Context, rclient client.Client, selector labels.Selector) ([]string, error)
• func SetKubernetesVersionWithDefaults(vi *version.Info, defaultMinor, defaultMajor uint64) error
• func UpdatePodAnnotations(ctx context.Context, rclient client.Client, selector map[string]string, ...) error
• func VisitObjectsForSelectorsAtNs[T any, PT interface{ ... }](ctx context.Context, rclient client.Client, ...) error
• type BasicAuthCredentials
  • func LoadBasicAuthSecret(ctx context.Context, rclient client.Client, ns string, ...) (BasicAuthCredentials, error)
• type KeyNotFoundError
  • func NewKeyNotFoundError(key, cacheKey, object string) *KeyNotFoundError
  • func (ke *KeyNotFoundError) Error() string
• type OAuthCreds
  • func LoadOAuthSecrets(ctx context.Context, rclient client.Client, oauth2 *vmv1beta1.OAuth2, ...) (*OAuthCreds, error)
• type ObjectWatcherForNamespaces
  • func (ow *ObjectWatcherForNamespaces) ResultChan() <-chan watch.Event
  • func (ow *ObjectWatcherForNamespaces) Stop()

Variables

var (
	// ServerMajorVersion defines major number for current kubernetes API server version
	ServerMajorVersion uint64
	// ServerMinorVersion defines minor number for current kubernetes API server version
	ServerMinorVersion uint64
)

Functions

func CompareObjectMeta

func CompareObjectMeta(t *testing.T, got, want metav1.ObjectMeta)

CompareObjectMeta compares metadata objects

func FetchConfigMapContentByKey

func FetchConfigMapContentByKey(ctx context.Context, rclient client.Client, cm *corev1.ConfigMap, key string) (string, error)

FetchConfigMapContentByKey returns configmap content by key

func GetCredFromConfigMap

func GetCredFromConfigMap(
	ctx context.Context,
	rclient client.Client,
	ns string,
	sel corev1.ConfigMapKeySelector,
	cacheKey string,
	cache map[string]*corev1.ConfigMap,
) (string, error)

GetCredFromConfigMap fetches content of configmap by given key

func GetCredFromSecret

func GetCredFromSecret(
	ctx context.Context,
	rclient client.Client,
	ns string,
	sel *corev1.SecretKeySelector,
	cacheKey string,
	cache map[string]*corev1.Secret,
) (string, error)

GetCredFromSecret fetch content of secret by given key

func GetTestClientWithObjects

func GetTestClientWithObjects(predefinedObjects []runtime.Object) client.Client

GetTestClientWithObjects returns testing client with optional predefined objects

func IsFSGroupChangePolicySupported

func IsFSGroupChangePolicySupported() bool

IsFSGroupChangePolicySupported checks if `fsGroupChangePolicy` is supported, Supported since 1.20 https://kubernetes.io/blog/2020/12/14/kubernetes-release-1.20-fsgroupchangepolicy-fsgrouppolicy/#allow-users-to-skip-recursive-permission-changes-on-mount

func IsPDBV1APISupported

func IsPDBV1APISupported() bool

IsPDBV1APISupported check if new v1 API is supported by kubernetes API server deprecated since 1.21 https://kubernetes.io/docs/reference/using-api/deprecation-guide/#poddisruptionbudget-v125

func ListObjectsByNamespace

func ListObjectsByNamespace[T any, PT interface {
	*T
	client.ObjectList
}](ctx context.Context, rclient client.Client, nss []string, collect func(PT), opts ...client.ListOption) error

ListObjectsByNamespace performs object list for given namespaces

func MergePatchContainers

func MergePatchContainers(base, patches []corev1.Container) ([]corev1.Container, error)

MergePatchContainers adds patches to base using a strategic merge patch and iterating by container name, failing on the first error

func MustConvertObjectVersionsJSON

func MustConvertObjectVersionsJSON[A, B any](src *A, objectName string) *B

MustConvertObjectVersionsJSON objects with json serialize and deserialize it could be used only for converting BETA apis to Stable version

func NewHPAEmptyObject

func NewHPAEmptyObject(opts ...func(obj client.Object)) client.Object

NewHPAEmptyObject returns HorizontalPodAutoscaler object

func NewObjectWatcherForNamespaces

func NewObjectWatcherForNamespaces[T any, PT interface {
	*T
	client.ObjectList
}](ctx context.Context, rclient client.WithWatch, crdTypeName string, namespaces []string) (watch.Interface, error)

NewObjectWatcherForNamespaces returns a watcher for events at multiple namespaces for given object in case of empty namespaces, performs cluster wide watch

func NewReadyDeployment

func NewReadyDeployment(name, namespace string) *appsv1.Deployment

NewReadyDeployment returns a new deployment with ready status condition

func RenderPlaceholders

func RenderPlaceholders[T any](resource *T, placeholders map[string]string) (*T, error)

RenderPlaceholders replaces placeholders at resource with given values placeholder must be in %NAME% format resource must be reference to json serializable struct

func SanitizeVolumeName

func SanitizeVolumeName(name string) string

SanitizeVolumeName replaces all incompatible with k8s characters with -

func SelectNamespaces

func SelectNamespaces(ctx context.Context, rclient client.Client, selector labels.Selector) ([]string, error)

SelectNamespaces select namespaces by given label selector

func SetKubernetesVersionWithDefaults

func SetKubernetesVersionWithDefaults(vi *version.Info, defaultMinor, defaultMajor uint64) error

SetKubernetesVersionWithDefaults parses kubernetes version response with given default versions

func UpdatePodAnnotations

func UpdatePodAnnotations(ctx context.Context, rclient client.Client, selector map[string]string, ns string) error

UpdatePodAnnotations - updates configmap-sync-time annotation it triggers config rules reload for vmalert

func VisitObjectsForSelectorsAtNs

func VisitObjectsForSelectorsAtNs[T any, PT interface {
	*T
	client.ObjectList
}](ctx context.Context, rclient client.Client,
	nsSelector, objectSelector *metav1.LabelSelector,
	objNamespace string, selectAllByDefault bool, cb func(PT),
) error

VisitObjectsForSelectorsAtNs applies given function to any object matched given selectors

Types

type BasicAuthCredentials

type BasicAuthCredentials struct {
	Username string
	Password string
}

BasicAuthCredentials represents a username password pair to be used with basic http authentication, see https://tools.ietf.org/html/rfc7617.

func LoadBasicAuthSecret

func LoadBasicAuthSecret(ctx context.Context, rclient client.Client, ns string, basicAuth *vmv1beta1.BasicAuth, secretCache map[string]*corev1.Secret) (BasicAuthCredentials, error)

LoadBasicAuthSecret fetch content of kubernetes secrets and returns it within plain text

type KeyNotFoundError

type KeyNotFoundError struct {
	// contains filtered or unexported fields
}

KeyNotFoundError represents an error if expected key was not found at secret or configmap data

func NewKeyNotFoundError

func NewKeyNotFoundError(key, cacheKey, object string) *KeyNotFoundError

NewKeyNotFoundError returns NewKeyNotFoundError

func (*KeyNotFoundError) Error

func (ke *KeyNotFoundError) Error() string

Error implements interface

type OAuthCreds

type OAuthCreds struct {
	ClientSecret string
	ClientID     string
}

OAuthCreds represents OAuth2 secret values within plain text

func LoadOAuthSecrets

func LoadOAuthSecrets(ctx context.Context, rclient client.Client, oauth2 *vmv1beta1.OAuth2, ns string, cache map[string]*corev1.Secret, cmCache map[string]*corev1.ConfigMap) (*OAuthCreds, error)

LoadOAuthSecrets fetches content of OAuth secret and retruns it plain text value

type ObjectWatcherForNamespaces

type ObjectWatcherForNamespaces struct {
	// contains filtered or unexported fields
}

ObjectWatcherForNamespaces performs a watch operation for multiple namespaces without using cluster wide permissions with empty namaspaces uses cluster wide mode

func (*ObjectWatcherForNamespaces) ResultChan

func (ow *ObjectWatcherForNamespaces) ResultChan() <-chan watch.Event

ResultChan returns a channel with events

func (*ObjectWatcherForNamespaces) Stop

func (ow *ObjectWatcherForNamespaces) Stop()

Stop performs a stop on all watchers and waits for it's finish