v1

Documentation

Index

• func FromPlanHandlerToHandler(sync PlanHandler) generic.Handler
• func RegisterPlanGeneratingHandler(ctx context.Context, controller PlanController, apply apply.Apply, ...)
• func RegisterPlanStatusHandler(ctx context.Context, controller PlanController, condition condition.Cond, ...)
• type Interface
  • func New(controllerFactory controller.SharedControllerFactory) Interface
• type PlanCache
• type PlanClient
• type PlanController
• type PlanGeneratingHandler
• type PlanGenericCache
  • func (c PlanGenericCache) AddIndexer(indexName string, indexer PlanIndexer)
• type PlanGenericController
  • func (c *PlanGenericController) Cache() PlanCache
  • func (c *PlanGenericController) OnChange(ctx context.Context, name string, sync PlanHandler)
  • func (c *PlanGenericController) OnRemove(ctx context.Context, name string, sync PlanHandler)
• type PlanHandler
• type PlanIndexer
• type PlanStatusHandler

Functions

func FromPlanHandlerToHandler

func FromPlanHandlerToHandler(sync PlanHandler) generic.Handler

func RegisterPlanGeneratingHandler

func RegisterPlanGeneratingHandler(ctx context.Context, controller PlanController, apply apply.Apply,
	condition condition.Cond, name string, handler PlanGeneratingHandler, opts *generic.GeneratingHandlerOptions)

func RegisterPlanStatusHandler

func RegisterPlanStatusHandler(ctx context.Context, controller PlanController, condition condition.Cond, name string, handler PlanStatusHandler)

Types

type Interface

type Interface interface {
	Plan() PlanController
}

func New

func New(controllerFactory controller.SharedControllerFactory) Interface

type PlanCache

type PlanCache interface {
	// Get returns the resources with the specified name from the cache.
	Get(namespace, name string) (*v1.Plan, error)

	// List will attempt to find resources from the Cache.
	List(namespace string, selector labels.Selector) ([]*v1.Plan, error)

	// AddIndexer adds  a new Indexer to the cache with the provided name.
	// If you call this after you already have data in the store, the results are undefined.
	AddIndexer(indexName string, indexer PlanIndexer)

	// GetByIndex returns the stored objects whose set of indexed values
	// for the named index includes the given indexed value.
	GetByIndex(indexName, key string) ([]*v1.Plan, error)
}

PlanCache interface for retrieving Plan resources in memory.

type PlanClient

type PlanClient interface {
	// Create creates a new object and return the newly created Object or an error.
	Create(*v1.Plan) (*v1.Plan, error)

	// Update updates the object and return the newly updated Object or an error.
	Update(*v1.Plan) (*v1.Plan, error)
	// UpdateStatus updates the Status field of a the object and return the newly updated Object or an error.
	// Will always return an error if the object does not have a status field.
	UpdateStatus(*v1.Plan) (*v1.Plan, error)

	// Delete deletes the Object in the given name.
	Delete(namespace, name string, options *metav1.DeleteOptions) error

	// Get will attempt to retrieve the resource with the specified name.
	Get(namespace, name string, options metav1.GetOptions) (*v1.Plan, error)

	// List will attempt to find multiple resources.
	List(namespace string, opts metav1.ListOptions) (*v1.PlanList, error)

	// Watch will start watching resources.
	Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error)

	// Patch will patch the resource with the matching name.
	Patch(namespace, name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Plan, err error)
}

PlanClient interface for managing Plan resources in Kubernetes.

type PlanController

type PlanController interface {
	generic.ControllerMeta
	PlanClient

	// OnChange runs the given handler when the controller detects a resource was changed.
	OnChange(ctx context.Context, name string, sync PlanHandler)

	// OnRemove runs the given handler when the controller detects a resource was changed.
	OnRemove(ctx context.Context, name string, sync PlanHandler)

	// Enqueue adds the resource with the given name to the worker queue of the controller.
	Enqueue(namespace, name string)

	// EnqueueAfter runs Enqueue after the provided duration.
	EnqueueAfter(namespace, name string, duration time.Duration)

	// Cache returns a cache for the resource type T.
	Cache() PlanCache
}

PlanController interface for managing Plan resources.

type PlanGeneratingHandler

type PlanGeneratingHandler func(obj *v1.Plan, status v1.PlanStatus) ([]runtime.Object, v1.PlanStatus, error)

type PlanGenericCache

type PlanGenericCache struct {
	generic.CacheInterface[*v1.Plan]
}

PlanGenericCache wraps wrangler/pkg/generic.Cache so the function definitions adhere to PlanCache interface.

func (PlanGenericCache) AddIndexer

func (c PlanGenericCache) AddIndexer(indexName string, indexer PlanIndexer)

AddIndexer adds a new Indexer to the cache with the provided name. If you call this after you already have data in the store, the results are undefined.

type PlanGenericController

type PlanGenericController struct {
	generic.ControllerInterface[*v1.Plan, *v1.PlanList]
}

PlanGenericController wraps wrangler/pkg/generic.Controller so that the function definitions adhere to PlanController interface.

func (*PlanGenericController) Cache

func (c *PlanGenericController) Cache() PlanCache

Cache returns a cache of resources in memory.

func (*PlanGenericController) OnChange

func (c *PlanGenericController) OnChange(ctx context.Context, name string, sync PlanHandler)

OnChange runs the given resource handler when the controller detects a resource was changed.

func (*PlanGenericController) OnRemove

func (c *PlanGenericController) OnRemove(ctx context.Context, name string, sync PlanHandler)

OnRemove runs the given object handler when the controller detects a resource was changed.

type PlanHandler

type PlanHandler func(string, *v1.Plan) (*v1.Plan, error)

PlanHandler is function for performing any potential modifications to a Plan resource.

type PlanIndexer

type PlanIndexer func(obj *v1.Plan) ([]string, error)

PlanIndexer computes a set of indexed values for the provided object.

type PlanStatusHandler

type PlanStatusHandler func(obj *v1.Plan, status v1.PlanStatus) (v1.PlanStatus, error)