MutatingAdmissionPolicyBinding admissionregistration.k8s.io/v1
Other versions: v1beta1 v1alpha1
MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources. MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters.
For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget.
Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.
Fields
- apiVersion:
admissionregistration.k8s.io/v1 - kind:
MutatingAdmissionPolicyBinding - metadata (ObjectMeta)
-
metadata is the standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- spec (MutatingAdmissionPolicyBindingSpec)
-
spec defines the desired behavior of the MutatingAdmissionPolicyBinding.
MutatingAdmissionPolicyBindingSpec
MutatingAdmissionPolicyBindingSpec defines the specification of the MutatingAdmissionPolicyBinding.
- matchResources (MatchResources)
-
matchResources limits what resources match this binding and may be mutated by it. Note that if matchResources matches a resource, the resource must also match a policy's matchConstraints and matchConditions before the resource may be mutated. When matchResources is unset, it does not constrain resource matching, and only the policy's matchConstraints and matchConditions must match for the resource to be mutated. Additionally, matchResources.resourceRules are optional and do not constraint matching when unset. Note that this is differs from MutatingAdmissionPolicy matchConstraints, where resourceRules are required. The CREATE, UPDATE and CONNECT operations are allowed. The DELETE operation may not be matched. '*' matches CREATE, UPDATE and CONNECT.
- paramRef (ParamRef)
-
paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in spec.ParamKind of the bound MutatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the MutatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param.
- policyName (string)
-
policyName references a MutatingAdmissionPolicy name which the MutatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required.
MatchResources
MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
- excludeResourceRules ([]NamedRuleWithOperations)
-
excludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)
NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
- excludeResourceRules.apiGroups ([]string)
apiGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
- excludeResourceRules.apiVersions ([]string)
apiVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
- excludeResourceRules.operations ([]string)
operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- excludeResourceRules.resourceNames ([]string)
resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- excludeResourceRules.resources ([]string)
resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- excludeResourceRules.scope (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- matchPolicy (string)
-
matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
-
Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included
apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"], a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. -
Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included
apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"], a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy.
Defaults to "Equivalent"
-
- namespaceSelector (LabelSelector)
-
namespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy.
For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] }
If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] }
See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors.
Default to the empty LabelSelector, which matches everything.
- objectSelector (LabelSelector)
-
objectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
- resourceRules ([]NamedRuleWithOperations)
-
resourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.
NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
- resourceRules.apiGroups ([]string)
apiGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
- resourceRules.apiVersions ([]string)
apiVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
- resourceRules.operations ([]string)
operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- resourceRules.resourceNames ([]string)
resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- resourceRules.resources ([]string)
resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/' means all subresources of pods. '/scale' means all scale subresources. '/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- resourceRules.scope (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
ParamRef
ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.
- name (string)
-
name is the name of the resource being referenced.
One of
nameorselectormust be set, butnameandselectorare mutually exclusive properties. If one is set, the other must be unset.A single parameter used for all admission requests can be configured by setting the
namefield, leavingselectorblank, and setting namespace ifparamKindis namespace-scoped. - namespace (string)
-
namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both
nameandselectorfields.A per-namespace parameter may be used by specifying a namespace-scoped
paramKindin the policy and leaving this field empty.-
If
paramKindis cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. -
If
paramKindis namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.
-
- parameterNotFoundAction (string)
-
parameterNotFoundAction controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to
Allow, then no matched parameters will be treated as successful validation by the binding. If set toDeny, then no matched parameters will be subject to thefailurePolicyof the policy.Allowed values are
AlloworDenyRequired
- selector (LabelSelector)
-
selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind.
If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.
One of
nameorselectormust be set, butnameandselectorare mutually exclusive properties. If one is set, the other must be unset.
MutatingAdmissionPolicyBindingList
MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.
- apiVersion:
admissionregistration.k8s.io/v1 - kind:
MutatingAdmissionPolicyBindingList - metadata (ListMeta)
-
metadata is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- items ([]MutatingAdmissionPolicyBinding)
-
List of PolicyBinding.