12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064 |
- /*
- Copyright The Kubernetes Authors.
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- // This file was autogenerated by go-to-protobuf. Do not edit it manually!
- syntax = "proto2";
- package k8s.io.api.admissionregistration.v1beta1;
- import "k8s.io/api/admissionregistration/v1/generated.proto";
- import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
- import "k8s.io/apimachinery/pkg/runtime/generated.proto";
- import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
- // Package-wide variables from generator "generated".
- option go_package = "k8s.io/api/admissionregistration/v1beta1";
- // AuditAnnotation describes how to produce an audit annotation for an API request.
- message AuditAnnotation {
- // key specifies the audit annotation key. The audit annotation keys of
- // a ValidatingAdmissionPolicy must be unique. The key must be a qualified
- // name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.
- //
- // The key is combined with the resource name of the
- // ValidatingAdmissionPolicy to construct an audit annotation key:
- // "{ValidatingAdmissionPolicy name}/{key}".
- //
- // If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy
- // and the same audit annotation key, the annotation key will be identical.
- // In this case, the first annotation written with the key will be included
- // in the audit event and all subsequent annotations with the same key
- // will be discarded.
- //
- // Required.
- optional string key = 1;
- // valueExpression represents the expression which is evaluated by CEL to
- // produce an audit annotation value. The expression must evaluate to either
- // a string or null value. If the expression evaluates to a string, the
- // audit annotation is included with the string value. If the expression
- // evaluates to null or empty string the audit annotation will be omitted.
- // The valueExpression may be no longer than 5kb in length.
- // If the result of the valueExpression is more than 10kb in length, it
- // will be truncated to 10kb.
- //
- // If multiple ValidatingAdmissionPolicyBinding resources match an
- // API request, then the valueExpression will be evaluated for
- // each binding. All unique values produced by the valueExpressions
- // will be joined together in a comma-separated list.
- //
- // Required.
- optional string valueExpression = 2;
- }
- // ExpressionWarning is a warning information that targets a specific expression.
- message ExpressionWarning {
- // The path to the field that refers the expression.
- // For example, the reference to the expression of the first item of
- // validations is "spec.validations[0].expression"
- optional string fieldRef = 2;
- // The content of type checking information in a human-readable form.
- // Each line of the warning contains the type that the expression is checked
- // against, followed by the type check error from the compiler.
- optional string warning = 3;
- }
- // MatchCondition represents a condition which must be fulfilled for a request to be sent to a webhook.
- message MatchCondition {
- // Name is an identifier for this match condition, used for strategic merging of MatchConditions,
- // as well as providing an identifier for logging purposes. A good name should be descriptive of
- // the associated expression.
- // Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and
- // must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or
- // '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an
- // optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
- //
- // Required.
- optional string name = 1;
- // Expression represents the expression which will be evaluated by CEL. Must evaluate to bool.
- // CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
- //
- // 'object' - The object from the incoming request. The value is null for DELETE requests.
- // 'oldObject' - The existing object. The value is null for CREATE requests.
- // 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest).
- // 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
- // See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- // 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
- // request resource.
- // Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
- //
- // Required.
- optional string expression = 2;
- }
- // 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)
- // +structType=atomic
- message MatchResources {
- // 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 1;
- // 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector objectSelector = 2;
- // ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches.
- // The policy cares about an operation if it matches _any_ Rule.
- // +listType=atomic
- // +optional
- repeated NamedRuleWithOperations resourceRules = 3;
- // 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)
- // +listType=atomic
- // +optional
- repeated NamedRuleWithOperations excludeResourceRules = 4;
- // 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"
- // +optional
- optional string matchPolicy = 7;
- }
- // MutatingWebhook describes an admission webhook and the resources and operations it applies to.
- message MutatingWebhook {
- // The name of the admission webhook.
- // Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where
- // "imagepolicy" is the name of the webhook, and kubernetes.io is the name
- // of the organization.
- // Required.
- optional string name = 1;
- // ClientConfig defines how to communicate with the hook.
- // Required
- optional WebhookClientConfig clientConfig = 2;
- // Rules describes what operations on what resources/subresources the webhook cares about.
- // The webhook cares about an operation if it matches _any_ Rule.
- // However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks
- // from putting the cluster in a state which cannot be recovered from without completely
- // disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called
- // on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
- repeated k8s.io.api.admissionregistration.v1.RuleWithOperations rules = 3;
- // FailurePolicy defines how unrecognized errors from the admission endpoint are handled -
- // allowed values are Ignore or Fail. Defaults to Ignore.
- // +optional
- optional string failurePolicy = 4;
- // matchPolicy defines how the "rules" 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 webhook.
- //
- // - 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 webhook.
- //
- // Defaults to "Exact"
- // +optional
- optional string matchPolicy = 9;
- // NamespaceSelector decides whether to run the webhook 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 webhook.
- //
- // 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 webhook 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 5;
- // ObjectSelector decides whether to run the webhook based on if the
- // object has matching labels. objectSelector is evaluated against both
- // the oldObject and newObject that would be sent to the webhook, 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector objectSelector = 11;
- // SideEffects states whether this webhook has side effects.
- // Acceptable values are: Unknown, None, Some, NoneOnDryRun
- // Webhooks with side effects MUST implement a reconciliation system, since a request may be
- // rejected by a future step in the admission chain and the side effects therefore need to be undone.
- // Requests with the dryRun attribute will be auto-rejected if they match a webhook with
- // sideEffects == Unknown or Some. Defaults to Unknown.
- // +optional
- optional string sideEffects = 6;
- // TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,
- // the webhook call will be ignored or the API call will fail based on the
- // failure policy.
- // The timeout value must be between 1 and 30 seconds.
- // Default to 30 seconds.
- // +optional
- optional int32 timeoutSeconds = 7;
- // AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`
- // versions the Webhook expects. API server will try to use first version in
- // the list which it supports. If none of the versions specified in this list
- // supported by API server, validation will fail for this object.
- // If a persisted webhook configuration specifies allowed versions and does not
- // include any versions known to the API Server, calls to the webhook will fail
- // and be subject to the failure policy.
- // Default to `['v1beta1']`.
- // +optional
- repeated string admissionReviewVersions = 8;
- // reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.
- // Allowed values are "Never" and "IfNeeded".
- //
- // Never: the webhook will not be called more than once in a single admission evaluation.
- //
- // IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation
- // if the object being admitted is modified by other admission plugins after the initial webhook call.
- // Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted.
- // Note:
- // * the number of additional invocations is not guaranteed to be exactly one.
- // * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again.
- // * webhooks that use this option may be reordered to minimize the number of additional invocations.
- // * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead.
- //
- // Defaults to "Never".
- // +optional
- optional string reinvocationPolicy = 10;
- // MatchConditions is a list of conditions that must be met for a request to be sent to this
- // webhook. Match conditions filter requests that have already been matched by the rules,
- // namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.
- // There are a maximum of 64 match conditions allowed.
- //
- // The exact matching logic is (in order):
- // 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
- // 2. If ALL matchConditions evaluate to TRUE, the webhook is called.
- // 3. If any matchCondition evaluates to an error (but none are FALSE):
- // - If failurePolicy=Fail, reject the request
- // - If failurePolicy=Ignore, the error is ignored and the webhook is skipped
- //
- // This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.
- //
- // +patchMergeKey=name
- // +patchStrategy=merge
- // +listType=map
- // +listMapKey=name
- // +featureGate=AdmissionWebhookMatchConditions
- // +optional
- repeated MatchCondition matchConditions = 12;
- }
- // MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.
- // Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead.
- message MutatingWebhookConfiguration {
- // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
- // Webhooks is a list of webhooks and the affected resources and operations.
- // +optional
- // +patchMergeKey=name
- // +patchStrategy=merge
- repeated MutatingWebhook Webhooks = 2;
- }
- // MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.
- message MutatingWebhookConfigurationList {
- // Standard list metadata.
- // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
- // List of MutatingWebhookConfiguration.
- repeated MutatingWebhookConfiguration items = 2;
- }
- // NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.
- // +structType=atomic
- message NamedRuleWithOperations {
- // ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
- // +listType=atomic
- // +optional
- repeated string resourceNames = 1;
- // RuleWithOperations is a tuple of Operations and Resources.
- optional k8s.io.api.admissionregistration.v1.RuleWithOperations ruleWithOperations = 2;
- }
- // ParamKind is a tuple of Group Kind and Version.
- // +structType=atomic
- message ParamKind {
- // APIVersion is the API group version the resources belong to.
- // In format of "group/version".
- // Required.
- optional string apiVersion = 1;
- // Kind is the API kind the resources belong to.
- // Required.
- optional string kind = 2;
- }
- // ParamRef describes how to locate the params to be used as input to
- // expressions of rules applied by a policy binding.
- // +structType=atomic
- message ParamRef {
- // name is the name of the resource being referenced.
- //
- // One of `name` or `selector` must be set, but `name` and `selector` are
- // 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 `name` field, leaving `selector` blank, and setting namespace
- // if `paramKind` is namespace-scoped.
- optional string name = 1;
- // namespace is the namespace of the referenced resource. Allows limiting
- // the search for params to a specific namespace. Applies to both `name` and
- // `selector` fields.
- //
- // A per-namespace parameter may be used by specifying a namespace-scoped
- // `paramKind` in the policy and leaving this field empty.
- //
- // - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this
- // field results in a configuration error.
- //
- // - If `paramKind` is 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.
- //
- // +optional
- optional string namespace = 2;
- // 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 `name` or `selector` must be set, but `name` and `selector` are
- // mutually exclusive properties. If one is set, the other must be unset.
- //
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 3;
- // `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 to `Deny`, then no matched parameters will be subject to the
- // `failurePolicy` of the policy.
- //
- // Allowed values are `Allow` or `Deny`
- //
- // Required
- optional string parameterNotFoundAction = 4;
- }
- // ServiceReference holds a reference to Service.legacy.k8s.io
- message ServiceReference {
- // `namespace` is the namespace of the service.
- // Required
- optional string namespace = 1;
- // `name` is the name of the service.
- // Required
- optional string name = 2;
- // `path` is an optional URL path which will be sent in any request to
- // this service.
- // +optional
- optional string path = 3;
- // If specified, the port on the service that hosting webhook.
- // Default to 443 for backward compatibility.
- // `port` should be a valid port number (1-65535, inclusive).
- // +optional
- optional int32 port = 4;
- }
- // TypeChecking contains results of type checking the expressions in the
- // ValidatingAdmissionPolicy
- message TypeChecking {
- // The type checking warnings for each expression.
- // +optional
- // +listType=atomic
- repeated ExpressionWarning expressionWarnings = 1;
- }
- // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
- // +genclient
- // +genclient:nonNamespaced
- // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
- // +k8s:prerelease-lifecycle-gen:introduced=1.28
- // ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.
- message ValidatingAdmissionPolicy {
- // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
- // Specification of the desired behavior of the ValidatingAdmissionPolicy.
- optional ValidatingAdmissionPolicySpec spec = 2;
- // The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy
- // behaves in the expected way.
- // Populated by the system.
- // Read-only.
- // +optional
- optional ValidatingAdmissionPolicyStatus status = 3;
- }
- // ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources.
- // ValidatingAdmissionPolicyBinding and parameter CRDs 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.
- //
- // The CEL expressions of a policy must have a computed CEL cost below the maximum
- // CEL budget. Each evaluation of the policy is given an independent CEL cost budget.
- // Adding/removing policies, bindings, or params can not affect whether a
- // given (policy, binding, param) combination is within its own CEL budget.
- message ValidatingAdmissionPolicyBinding {
- // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
- // Specification of the desired behavior of the ValidatingAdmissionPolicyBinding.
- optional ValidatingAdmissionPolicyBindingSpec spec = 2;
- }
- // ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding.
- message ValidatingAdmissionPolicyBindingList {
- // Standard list metadata.
- // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
- // List of PolicyBinding.
- repeated ValidatingAdmissionPolicyBinding items = 2;
- }
- // ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding.
- message ValidatingAdmissionPolicyBindingSpec {
- // PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to.
- // If the referenced resource does not exist, this binding is considered invalid and will be ignored
- // Required.
- optional string policyName = 1;
- // paramRef specifies the parameter resource used to configure the admission control policy.
- // It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy.
- // 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 ValidatingAdmissionPolicy applied.
- // If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param.
- // +optional
- optional ParamRef paramRef = 2;
- // MatchResources declares what resources match this binding and will be validated by it.
- // Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this.
- // If this is unset, all resources matched by the policy are validated by this binding
- // When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated.
- // Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required.
- // +optional
- optional MatchResources matchResources = 3;
- // validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced.
- // If a validation evaluates to false it is always enforced according to these actions.
- //
- // Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according
- // to these actions only if the FailurePolicy is set to Fail, otherwise the failures are
- // ignored. This includes compilation errors, runtime errors and misconfigurations of the policy.
- //
- // validationActions is declared as a set of action values. Order does
- // not matter. validationActions may not contain duplicates of the same action.
- //
- // The supported actions values are:
- //
- // "Deny" specifies that a validation failure results in a denied request.
- //
- // "Warn" specifies that a validation failure is reported to the request client
- // in HTTP Warning headers, with a warning code of 299. Warnings can be sent
- // both for allowed or denied admission responses.
- //
- // "Audit" specifies that a validation failure is included in the published
- // audit event for the request. The audit event will contain a
- // `validation.policy.admission.k8s.io/validation_failure` audit annotation
- // with a value containing the details of the validation failures, formatted as
- // a JSON list of objects, each with the following fields:
- // - message: The validation failure message string
- // - policy: The resource name of the ValidatingAdmissionPolicy
- // - binding: The resource name of the ValidatingAdmissionPolicyBinding
- // - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy
- // - validationActions: The enforcement actions enacted for the validation failure
- // Example audit annotation:
- // `"validation.policy.admission.k8s.io/validation_failure": "[{\"message\": \"Invalid value\", {\"policy\": \"policy.example.com\", {\"binding\": \"policybinding.example.com\", {\"expressionIndex\": \"1\", {\"validationActions\": [\"Audit\"]}]"`
- //
- // Clients should expect to handle additional values by ignoring
- // any values not recognized.
- //
- // "Deny" and "Warn" may not be used together since this combination
- // needlessly duplicates the validation failure both in the
- // API response body and the HTTP warning headers.
- //
- // Required.
- // +listType=set
- repeated string validationActions = 4;
- }
- // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
- // +k8s:prerelease-lifecycle-gen:introduced=1.28
- // ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy.
- message ValidatingAdmissionPolicyList {
- // Standard list metadata.
- // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
- // List of ValidatingAdmissionPolicy.
- repeated ValidatingAdmissionPolicy items = 2;
- }
- // ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.
- message ValidatingAdmissionPolicySpec {
- // ParamKind specifies the kind of resources used to parameterize this policy.
- // If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions.
- // If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied.
- // If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null.
- // +optional
- optional ParamKind paramKind = 1;
- // MatchConstraints specifies what resources this policy is designed to validate.
- // The AdmissionPolicy cares about a request if it matches _all_ Constraints.
- // However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API
- // ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding.
- // Required.
- optional MatchResources matchConstraints = 2;
- // Validations contain CEL expressions which is used to apply the validation.
- // Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is
- // required.
- // +listType=atomic
- // +optional
- repeated Validation validations = 3;
- // failurePolicy defines how to handle failures for the admission policy. Failures can
- // occur from CEL expression parse errors, type check errors, runtime errors and invalid
- // or mis-configured policy definitions or bindings.
- //
- // A policy is invalid if spec.paramKind refers to a non-existent Kind.
- // A binding is invalid if spec.paramRef.name refers to a non-existent resource.
- //
- // failurePolicy does not define how validations that evaluate to false are handled.
- //
- // When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions
- // define how failures are enforced.
- //
- // Allowed values are Ignore or Fail. Defaults to Fail.
- // +optional
- optional string failurePolicy = 4;
- // auditAnnotations contains CEL expressions which are used to produce audit
- // annotations for the audit event of the API request.
- // validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is
- // required.
- // +listType=atomic
- // +optional
- repeated AuditAnnotation auditAnnotations = 5;
- // MatchConditions is a list of conditions that must be met for a request to be validated.
- // Match conditions filter requests that have already been matched by the rules,
- // namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.
- // There are a maximum of 64 match conditions allowed.
- //
- // If a parameter object is provided, it can be accessed via the `params` handle in the same
- // manner as validation expressions.
- //
- // The exact matching logic is (in order):
- // 1. If ANY matchCondition evaluates to FALSE, the policy is skipped.
- // 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.
- // 3. If any matchCondition evaluates to an error (but none are FALSE):
- // - If failurePolicy=Fail, reject the request
- // - If failurePolicy=Ignore, the policy is skipped
- //
- // +patchMergeKey=name
- // +patchStrategy=merge
- // +listType=map
- // +listMapKey=name
- // +optional
- repeated MatchCondition matchConditions = 6;
- // Variables contain definitions of variables that can be used in composition of other expressions.
- // Each variable is defined as a named CEL expression.
- // The variables defined here will be available under `variables` in other expressions of the policy
- // except MatchConditions because MatchConditions are evaluated before the rest of the policy.
- //
- // The expression of a variable can refer to other variables defined earlier in the list but not those after.
- // Thus, Variables must be sorted by the order of first appearance and acyclic.
- // +patchMergeKey=name
- // +patchStrategy=merge
- // +listType=map
- // +listMapKey=name
- // +optional
- repeated Variable variables = 7;
- }
- // ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.
- message ValidatingAdmissionPolicyStatus {
- // The generation observed by the controller.
- // +optional
- optional int64 observedGeneration = 1;
- // The results of type checking for each expression.
- // Presence of this field indicates the completion of the type checking.
- // +optional
- optional TypeChecking typeChecking = 2;
- // The conditions represent the latest available observations of a policy's current state.
- // +optional
- // +listType=map
- // +listMapKey=type
- repeated k8s.io.apimachinery.pkg.apis.meta.v1.Condition conditions = 3;
- }
- // ValidatingWebhook describes an admission webhook and the resources and operations it applies to.
- message ValidatingWebhook {
- // The name of the admission webhook.
- // Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where
- // "imagepolicy" is the name of the webhook, and kubernetes.io is the name
- // of the organization.
- // Required.
- optional string name = 1;
- // ClientConfig defines how to communicate with the hook.
- // Required
- optional WebhookClientConfig clientConfig = 2;
- // Rules describes what operations on what resources/subresources the webhook cares about.
- // The webhook cares about an operation if it matches _any_ Rule.
- // However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks
- // from putting the cluster in a state which cannot be recovered from without completely
- // disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called
- // on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
- repeated k8s.io.api.admissionregistration.v1.RuleWithOperations rules = 3;
- // FailurePolicy defines how unrecognized errors from the admission endpoint are handled -
- // allowed values are Ignore or Fail. Defaults to Ignore.
- // +optional
- optional string failurePolicy = 4;
- // matchPolicy defines how the "rules" 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 webhook.
- //
- // - 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 webhook.
- //
- // Defaults to "Exact"
- // +optional
- optional string matchPolicy = 9;
- // NamespaceSelector decides whether to run the webhook 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 webhook.
- //
- // 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 webhook 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 5;
- // ObjectSelector decides whether to run the webhook based on if the
- // object has matching labels. objectSelector is evaluated against both
- // the oldObject and newObject that would be sent to the webhook, 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.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector objectSelector = 10;
- // SideEffects states whether this webhook has side effects.
- // Acceptable values are: Unknown, None, Some, NoneOnDryRun
- // Webhooks with side effects MUST implement a reconciliation system, since a request may be
- // rejected by a future step in the admission chain and the side effects therefore need to be undone.
- // Requests with the dryRun attribute will be auto-rejected if they match a webhook with
- // sideEffects == Unknown or Some. Defaults to Unknown.
- // +optional
- optional string sideEffects = 6;
- // TimeoutSeconds specifies the timeout for this webhook. After the timeout passes,
- // the webhook call will be ignored or the API call will fail based on the
- // failure policy.
- // The timeout value must be between 1 and 30 seconds.
- // Default to 30 seconds.
- // +optional
- optional int32 timeoutSeconds = 7;
- // AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`
- // versions the Webhook expects. API server will try to use first version in
- // the list which it supports. If none of the versions specified in this list
- // supported by API server, validation will fail for this object.
- // If a persisted webhook configuration specifies allowed versions and does not
- // include any versions known to the API Server, calls to the webhook will fail
- // and be subject to the failure policy.
- // Default to `['v1beta1']`.
- // +optional
- repeated string admissionReviewVersions = 8;
- // MatchConditions is a list of conditions that must be met for a request to be sent to this
- // webhook. Match conditions filter requests that have already been matched by the rules,
- // namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.
- // There are a maximum of 64 match conditions allowed.
- //
- // The exact matching logic is (in order):
- // 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
- // 2. If ALL matchConditions evaluate to TRUE, the webhook is called.
- // 3. If any matchCondition evaluates to an error (but none are FALSE):
- // - If failurePolicy=Fail, reject the request
- // - If failurePolicy=Ignore, the error is ignored and the webhook is skipped
- //
- // This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate.
- //
- // +patchMergeKey=name
- // +patchStrategy=merge
- // +listType=map
- // +listMapKey=name
- // +featureGate=AdmissionWebhookMatchConditions
- // +optional
- repeated MatchCondition matchConditions = 11;
- }
- // ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.
- // Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead.
- message ValidatingWebhookConfiguration {
- // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
- // Webhooks is a list of webhooks and the affected resources and operations.
- // +optional
- // +patchMergeKey=name
- // +patchStrategy=merge
- repeated ValidatingWebhook Webhooks = 2;
- }
- // ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.
- message ValidatingWebhookConfigurationList {
- // Standard list metadata.
- // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- // +optional
- optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
- // List of ValidatingWebhookConfiguration.
- repeated ValidatingWebhookConfiguration items = 2;
- }
- // Validation specifies the CEL expression which is used to apply the validation.
- message Validation {
- // Expression represents the expression which will be evaluated by CEL.
- // ref: https://github.com/google/cel-spec
- // CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
- //
- // - 'object' - The object from the incoming request. The value is null for DELETE requests.
- // - 'oldObject' - The existing object. The value is null for CREATE requests.
- // - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)).
- // - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind.
- // - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources.
- // - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
- // For example, a variable named 'foo' can be accessed as 'variables.foo'.
- // - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
- // See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- // - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
- // request resource.
- //
- // The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the
- // object. No other metadata properties are accessible.
- //
- // Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible.
- // Accessible property names are escaped according to the following rules when accessed in the expression:
- // - '__' escapes to '__underscores__'
- // - '.' escapes to '__dot__'
- // - '-' escapes to '__dash__'
- // - '/' escapes to '__slash__'
- // - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
- // "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
- // "import", "let", "loop", "package", "namespace", "return".
- // Examples:
- // - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"}
- // - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
- // - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
- //
- // Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1].
- // Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- // - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
- // non-intersecting elements in `Y` are appended, retaining their partial order.
- // - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
- // are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
- // non-intersecting keys are appended, retaining their partial order.
- // Required.
- optional string Expression = 1;
- // Message represents the message displayed when validation fails. The message is required if the Expression contains
- // line breaks. The message must not contain line breaks.
- // If unset, the message is "failed rule: {Rule}".
- // e.g. "must be a URL with the host matching spec.host"
- // If the Expression contains line breaks. Message is required.
- // The message must not contain line breaks.
- // If unset, the message is "failed Expression: {Expression}".
- // +optional
- optional string message = 2;
- // Reason represents a machine-readable description of why this validation failed.
- // If this is the first validation in the list to fail, this reason, as well as the
- // corresponding HTTP response code, are used in the
- // HTTP response to the client.
- // The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge".
- // If not set, StatusReasonInvalid is used in the response to the client.
- // +optional
- optional string reason = 3;
- // messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails.
- // Since messageExpression is used as a failure message, it must evaluate to a string.
- // If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails.
- // If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced
- // as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string
- // that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and
- // the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged.
- // messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'.
- // Example:
- // "object.x must be less than max ("+string(params.max)+")"
- // +optional
- optional string messageExpression = 4;
- }
- // Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.
- // +structType=atomic
- message Variable {
- // Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables.
- // The variable can be accessed in other expressions through `variables`
- // For example, if name is "foo", the variable will be available as `variables.foo`
- optional string Name = 1;
- // Expression is the expression that will be evaluated as the value of the variable.
- // The CEL expression has access to the same identifiers as the CEL expressions in Validation.
- optional string Expression = 2;
- }
- // WebhookClientConfig contains the information to make a TLS
- // connection with the webhook
- message WebhookClientConfig {
- // `url` gives the location of the webhook, in standard URL form
- // (`scheme://host:port/path`). Exactly one of `url` or `service`
- // must be specified.
- //
- // The `host` should not refer to a service running in the cluster; use
- // the `service` field instead. The host might be resolved via external
- // DNS in some apiservers (e.g., `kube-apiserver` cannot resolve
- // in-cluster DNS as that would be a layering violation). `host` may
- // also be an IP address.
- //
- // Please note that using `localhost` or `127.0.0.1` as a `host` is
- // risky unless you take great care to run this webhook on all hosts
- // which run an apiserver which might need to make calls to this
- // webhook. Such installs are likely to be non-portable, i.e., not easy
- // to turn up in a new cluster.
- //
- // The scheme must be "https"; the URL must begin with "https://".
- //
- // A path is optional, and if present may be any string permissible in
- // a URL. You may use the path to pass an arbitrary string to the
- // webhook, for example, a cluster identifier.
- //
- // Attempting to use a user or basic auth e.g. "user:password@" is not
- // allowed. Fragments ("#...") and query parameters ("?...") are not
- // allowed, either.
- //
- // +optional
- optional string url = 3;
- // `service` is a reference to the service for this webhook. Either
- // `service` or `url` must be specified.
- //
- // If the webhook is running within the cluster, then you should use `service`.
- //
- // +optional
- optional ServiceReference service = 1;
- // `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.
- // If unspecified, system trust roots on the apiserver are used.
- // +optional
- optional bytes caBundle = 2;
- }
|