Skip to content

networking.v1alpha3.envoyFilter

Index

Fields

fn new

new(name)

new returns an instance of EnvoyFilter

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

"Customizing Envoy configuration generated by Istio. See more details at: https://istio.io/docs/reference/config/networking/envoy-filter.html"

fn spec.withConfigPatches

withConfigPatches(configPatches)

"One or more patches with match conditions."

fn spec.withConfigPatchesMixin

withConfigPatchesMixin(configPatches)

"One or more patches with match conditions."

Note: This function appends passed data to existing values

fn spec.withPriority

withPriority(priority)

"Priority defines the order in which patch sets are applied within a context."

fn spec.withTargetRefs

withTargetRefs(targetRefs)

"Optional."

fn spec.withTargetRefsMixin

withTargetRefsMixin(targetRefs)

"Optional."

Note: This function appends passed data to existing values

obj spec.configPatches

"One or more patches with match conditions."

fn spec.configPatches.withApplyTo

withApplyTo(applyTo)

"Specifies where in the Envoy configuration, the patch should be applied.\n\nValid Options: LISTENER, FILTER_CHAIN, NETWORK_FILTER, HTTP_FILTER, ROUTE_CONFIGURATION, VIRTUAL_HOST, HTTP_ROUTE, CLUSTER, EXTENSION_CONFIG, BOOTSTRAP, LISTENER_FILTER"

obj spec.configPatches.match

"Match on listener/route configuration/cluster."

fn spec.configPatches.match.withContext

withContext(context)

"The specific config generation context to match on.\n\nValid Options: ANY, SIDECAR_INBOUND, SIDECAR_OUTBOUND, GATEWAY"

obj spec.configPatches.match.cluster

"Match on envoy cluster attributes."

fn spec.configPatches.match.cluster.withName

withName(name)

"The exact name of the cluster to match."

fn spec.configPatches.match.cluster.withPortNumber

withPortNumber(portNumber)

"The service port for which this cluster was generated."

fn spec.configPatches.match.cluster.withService

withService(service)

"The fully qualified service name for this cluster."

fn spec.configPatches.match.cluster.withSubset

withSubset(subset)

"The subset associated with the service."

obj spec.configPatches.match.listener

"Match on envoy listener attributes."

fn spec.configPatches.match.listener.withListenerFilter

withListenerFilter(listenerFilter)

"Match a specific listener filter."

fn spec.configPatches.match.listener.withName

withName(name)

"Match a specific listener by its name."

fn spec.configPatches.match.listener.withPortName

withPortName(portName)

fn spec.configPatches.match.listener.withPortNumber

withPortNumber(portNumber)

"The service port/gateway port to which traffic is being sent/received."

obj spec.configPatches.match.listener.filterChain

"Match a specific filter chain in a listener."

fn spec.configPatches.match.listener.filterChain.withApplicationProtocols

withApplicationProtocols(applicationProtocols)

"Applies only to sidecars."

fn spec.configPatches.match.listener.filterChain.withDestinationPort

withDestinationPort(destinationPort)

"The destination_port value used by a filter chain's match condition."

fn spec.configPatches.match.listener.filterChain.withName

withName(name)

"The name assigned to the filter chain."

fn spec.configPatches.match.listener.filterChain.withSni

withSni(sni)

"The SNI value used by a filter chain's match condition."

fn spec.configPatches.match.listener.filterChain.withTransportProtocol

withTransportProtocol(transportProtocol)

"Applies only to SIDECAR_INBOUND context."

obj spec.configPatches.match.listener.filterChain.filter

"The name of a specific filter to apply the patch to."

fn spec.configPatches.match.listener.filterChain.filter.withName

withName(name)

"The filter name to match on."

obj spec.configPatches.match.listener.filterChain.filter.subFilter

"The next level filter within this filter to match upon."

fn spec.configPatches.match.listener.filterChain.filter.subFilter.withName

withName(name)

"The filter name to match on."

obj spec.configPatches.match.proxy

"Match on properties associated with a proxy."

fn spec.configPatches.match.proxy.withMetadata

withMetadata(metadata)

"Match on the node metadata supplied by a proxy when connecting to Istio Pilot."

fn spec.configPatches.match.proxy.withMetadataMixin

withMetadataMixin(metadata)

"Match on the node metadata supplied by a proxy when connecting to Istio Pilot."

Note: This function appends passed data to existing values

fn spec.configPatches.match.proxy.withProxyVersion

withProxyVersion(proxyVersion)

"A regular expression in golang regex format (RE2) that can be used to select proxies using a specific version of istio proxy."

obj spec.configPatches.match.routeConfiguration

"Match on envoy HTTP route configuration attributes."

fn spec.configPatches.match.routeConfiguration.withGateway

withGateway(gateway)

"The Istio gateway config's namespace/name for which this route configuration was generated."

fn spec.configPatches.match.routeConfiguration.withName

withName(name)

"Route configuration name to match on."

fn spec.configPatches.match.routeConfiguration.withPortName

withPortName(portName)

"Applicable only for GATEWAY context."

fn spec.configPatches.match.routeConfiguration.withPortNumber

withPortNumber(portNumber)

"The service port number or gateway server port number for which this route configuration was generated."

obj spec.configPatches.match.routeConfiguration.vhost

"Match a specific virtual host in a route configuration and apply the patch to the virtual host."

fn spec.configPatches.match.routeConfiguration.vhost.withName

withName(name)

"The VirtualHosts objects generated by Istio are named as host:port, where the host typically corresponds to the VirtualService's host field or the hostname of a service in the registry."

obj spec.configPatches.match.routeConfiguration.vhost.route

"Match a specific route within the virtual host."

fn spec.configPatches.match.routeConfiguration.vhost.route.withAction

withAction(action)

"Match a route with specific action type.\n\nValid Options: ANY, ROUTE, REDIRECT, DIRECT_RESPONSE"

fn spec.configPatches.match.routeConfiguration.vhost.route.withName

withName(name)

"The Route objects generated by default are named as default."

obj spec.configPatches.patch

"The patch to apply along with the operation."

fn spec.configPatches.patch.withFilterClass

withFilterClass(filterClass)

"Determines the filter insertion order.\n\nValid Options: AUTHN, AUTHZ, STATS"

fn spec.configPatches.patch.withOperation

withOperation(operation)

"Determines how the patch should be applied.\n\nValid Options: MERGE, ADD, REMOVE, INSERT_BEFORE, INSERT_AFTER, INSERT_FIRST, REPLACE"

fn spec.configPatches.patch.withValue

withValue(value)

"The JSON config of the object being patched."

fn spec.configPatches.patch.withValueMixin

withValueMixin(value)

"The JSON config of the object being patched."

Note: This function appends passed data to existing values

obj spec.targetRefs

"Optional."

fn spec.targetRefs.withGroup

withGroup(group)

"group is the group of the target resource."

fn spec.targetRefs.withKind

withKind(kind)

"kind is kind of the target resource."

fn spec.targetRefs.withName

withName(name)

"name is the name of the target resource."

fn spec.targetRefs.withNamespace

withNamespace(namespace)

"namespace is the namespace of the referent."

obj spec.workloadSelector

"Criteria used to select the specific set of pods/VMs on which this patch configuration should be applied."

fn spec.workloadSelector.withLabels

withLabels(labels)

"One or more labels that indicate a specific set of pods/VMs on which the configuration should be applied."

fn spec.workloadSelector.withLabelsMixin

withLabelsMixin(labels)

"One or more labels that indicate a specific set of pods/VMs on which the configuration should be applied."

Note: This function appends passed data to existing values