storage

Documentation

Index

• func NewGenericREST(optsGetter generic.RESTOptionsGetter) (*GenericREST, *StatusREST)
• type EndpointsStorage
• type GenericREST
  • func (r *GenericREST) Categories() []string
  • func (r *GenericREST) ShortNames() []string
• type REST
  • func NewREST(services ServiceStorage, endpoints EndpointsStorage, pods rest.Getter, ...) (*REST, *registry.ProxyREST)
  • func (rs *REST) Categories() []string
  • func (r *REST) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1beta1.Table, error)
  • func (rs *REST) Create(ctx context.Context, obj runtime.Object, ...) (runtime.Object, error)
  • func (rs *REST) Delete(ctx context.Context, id string, options *metav1.DeleteOptions) (runtime.Object, bool, error)
  • func (rs *REST) Export(ctx context.Context, name string, opts metav1.ExportOptions) (runtime.Object, error)
  • func (rs *REST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)
  • func (rs *REST) List(ctx context.Context, options *metainternalversion.ListOptions) (runtime.Object, error)
  • func (rs *REST) NamespaceScoped() bool
  • func (rs *REST) New() runtime.Object
  • func (rs *REST) NewList() runtime.Object
  • func (rs *REST) ResourceLocation(ctx context.Context, id string) (*url.URL, http.RoundTripper, error)
  • func (rs *REST) ShortNames() []string
  • func (rs *REST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, ...) (runtime.Object, bool, error)
  • func (rs *REST) Watch(ctx context.Context, options *metainternalversion.ListOptions) (watch.Interface, error)
• type ServiceNodePort
• type ServiceStorage
• 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 NewGenericREST

func NewGenericREST(optsGetter generic.RESTOptionsGetter) (*GenericREST, *StatusREST)

NewREST returns a RESTStorage object that will work against services.

Types

type EndpointsStorage

type EndpointsStorage interface {
	rest.Getter
	rest.GracefulDeleter
}

type GenericREST

type GenericREST struct {
	*genericregistry.Store
}

func (*GenericREST) Categories

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

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

func (*GenericREST) ShortNames

func (r *GenericREST) ShortNames() []string

ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.

type REST

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

REST adapts a service registry into apiserver's RESTStorage model.

func NewREST

func NewREST(
	services ServiceStorage,
	endpoints EndpointsStorage,
	pods rest.Getter,
	serviceIPs ipallocator.Interface,
	serviceNodePorts portallocator.Interface,
	proxyTransport http.RoundTripper,
) (*REST, *registry.ProxyREST)

NewREST returns a wrapper around the underlying generic storage and performs allocations and deallocations of various service related resources like ports. TODO: all transactional behavior should be supported from within generic storage

or the strategy.

func (*REST) Categories

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

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

func (*REST) ConvertToTable

func (r *REST) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1beta1.Table, error)

func (*REST) Create

func (rs *REST) Create(ctx context.Context, obj runtime.Object, createValidation rest.ValidateObjectFunc, includeUninitialized bool) (runtime.Object, error)

func (*REST) Delete

func (rs *REST) Delete(ctx context.Context, id string, options *metav1.DeleteOptions) (runtime.Object, bool, error)

func (*REST) Export

func (rs *REST) Export(ctx context.Context, name string, opts metav1.ExportOptions) (runtime.Object, error)

func (*REST) Get

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

func (*REST) List

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

func (*REST) NamespaceScoped

func (rs *REST) NamespaceScoped() bool

func (*REST) New

func (rs *REST) New() runtime.Object

func (*REST) NewList

func (rs *REST) NewList() runtime.Object

func (*REST) ResourceLocation

func (rs *REST) ResourceLocation(ctx context.Context, id string) (*url.URL, http.RoundTripper, error)

ResourceLocation returns a URL to which one can send traffic for the specified service.

func (*REST) ShortNames

func (rs *REST) ShortNames() []string

ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.

func (*REST) Update

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

func (*REST) Watch

func (rs *REST) Watch(ctx context.Context, options *metainternalversion.ListOptions) (watch.Interface, error)

type ServiceNodePort

type ServiceNodePort struct {
	// The IP protocol for this port. Supports "TCP" and "UDP".
	Protocol api.Protocol

	// The port on each node on which this service is exposed.
	// Default is to auto-allocate a port if the ServiceType of this Service requires one.
	NodePort int32
}

ServiceNodePort includes protocol and port number of a service NodePort.

type ServiceStorage

type ServiceStorage interface {
	rest.Scoper
	rest.Getter
	rest.Lister
	rest.CreaterUpdater
	rest.GracefulDeleter
	rest.Watcher
	rest.TableConvertor
	rest.Exporter
}

type StatusREST

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

StatusREST implements the GenericREST endpoint for changing the status of a service.

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.