k8s

Documentation

Index

• type Builder
  • func NewCtrlBuilder(b *builder.Builder) Builder
• type Client
• type StatusWriter
• type SubResourceClient

Types

type Builder

type Builder interface {
	For(object client.Object, opts ...builder.ForOption) Builder
	Owns(object client.Object, opts ...builder.OwnsOption) Builder
	Watches(object client.Object, handler handler.EventHandler, opts ...builder.WatchesOption) Builder
	WithEventFilter(p predicate.Predicate) Builder
	WithOptions(options controller.Options) Builder
	WithLogConstructor(logConstructor func(*reconcile.Request) logr.Logger) Builder
	Named(name string) Builder
	Complete(r reconcile.Reconciler) error
	Build(r reconcile.Reconciler) (controller.Controller, error)
}

Builder is a controller-runtime interface used internally. It copies function from sigs.k8s.io/controller-runtime/pkg/builder

func NewCtrlBuilder

func NewCtrlBuilder(b *builder.Builder) Builder

NewCtrlBuilder returns a self-referencing controlled builder passthrough wrapper implementing the Builder interface above.

type Client

type Client interface {
	Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error
	Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error

	Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error
	Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error
	DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error
	List(ctx context.Context, obj client.ObjectList, opts ...client.ListOption) error
	Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error

	RESTMapper() meta.RESTMapper
	Scheme() *runtime.Scheme

	GroupVersionKindFor(obj runtime.Object) (schema.GroupVersionKind, error)
	IsObjectNamespaced(obj runtime.Object) (bool, error)
	Status() client.StatusWriter
	SubResource(subResource string) client.SubResourceClient
}

Client is a kubernetes client interface used internally. It copies functions from sigs.k8s.io/controller-runtime/pkg/client

type StatusWriter

type StatusWriter interface {
	Create(ctx context.Context, obj client.Object, subResource client.Object, opts ...client.SubResourceCreateOption) error
	Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error
	Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter is a kubernetes status writer interface used internally. It copies functions from sigs.k8s.io/controller-runtime/pkg/client

type SubResourceClient

type SubResourceClient interface {
	Get(ctx context.Context, obj client.Object, subResource client.Object, opts ...client.SubResourceGetOption) error

	Create(ctx context.Context, obj client.Object, subResource client.Object, opts ...client.SubResourceCreateOption) error
	Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error
	Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

SubResourceClient is a kubernetes status writer interface used internally. It copies functions from sigs.k8s.io/controller-runtime/pkg/client