Skip to content

kyverno.v2.updateRequest

"UpdateRequest is a request to process mutate and generate rules in background."

Index

Fields

fn new

new(name)

new returns an instance of UpdateRequest

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ResourceSpec is the information to identify the trigger resource."

fn spec.withDeleteDownstream

withDeleteDownstream(deleteDownstream)

"DeleteDownstream represents whether the downstream needs to be deleted."

fn spec.withPolicy

withPolicy(policy)

"Specifies the name of the policy."

fn spec.withRequestType

withRequestType(requestType)

"Type represents request type for background processing"

fn spec.withRule

withRule(rule)

"Rule is the associate rule name of the current UR."

fn spec.withSynchronize

withSynchronize(synchronize)

"Synchronize represents the sync behavior of the corresponding rule Optional. Defaults to \"false\" if not specified."

obj spec.context

"Context ..."

obj spec.context.admissionRequestInfo

"AdmissionRequestInfoObject stores the admission request and operation details"

fn spec.context.admissionRequestInfo.withOperation

withOperation(operation)

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

obj spec.context.admissionRequestInfo.admissionRequest

"AdmissionRequest describes the admission.Attributes for the admission request."

fn spec.context.admissionRequestInfo.admissionRequest.withDryRun

withDryRun(dryRun)

"DryRun indicates that modifications will definitely not be persisted for this request. Defaults to false."

fn spec.context.admissionRequestInfo.admissionRequest.withName

withName(name)

"Name is 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 field will contain an empty string."

fn spec.context.admissionRequestInfo.admissionRequest.withNamespace

withNamespace(namespace)

"Namespace is the namespace associated with the request (if any)."

fn spec.context.admissionRequestInfo.admissionRequest.withObject

withObject(object)

"Object is the object from the incoming request."

fn spec.context.admissionRequestInfo.admissionRequest.withObjectMixin

withObjectMixin(object)

"Object is the object from the incoming request."

Note: This function appends passed data to existing values

fn spec.context.admissionRequestInfo.admissionRequest.withOldObject

withOldObject(oldObject)

"OldObject is the existing object. Only populated for DELETE and UPDATE requests."

fn spec.context.admissionRequestInfo.admissionRequest.withOldObjectMixin

withOldObjectMixin(oldObject)

"OldObject is the existing object. Only populated for DELETE and UPDATE requests."

Note: This function appends passed data to existing values

fn spec.context.admissionRequestInfo.admissionRequest.withOperation

withOperation(operation)

"Operation is the operation being performed. This may be different than the operation requested. e.g. a patch can result in either a CREATE or UPDATE Operation."

fn spec.context.admissionRequestInfo.admissionRequest.withOptions

withOptions(options)

"Options is the operation option structure of the operation being performed. e.g. meta.k8s.io/v1.DeleteOptions or meta.k8s.io/v1.CreateOptions. This may be different than the options the caller provided. e.g. for a patch request the performed Operation might be a CREATE, in which case the Options will a meta.k8s.io/v1.CreateOptions even though the caller provided meta.k8s.io/v1.PatchOptions."

fn spec.context.admissionRequestInfo.admissionRequest.withOptionsMixin

withOptionsMixin(options)

"Options is the operation option structure of the operation being performed. e.g. meta.k8s.io/v1.DeleteOptions or meta.k8s.io/v1.CreateOptions. This may be different than the options the caller provided. e.g. for a patch request the performed Operation might be a CREATE, in which case the Options will a meta.k8s.io/v1.CreateOptions even though the caller provided meta.k8s.io/v1.PatchOptions."

Note: This function appends passed data to existing values

fn spec.context.admissionRequestInfo.admissionRequest.withRequestSubResource

withRequestSubResource(requestSubResource)

"RequestSubResource is the name of the subresource of the original API request, if any (for example, \"status\" or \"scale\") If this is specified and differs from the value in \"subResource\", an equivalent match and conversion was performed. See documentation for the \"matchPolicy\" field in the webhook configuration type."

fn spec.context.admissionRequestInfo.admissionRequest.withSubResource

withSubResource(subResource)

"SubResource is the subresource being requested, if any (for example, \"status\" or \"scale\")"

fn spec.context.admissionRequestInfo.admissionRequest.withUid

withUid(uid)

"UID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are otherwise identical (parallel requests, requests when earlier requests did not modify etc) The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request. It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging."

obj spec.context.admissionRequestInfo.admissionRequest.kind

"Kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)"

fn spec.context.admissionRequestInfo.admissionRequest.kind.withGroup

withGroup(group)

fn spec.context.admissionRequestInfo.admissionRequest.kind.withKind

withKind(kind)

fn spec.context.admissionRequestInfo.admissionRequest.kind.withVersion

withVersion(version)

obj spec.context.admissionRequestInfo.admissionRequest.requestKind

"RequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale). If this is specified and differs from the value in \"kind\", an equivalent match and conversion was performed. \n For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"] and matchPolicy: Equivalent, an API request to apps/v1beta1 deployments would be converted and sent to the webhook with kind: {group:\"apps\", version:\"v1\", kind:\"Deployment\"} (matching the rule the webhook registered for), and requestKind: {group:\"apps\", version:\"v1beta1\", kind:\"Deployment\"} (indicating the kind of the original API request). \n See documentation for the \"matchPolicy\" field in the webhook configuration type for more details."

fn spec.context.admissionRequestInfo.admissionRequest.requestKind.withGroup

withGroup(group)

fn spec.context.admissionRequestInfo.admissionRequest.requestKind.withKind

withKind(kind)

fn spec.context.admissionRequestInfo.admissionRequest.requestKind.withVersion

withVersion(version)

obj spec.context.admissionRequestInfo.admissionRequest.requestResource

"RequestResource is the fully-qualified resource of the original API request (for example, v1.pods). If this is specified and differs from the value in \"resource\", an equivalent match and conversion was performed. \n For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of apiGroups:[\"apps\"], apiVersions:[\"v1\"], resources: [\"deployments\"] and matchPolicy: Equivalent, an API request to apps/v1beta1 deployments would be converted and sent to the webhook with resource: {group:\"apps\", version:\"v1\", resource:\"deployments\"} (matching the resource the webhook registered for), and requestResource: {group:\"apps\", version:\"v1beta1\", resource:\"deployments\"} (indicating the resource of the original API request). \n See documentation for the \"matchPolicy\" field in the webhook configuration type."

fn spec.context.admissionRequestInfo.admissionRequest.requestResource.withGroup

withGroup(group)

fn spec.context.admissionRequestInfo.admissionRequest.requestResource.withResource

withResource(resource)

fn spec.context.admissionRequestInfo.admissionRequest.requestResource.withVersion

withVersion(version)

obj spec.context.admissionRequestInfo.admissionRequest.resource

"Resource is the fully-qualified resource being requested (for example, v1.pods)"

fn spec.context.admissionRequestInfo.admissionRequest.resource.withGroup

withGroup(group)

fn spec.context.admissionRequestInfo.admissionRequest.resource.withResource

withResource(resource)

fn spec.context.admissionRequestInfo.admissionRequest.resource.withVersion

withVersion(version)

obj spec.context.admissionRequestInfo.admissionRequest.userInfo

"UserInfo is information about the requesting user"

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withExtra

withExtra(extra)

"Any additional information provided by the authenticator."

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withExtraMixin

withExtraMixin(extra)

"Any additional information provided by the authenticator."

Note: This function appends passed data to existing values

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withGroups

withGroups(groups)

"The names of groups this user is a part of."

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withGroupsMixin

withGroupsMixin(groups)

"The names of groups this user is a part of."

Note: This function appends passed data to existing values

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withUid

withUid(uid)

"A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs."

fn spec.context.admissionRequestInfo.admissionRequest.userInfo.withUsername

withUsername(username)

"The name that uniquely identifies this user among all active users."

obj spec.context.userInfo

"RequestInfo contains permission info carried in an admission request."

fn spec.context.userInfo.withClusterRoles

withClusterRoles(clusterRoles)

"ClusterRoles is a list of possible clusterRoles send the request."

fn spec.context.userInfo.withClusterRolesMixin

withClusterRolesMixin(clusterRoles)

"ClusterRoles is a list of possible clusterRoles send the request."

Note: This function appends passed data to existing values

fn spec.context.userInfo.withRoles

withRoles(roles)

"Roles is a list of possible role send the request."

fn spec.context.userInfo.withRolesMixin

withRolesMixin(roles)

"Roles is a list of possible role send the request."

Note: This function appends passed data to existing values

obj spec.context.userInfo.userInfo

"UserInfo is the userInfo carried in the admission request."

fn spec.context.userInfo.userInfo.withExtra

withExtra(extra)

"Any additional information provided by the authenticator."

fn spec.context.userInfo.userInfo.withExtraMixin

withExtraMixin(extra)

"Any additional information provided by the authenticator."

Note: This function appends passed data to existing values

fn spec.context.userInfo.userInfo.withGroups

withGroups(groups)

"The names of groups this user is a part of."

fn spec.context.userInfo.userInfo.withGroupsMixin

withGroupsMixin(groups)

"The names of groups this user is a part of."

Note: This function appends passed data to existing values

fn spec.context.userInfo.userInfo.withUid

withUid(uid)

"A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs."

fn spec.context.userInfo.userInfo.withUsername

withUsername(username)

"The name that uniquely identifies this user among all active users."

obj spec.resource

"ResourceSpec is the information to identify the trigger resource."

fn spec.resource.withApiVersion

withApiVersion(apiVersion)

"APIVersion specifies resource apiVersion."

fn spec.resource.withKind

withKind(kind)

"Kind specifies resource kind."

fn spec.resource.withName

withName(name)

"Name specifies the resource name."

fn spec.resource.withNamespace

withNamespace(namespace)

"Namespace specifies resource namespace."

fn spec.resource.withUid

withUid(uid)

"UID specifies the resource uid."