customresource

Documentation

Index

• func NewStatusStrategy(strategy customResourceStrategy) statusStrategy
• func NewStrategy(typer runtime.ObjectTyper, namespaceScoped bool, kind schema.GroupVersionKind, ...) customResourceStrategy
• type CustomResourceStorage
  • func NewStorage(resource schema.GroupResource, listKind schema.GroupVersionKind, ...) CustomResourceStorage
• type REST
  • func (r *REST) Categories() []string
  • func (r *REST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)
  • func (e *REST) List(ctx context.Context, options *metainternalversion.ListOptions) (runtime.Object, error)
• type Registry
  • func NewRegistry(s rest.StandardStorage) Registry
• type ScaleREST
  • func (r *ScaleREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)
  • func (r *ScaleREST) GroupVersionKind(containingGV schema.GroupVersion) schema.GroupVersionKind
  • func (r *ScaleREST) New() runtime.Object
  • func (r *ScaleREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, ...) (runtime.Object, bool, error)
• type StatusREST
  • func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)
  • func (r *StatusREST) New() runtime.Object
  • func (r *StatusREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, ...) (runtime.Object, bool, error)

Functions

func NewStatusStrategy

func NewStatusStrategy(strategy customResourceStrategy) statusStrategy

func NewStrategy

func NewStrategy(typer runtime.ObjectTyper, namespaceScoped bool, kind schema.GroupVersionKind, schemaValidator, statusSchemaValidator *validate.SchemaValidator, status *apiextensions.CustomResourceSubresourceStatus, scale *apiextensions.CustomResourceSubresourceScale) customResourceStrategy

Types

type CustomResourceStorage

type CustomResourceStorage struct {
	CustomResource *REST
	Status         *StatusREST
	Scale          *ScaleREST
}

CustomResourceStorage includes dummy storage for CustomResources, and their Status and Scale subresources.

func NewStorage

func NewStorage(resource schema.GroupResource, listKind schema.GroupVersionKind, strategy customResourceStrategy, optsGetter generic.RESTOptionsGetter, categories []string, tableConvertor rest.TableConvertor) CustomResourceStorage

type REST

type REST struct {
	*genericregistry.Store
	// contains filtered or unexported fields
}

REST implements a RESTStorage for API services against etcd

func (*REST) Categories

func (r *REST) Categories() []string

Categories implements the CategoriesProvider interface. Returns a list of categories a resource is part of.

func (*REST) Get

func (r *REST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)

func (*REST) List

func (e *REST) List(ctx context.Context, options *metainternalversion.ListOptions) (runtime.Object, error)

List returns a list of items matching labels and field according to the store's PredicateFunc.

type Registry

type Registry interface {
	ListCustomResources(ctx context.Context, options *metainternalversion.ListOptions) (*unstructured.UnstructuredList, error)
	WatchCustomResources(ctx context.Context, options *metainternalversion.ListOptions) (watch.Interface, error)
	GetCustomResource(ctx context.Context, customResourceID string, options *metav1.GetOptions) (*unstructured.Unstructured, error)
	CreateCustomResource(ctx context.Context, customResource *unstructured.Unstructured, createValidation rest.ValidateObjectFunc) (*unstructured.Unstructured, error)
	UpdateCustomResource(ctx context.Context, customResource *unstructured.Unstructured, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc) (*unstructured.Unstructured, error)
	DeleteCustomResource(ctx context.Context, customResourceID string) error
}

Registry is an interface for things that know how to store CustomResources.

func NewRegistry

func NewRegistry(s rest.StandardStorage) Registry

NewRegistry returns a new Registry interface for the given Storage. Any mismatched types will panic.

type ScaleREST

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

func (*ScaleREST) Get

func (r *ScaleREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)

func (*ScaleREST) GroupVersionKind

func (r *ScaleREST) GroupVersionKind(containingGV schema.GroupVersion) schema.GroupVersionKind

func (*ScaleREST) New

func (r *ScaleREST) New() runtime.Object

New creates a new Scale object

func (*ScaleREST) Update

func (r *ScaleREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc) (runtime.Object, bool, error)

type StatusREST

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

StatusREST implements the REST endpoint for changing the status of a CustomResource

func (*StatusREST) Get

func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)

Get retrieves the object from the storage. It is required to support Patch.

func (*StatusREST) New

func (r *StatusREST) New() runtime.Object

func (*StatusREST) Update

func (r *StatusREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc) (runtime.Object, bool, error)

Update alters the status subset of an object.