kubeutil

Documentation

Overview

Package kubeutil GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

• Variables
• func AllWatchableGroupVersionKinds(ctx context.Context, conf *rest.Config) (gvks []schema.GroupVersionKind, err error)
• func Annotate(o AnnotationsAccessor, key string, value string)
• func AppendAnnotate(o AnnotationsAccessor, key string, value string)
• func ApplyCRDs(ctx context.Context, c *rest.Config, ...) error
• func ApplyNamespace(ctx context.Context, c *rest.Config, namespace string) (*corev1.Namespace, error)
• func ClientFromContext(ctx context.Context) client.Client
• func ContextWithClient(ctx context.Context, c client.Client) context.Context
• func GetAnnotate(o AnnotationsAccessor, key string) string
• func GetConfig(kubeConfigPath string) (*rest.Config, error)
• func GetLabel(o LabelsAccessor, key string) string
• func Intersection[E comparable](a []E, b []E) (c []E)
• func KubeConfigFromClient(c client.Client) *rest.Config
• func Label(o LabelsAccessor, key string, value string)
• func NewClient(kubeConfigPath string) (client.Client, error)
• func ToCRD(d *CustomResourceDefinition) *apiextensionsv1.CustomResourceDefinition
• func Union[E comparable](a []E, b []E) (c []E)
• type AnnotationsAccessor
• type CustomResourceDefinition
  • func (v CustomResourceDefinition) RuntimeDoc(names ...string) ([]string, bool)
• type KubeClient
  • func (c *KubeClient) Init(ctx context.Context) error
  • func (c *KubeClient) InjectContext(ctx context.Context) context.Context
  • func (v KubeClient) RuntimeDoc(names ...string) ([]string, bool)
• type LabelsAccessor
• type Object
  • func NewForGroupVersionKind(gvk schema.GroupVersionKind) (Object, error)
  • func ObjectFromRuntimeObject(ro runtime.Object) (Object, error)
• type ObjectList
  • func ObjectListFromRuntimeObject(ro runtime.Object) (ObjectList, error)

Variables

var FieldOwner = client.FieldOwner("kubepkg")

Functions

func AllWatchableGroupVersionKinds

func AllWatchableGroupVersionKinds(ctx context.Context, conf *rest.Config) (gvks []schema.GroupVersionKind, err error)

func Annotate

func Annotate(o AnnotationsAccessor, key string, value string)

func AppendAnnotate

func AppendAnnotate(o AnnotationsAccessor, key string, value string)

func ApplyCRDs

func ApplyCRDs(ctx context.Context, c *rest.Config, crds ...*apiextensionsv1.CustomResourceDefinition) error

func ApplyNamespace

func ApplyNamespace(ctx context.Context, c *rest.Config, namespace string) (*corev1.Namespace, error)

func ClientFromContext

func ClientFromContext(ctx context.Context) client.Client

func ContextWithClient

func ContextWithClient(ctx context.Context, c client.Client) context.Context

func GetAnnotate

func GetAnnotate(o AnnotationsAccessor, key string) string

func GetConfig

func GetConfig(kubeConfigPath string) (*rest.Config, error)

func GetLabel

func GetLabel(o LabelsAccessor, key string) string

func Intersection

func Intersection[E comparable](a []E, b []E) (c []E)

func KubeConfigFromClient

func KubeConfigFromClient(c client.Client) *rest.Config

func Label

func Label(o LabelsAccessor, key string, value string)

func NewClient

func NewClient(kubeConfigPath string) (client.Client, error)

func ToCRD

func ToCRD(d *CustomResourceDefinition) *apiextensionsv1.CustomResourceDefinition

func Union

func Union[E comparable](a []E, b []E) (c []E)

Types

type AnnotationsAccessor

type AnnotationsAccessor interface {
	GetAnnotations() map[string]string
	SetAnnotations(annotations map[string]string)
}

type CustomResourceDefinition

type CustomResourceDefinition struct {
	GroupVersion schema.GroupVersion
	KindType     runtime.Object
	ListKindType runtime.Object
	SpecType     any
	Plural       string
	ShortNames   []string
}

func (CustomResourceDefinition) RuntimeDoc

func (v CustomResourceDefinition) RuntimeDoc(names ...string) ([]string, bool)

type KubeClient

type KubeClient struct {
	// Paths to a kubeconfig. Only required if out-of-cluster.
	Kubeconfig string `flag:",omitempty"`
	// contains filtered or unexported fields
}

func (*KubeClient) Init

func (c *KubeClient) Init(ctx context.Context) error

func (*KubeClient) InjectContext

func (c *KubeClient) InjectContext(ctx context.Context) context.Context

func (KubeClient) RuntimeDoc

func (v KubeClient) RuntimeDoc(names ...string) ([]string, bool)

type LabelsAccessor

type LabelsAccessor interface {
	GetLabels() map[string]string
	SetLabels(labels map[string]string)
}

type Object

type Object = client.Object

func NewForGroupVersionKind

func NewForGroupVersionKind(gvk schema.GroupVersionKind) (Object, error)

func ObjectFromRuntimeObject

func ObjectFromRuntimeObject(ro runtime.Object) (Object, error)

type ObjectList

type ObjectList = client.ObjectList

func ObjectListFromRuntimeObject

func ObjectListFromRuntimeObject(ro runtime.Object) (ObjectList, error)