admission

Documentation

Index

• func GetPlugins() []string
• func NewForbidden(a Attributes, internalError error) error
• func NewNotFound(a Attributes) error
• func RegisterPlugin(name string, plugin Factory)
• type Attributes
  • func NewAttributesRecord(object runtime.Object, kind, namespace, name, resource, subresource string, ...) Attributes
• type Factory
• type Handler
  • func NewHandler(ops ...Operation) *Handler
  • func (h *Handler) Handles(operation Operation) bool
• type Interface
  • func GetPlugin(name string, client client.Interface, config io.Reader) (Interface, error)
  • func InitPlugin(name string, client client.Interface, configFilePath string) Interface
  • func NewChainHandler(handlers ...Interface) Interface
  • func NewFromPlugins(client client.Interface, pluginNames []string, configFilePath string) Interface
• type Operation

Functions

func GetPlugins

func GetPlugins() []string

GetPlugins enumerates the names of all registered plugins.

func NewForbidden

func NewForbidden(a Attributes, internalError error) error

NewForbidden is a utility function to return a well-formatted admission control error response

func NewNotFound

func NewNotFound(a Attributes) error

NewNotFound is a utility function to return a well-formatted admission control error response

func RegisterPlugin

func RegisterPlugin(name string, plugin Factory)

RegisterPlugin registers a plugin Factory by name. This is expected to happen during app startup.

Types

type Attributes

type Attributes interface {
	// GetName returns the name of the object as presented in the request.  On a CREATE operation, the client
	// may omit name and rely on the server to generate the name.  If that is the case, this method will return
	// the empty string
	GetName() string
	// GetNamespace is the namespace associated with the request (if any)
	GetNamespace() string
	// GetResource is the name of the resource being requested.  This is not the kind.  For example: pods
	GetResource() string
	// GetSubresource is the name of the subresource being requested.  This is a different resource, scoped to the parent resource, but it may have a different kind.
	// For instance, /pods has the resource "pods" and the kind "Pod", while /pods/foo/status has the resource "pods", the sub resource "status", and the kind "Pod"
	// (because status operates on pods). The binding resource for a pod though may be /pods/foo/binding, which has resource "pods", subresource "binding", and kind "Binding".
	GetSubresource() string
	// GetOperation is the operation being performed
	GetOperation() Operation
	// GetObject is the object from the incoming request prior to default values being applied
	GetObject() runtime.Object
	// GetKind is the type of object being manipulated.  For example: Pod
	GetKind() string
	// GetUserInfo is information about the requesting user
	GetUserInfo() user.Info
}

Attributes is an interface used by AdmissionController to get information about a request that is used to make an admission decision.

func NewAttributesRecord

func NewAttributesRecord(object runtime.Object, kind, namespace, name, resource, subresource string, operation Operation, userInfo user.Info) Attributes

type Factory

type Factory func(client client.Interface, config io.Reader) (Interface, error)

Factory is a function that returns an Interface for admission decisions. The config parameter provides an io.Reader handler to the factory in order to load specific configurations. If no configuration is provided the parameter is nil.

type Handler

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

Handler is a base for admission control handlers that support a predefined set of operations

func NewHandler

func NewHandler(ops ...Operation) *Handler

NewHandler creates a new base handler that handles the passed in operations

func (*Handler) Handles

func (h *Handler) Handles(operation Operation) bool

Handles returns true for methods that this handler supports

type Interface

type Interface interface {
	// Admit makes an admission decision based on the request attributes
	Admit(a Attributes) (err error)

	// Handles returns true if this admission controller can handle the given operation
	// where operation can be one of CREATE, UPDATE, DELETE, or CONNECT
	Handles(operation Operation) bool
}

Interface is an abstract, pluggable interface for Admission Control decisions.

func GetPlugin

func GetPlugin(name string, client client.Interface, config io.Reader) (Interface, error)

GetPlugin creates an instance of the named plugin, or nil if the name is not known. The error is returned only when the named provider was known but failed to initialize. The config parameter specifies the io.Reader handler of the configuration file for the cloud provider, or nil for no configuration.

func InitPlugin

func InitPlugin(name string, client client.Interface, configFilePath string) Interface

InitPlugin creates an instance of the named interface.

func NewChainHandler

func NewChainHandler(handlers ...Interface) Interface

NewChainHandler creates a new chain handler from an array of handlers. Used for testing.

func NewFromPlugins

func NewFromPlugins(client client.Interface, pluginNames []string, configFilePath string) Interface

NewFromPlugins returns an admission.Interface that will enforce admission control decisions of all the given plugins.

type Operation

type Operation string

Operation is the type of resource operation being checked for admission control

const (
	Create  Operation = "CREATE"
	Update  Operation = "UPDATE"
	Delete  Operation = "DELETE"
	Connect Operation = "CONNECT"
)

Operation constants