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
- type Factory
- type Handler
- type Interface
- func GetPlugin(name string, client clientset.Interface, config io.Reader) (Interface, error)
- func InitPlugin(name string, client clientset.Interface, configFilePath string) Interface
- func NewChainHandler(handlers ...Interface) Interface
- func NewFromPlugins(client clientset.Interface, pluginNames []string, configFilePath string) Interface
- type Operation
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetPlugins ¶
func GetPlugins() []string
GetPlugins enumerates the names of all registered plugins.
func NewForbidden ¶ added in v0.16.0
func NewForbidden(a Attributes, internalError error) error
NewForbidden is a utility function to return a well-formatted admission control error response
func NewNotFound ¶ added in v1.1.1
func NewNotFound(a Attributes) error
NewNotFound is a utility function to return a well-formatted admission control error response
func RegisterPlugin ¶
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() unversioned.GroupResource // 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() unversioned.GroupKind // 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 unversioned.GroupKind, namespace, name string, resource unversioned.GroupResource, subresource string, operation Operation, userInfo user.Info) Attributes
type Factory ¶
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 ¶ added in v0.18.2
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 ¶ added in v0.18.2
NewHandler creates a new base handler that handles the passed in operations
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 ¶
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 ¶
InitPlugin creates an instance of the named interface.
func NewChainHandler ¶ added in v0.18.2
NewChainHandler creates a new chain handler from an array of handlers. Used for testing.