Documentation
¶
Index ¶
- Variables
- func GetAdmissionPluginConfigurationFor(pluginCfg apiserver.AdmissionPluginConfiguration) (io.Reader, error)
- func NewChainHandler(handlers ...Interface) chainAdmissionHandler
- func NewForbidden(a Attributes, internalError error) error
- func NewNotFound(a Attributes) error
- func ValidateInitialization(plugin Interface) error
- type AnnotationsGetter
- type Attributes
- type ConfigProvider
- type Decorator
- type DecoratorFunc
- type Decorators
- type Factory
- type Handler
- type InitializationValidator
- type Interface
- type MutationInterface
- type ObjectInterfaces
- type Operation
- type PluginEnabledFunc
- type PluginInitializer
- type PluginInitializers
- type Plugins
- func (ps *Plugins) InitPlugin(name string, config io.Reader, pluginInitializer PluginInitializer) (Interface, error)
- func (ps *Plugins) NewFromPlugins(pluginNames []string, configProvider ConfigProvider, ...) (Interface, error)
- func (ps *Plugins) Register(name string, plugin Factory)
- func (ps *Plugins) Registered() []string
- type ReadyFunc
- type SchemeBasedObjectInterfaces
- func (r *SchemeBasedObjectInterfaces) GetObjectConvertor() runtime.ObjectConvertor
- func (r *SchemeBasedObjectInterfaces) GetObjectCreater() runtime.ObjectCreater
- func (r *SchemeBasedObjectInterfaces) GetObjectDefaulter() runtime.ObjectDefaulter
- func (r *SchemeBasedObjectInterfaces) GetObjectTyper() runtime.ObjectTyper
- type ValidationInterface
Constants ¶
This section is empty.
Variables ¶
var ( // PluginEnabledFn checks whether a plugin is enabled. By default, if you ask about it, it's enabled. PluginEnabledFn = func(name string, config io.Reader) bool { return true } )
All registered admission options.
Functions ¶
func GetAdmissionPluginConfigurationFor ¶
func GetAdmissionPluginConfigurationFor(pluginCfg apiserver.AdmissionPluginConfiguration) (io.Reader, error)
GetAdmissionPluginConfigurationFor returns a reader that holds the admission plugin configuration.
func NewChainHandler ¶
func NewChainHandler(handlers ...Interface) chainAdmissionHandler
NewChainHandler creates a new chain handler from an array of handlers. Used for testing.
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 ValidateInitialization ¶ added in v1.9.0
ValidateInitialization will call the InitializationValidate function in each plugin if they implement the InitializationValidator interface.
Types ¶
type AnnotationsGetter ¶ added in v1.11.7
AnnotationsGetter allows users to get annotations from Attributes. An alternate Attribute should implement this interface.
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() schema.GroupVersionResource // 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 // IsDryRun indicates that modifications will definitely not be persisted for this request. This is to prevent // admission controllers with side effects and a method of reconciliation from being overwhelmed. // However, a value of false for this does not mean that the modification will be persisted, because it // could still be rejected by a subsequent validation step. IsDryRun() bool // GetObject is the object from the incoming request prior to default values being applied GetObject() runtime.Object // GetOldObject is the existing object. Only populated for UPDATE requests. GetOldObject() runtime.Object // GetKind is the type of object being manipulated. For example: Pod GetKind() schema.GroupVersionKind // GetUserInfo is information about the requesting user GetUserInfo() user.Info // AddAnnotation sets annotation according to key-value pair. The key should be qualified, e.g., podsecuritypolicy.admission.k8s.io/admit-policy, where // "podsecuritypolicy" is the name of the plugin, "admission.k8s.io" is the name of the organization, "admit-policy" is the key name. // An error is returned if the format of key is invalid. When trying to overwrite annotation with a new value, an error is returned. // Both ValidationInterface and MutationInterface are allowed to add Annotations. AddAnnotation(key, value string) error }
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, oldObject runtime.Object, kind schema.GroupVersionKind, namespace, name string, resource schema.GroupVersionResource, subresource string, operation Operation, dryRun bool, userInfo user.Info) Attributes
type ConfigProvider ¶
ConfigProvider provides a way to get configuration for an admission plugin based on its name
func ReadAdmissionConfiguration ¶
func ReadAdmissionConfiguration(pluginNames []string, configFilePath string, configScheme *runtime.Scheme) (ConfigProvider, error)
ReadAdmissionConfiguration reads the admission configuration at the specified path. It returns the loaded admission configuration if the input file aligns with the required syntax. If it does not align with the provided syntax, it returns a default configuration for the enumerated set of pluginNames whose config location references the specified configFilePath. It does this to preserve backward compatibility when admission control files were opaque. It returns an error if the file did not exist.
type DecoratorFunc ¶ added in v1.10.6
type Decorators ¶ added in v1.10.6
type Decorators []Decorator
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 ¶
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 ¶
NewHandler creates a new base handler that handles the passed in operations
func (*Handler) SetReadyFunc ¶
SetReadyFunc allows late registration of a ReadyFunc to know if the handler is ready to process requests.
func (*Handler) WaitForReady ¶
WaitForReady will wait for the readyFunc (if registered) to return ready, and in case of timeout, will return false.
type InitializationValidator ¶ added in v1.9.0
type InitializationValidator interface {
ValidateInitialization() error
}
InitializationValidator holds ValidateInitialization functions, which are responsible for validation of initialized shared resources and should be implemented on admission plugins
type Interface ¶
type Interface interface { // 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 WithAudit ¶ added in v1.11.7
func WithAudit(i Interface, ae *auditinternal.Event) Interface
WithAudit is a decorator for a admission phase. It saves annotations of attribute into the audit event. Attributes passed to the Admit and Validate function must be instance of privateAnnotationsGetter or AnnotationsGetter, otherwise an error is returned.
type MutationInterface ¶ added in v1.9.0
type MutationInterface interface { Interface // Admit makes an admission decision based on the request attributes Admit(a Attributes, o ObjectInterfaces) (err error) }
type ObjectInterfaces ¶ added in v1.14.1
type ObjectInterfaces interface { // GetObjectCreater is the ObjectCreator appropriate for the requested object. GetObjectCreater() runtime.ObjectCreater // GetObjectTyper is the ObjectTyper appropriate for the requested object. GetObjectTyper() runtime.ObjectTyper // GetObjectDefaulter is the ObjectDefaulter appropriate for the requested object. GetObjectDefaulter() runtime.ObjectDefaulter // GetObjectConvertor is the ObjectConvertor appropriate for the requested object. GetObjectConvertor() runtime.ObjectConvertor }
ObjectInterfaces is an interface used by AdmissionController to get object interfaces such as Converter or Defaulter. These interfaces are normally coming from Request Scope to handle special cases like CRDs.
type Operation ¶
type Operation string
Operation is the type of resource operation being checked for admission control
type PluginEnabledFunc ¶
PluginEnabledFunc is a function type that can provide an external check on whether an admission plugin may be enabled
type PluginInitializer ¶
type PluginInitializer interface {
Initialize(plugin Interface)
}
PluginInitializer is used for initialization of shareable resources between admission plugins. After initialization the resources have to be set separately
type PluginInitializers ¶
type PluginInitializers []PluginInitializer
func (PluginInitializers) Initialize ¶
func (pp PluginInitializers) Initialize(plugin Interface)
type Plugins ¶ added in v1.7.0
type Plugins struct {
// contains filtered or unexported fields
}
func NewPlugins ¶ added in v1.9.0
func NewPlugins() *Plugins
func (*Plugins) InitPlugin ¶ added in v1.7.0
func (ps *Plugins) InitPlugin(name string, config io.Reader, pluginInitializer PluginInitializer) (Interface, error)
InitPlugin creates an instance of the named interface.
func (*Plugins) NewFromPlugins ¶ added in v1.7.0
func (ps *Plugins) NewFromPlugins(pluginNames []string, configProvider ConfigProvider, pluginInitializer PluginInitializer, decorator Decorator) (Interface, error)
NewFromPlugins returns an admission.Interface that will enforce admission control decisions of all the given plugins.
func (*Plugins) Register ¶ added in v1.7.0
Register registers a plugin Factory by name. This is expected to happen during app startup.
func (*Plugins) Registered ¶ added in v1.7.0
Registered enumerates the names of all registered plugins.
type ReadyFunc ¶
type ReadyFunc func() bool
ReadyFunc is a function that returns true if the admission controller is ready to handle requests.
type SchemeBasedObjectInterfaces ¶ added in v1.14.1
func (*SchemeBasedObjectInterfaces) GetObjectConvertor ¶ added in v1.14.1
func (r *SchemeBasedObjectInterfaces) GetObjectConvertor() runtime.ObjectConvertor
func (*SchemeBasedObjectInterfaces) GetObjectCreater ¶ added in v1.14.1
func (r *SchemeBasedObjectInterfaces) GetObjectCreater() runtime.ObjectCreater
func (*SchemeBasedObjectInterfaces) GetObjectDefaulter ¶ added in v1.14.1
func (r *SchemeBasedObjectInterfaces) GetObjectDefaulter() runtime.ObjectDefaulter
func (*SchemeBasedObjectInterfaces) GetObjectTyper ¶ added in v1.14.1
func (r *SchemeBasedObjectInterfaces) GetObjectTyper() runtime.ObjectTyper
type ValidationInterface ¶ added in v1.9.0
type ValidationInterface interface { Interface // Validate makes an admission decision based on the request attributes. It is NOT allowed to mutate Validate(a Attributes, o ObjectInterfaces) (err error) }
ValidationInterface is an abstract, pluggable interface for Admission Control decisions.
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
plugin
|
|
webhook/config/apis/webhookadmission/install
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
webhook/config/apis/webhookadmission/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
webhook/errors
Package errors contains utilities for admission webhook specific errors
|
Package errors contains utilities for admission webhook specific errors |
webhook/mutating
Package mutating delegates admission checks to dynamically configured mutating webhooks.
|
Package mutating delegates admission checks to dynamically configured mutating webhooks. |
webhook/namespace
Package namespace defines the utilities that are used by the webhook plugin to decide if a webhook should be applied to an object based on its namespace.
|
Package namespace defines the utilities that are used by the webhook plugin to decide if a webhook should be applied to an object based on its namespace. |
webhook/request
Package request creates admissionReview request based on admission attributes.
|
Package request creates admissionReview request based on admission attributes. |
webhook/testcerts
Package testcerts contains generated key pairs used by the unit tests of mutating and validating webhooks.
|
Package testcerts contains generated key pairs used by the unit tests of mutating and validating webhooks. |
webhook/validating
Package validating makes calls to validating (i.e., non-mutating) webhooks during the admission process.
|
Package validating makes calls to validating (i.e., non-mutating) webhooks during the admission process. |