Skip to content

getambassador.v2.mapping

"Mapping is the Schema for the mappings API"

Index

Fields

fn new

new(name)

new returns an instance of Mapping

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

"MappingSpec defines the desired state of Mapping"

fn spec.withAdd_linkerd_headers

withAdd_linkerd_headers(add_linkerd_headers)

fn spec.withAdd_request_headers

withAdd_request_headers(add_request_headers)

fn spec.withAdd_request_headersMixin

withAdd_request_headersMixin(add_request_headers)

Note: This function appends passed data to existing values

fn spec.withAdd_response_headers

withAdd_response_headers(add_response_headers)

fn spec.withAdd_response_headersMixin

withAdd_response_headersMixin(add_response_headers)

Note: This function appends passed data to existing values

fn spec.withAllow_upgrade

withAllow_upgrade(allow_upgrade)

"A case-insensitive list of the non-HTTP protocols to allow \"upgrading\" to from HTTP via the \"Connection: upgrade\" mechanism[1]. After the upgrade, Ambassador does not interpret the traffic, and behaves similarly to how it does for TCPMappings. \n [1]: https://tools.ietf.org/html/rfc7230#section-6.7 \n For example, if your upstream service supports WebSockets, you would write \n allow_upgrade: - websocket \n Or if your upstream service supports upgrading from HTTP to SPDY (as the Kubernetes apiserver does for kubectl exec functionality), you would write \n allow_upgrade: - spdy/3.1"

fn spec.withAllow_upgradeMixin

withAllow_upgradeMixin(allow_upgrade)

"A case-insensitive list of the non-HTTP protocols to allow \"upgrading\" to from HTTP via the \"Connection: upgrade\" mechanism[1]. After the upgrade, Ambassador does not interpret the traffic, and behaves similarly to how it does for TCPMappings. \n [1]: https://tools.ietf.org/html/rfc7230#section-6.7 \n For example, if your upstream service supports WebSockets, you would write \n allow_upgrade: - websocket \n Or if your upstream service supports upgrading from HTTP to SPDY (as the Kubernetes apiserver does for kubectl exec functionality), you would write \n allow_upgrade: - spdy/3.1"

Note: This function appends passed data to existing values

fn spec.withAuth_context_extensions

withAuth_context_extensions(auth_context_extensions)

fn spec.withAuth_context_extensionsMixin

withAuth_context_extensionsMixin(auth_context_extensions)

Note: This function appends passed data to existing values

fn spec.withAuto_host_rewrite

withAuto_host_rewrite(auto_host_rewrite)

fn spec.withBypass_auth

withBypass_auth(bypass_auth)

fn spec.withBypass_error_response_overrides

withBypass_error_response_overrides(bypass_error_response_overrides)

"If true, bypasses any error_response_overrides set on the Ambassador module."

fn spec.withCase_sensitive

withCase_sensitive(case_sensitive)

fn spec.withCircuit_breakers

withCircuit_breakers(circuit_breakers)

fn spec.withCircuit_breakersMixin

withCircuit_breakersMixin(circuit_breakers)

Note: This function appends passed data to existing values

fn spec.withCluster_idle_timeout_ms

withCluster_idle_timeout_ms(cluster_idle_timeout_ms)

fn spec.withCluster_max_connection_lifetime_ms

withCluster_max_connection_lifetime_ms(cluster_max_connection_lifetime_ms)

fn spec.withCluster_tag

withCluster_tag(cluster_tag)

fn spec.withConnect_timeout_ms

withConnect_timeout_ms(connect_timeout_ms)

fn spec.withDns_type

withDns_type(dns_type)

fn spec.withEnable_ipv4

withEnable_ipv4(enable_ipv4)

fn spec.withEnable_ipv6

withEnable_ipv6(enable_ipv6)

fn spec.withEnvoy_override

withEnvoy_override(envoy_override)

fn spec.withEnvoy_overrideMixin

withEnvoy_overrideMixin(envoy_override)

Note: This function appends passed data to existing values

fn spec.withError_response_overrides

withError_response_overrides(error_response_overrides)

"Error response overrides for this Mapping. Replaces all of the error_response_overrides set on the Ambassador module, if any."

fn spec.withError_response_overridesMixin

withError_response_overridesMixin(error_response_overrides)

"Error response overrides for this Mapping. Replaces all of the error_response_overrides set on the Ambassador module, if any."

Note: This function appends passed data to existing values

fn spec.withGrpc

withGrpc(grpc)

fn spec.withHeaders

withHeaders(headers)

fn spec.withHeadersMixin

withHeadersMixin(headers)

Note: This function appends passed data to existing values

fn spec.withHost

withHost(host)

fn spec.withHost_redirect

withHost_redirect(host_redirect)

fn spec.withHost_regex

withHost_regex(host_regex)

fn spec.withHost_rewrite

withHost_rewrite(host_rewrite)

fn spec.withIdle_timeout_ms

withIdle_timeout_ms(idle_timeout_ms)

fn spec.withLabels

withLabels(labels)

"A DomainMap is the overall Mapping.spec.Labels type. It maps domains (kind of like namespaces for Mapping labels) to arrays of label groups."

fn spec.withLabelsMixin

withLabelsMixin(labels)

"A DomainMap is the overall Mapping.spec.Labels type. It maps domains (kind of like namespaces for Mapping labels) to arrays of label groups."

Note: This function appends passed data to existing values

fn spec.withMethod

withMethod(method)

fn spec.withMethod_regex

withMethod_regex(method_regex)

fn spec.withModules

withModules(modules)

fn spec.withModulesMixin

withModulesMixin(modules)

Note: This function appends passed data to existing values

fn spec.withOutlier_detection

withOutlier_detection(outlier_detection)

fn spec.withPath_redirect

withPath_redirect(path_redirect)

"Path replacement to use when generating an HTTP redirect. Used with host_redirect."

fn spec.withPrecedence

withPrecedence(precedence)

fn spec.withPrefix

withPrefix(prefix)

fn spec.withPrefix_exact

withPrefix_exact(prefix_exact)

fn spec.withPrefix_redirect

withPrefix_redirect(prefix_redirect)

"Prefix rewrite to use when generating an HTTP redirect. Used with host_redirect."

fn spec.withPrefix_regex

withPrefix_regex(prefix_regex)

fn spec.withPriority

withPriority(priority)

fn spec.withQuery_parameters

withQuery_parameters(query_parameters)

fn spec.withQuery_parametersMixin

withQuery_parametersMixin(query_parameters)

Note: This function appends passed data to existing values

fn spec.withRedirect_response_code

withRedirect_response_code(redirect_response_code)

"The response code to use when generating an HTTP redirect. Defaults to 301. Used with host_redirect."

fn spec.withRegex_headers

withRegex_headers(regex_headers)

fn spec.withRegex_headersMixin

withRegex_headersMixin(regex_headers)

Note: This function appends passed data to existing values

fn spec.withRegex_query_parameters

withRegex_query_parameters(regex_query_parameters)

fn spec.withRegex_query_parametersMixin

withRegex_query_parametersMixin(regex_query_parameters)

Note: This function appends passed data to existing values

fn spec.withResolver

withResolver(resolver)

fn spec.withRespect_dns_ttl

withRespect_dns_ttl(respect_dns_ttl)

fn spec.withRewrite

withRewrite(rewrite)

fn spec.withService

withService(service)

fn spec.withShadow

withShadow(shadow)

fn spec.withTimeout_ms

withTimeout_ms(timeout_ms)

"The timeout for requests that use this Mapping. Overrides cluster_request_timeout_ms set on the Ambassador Module, if it exists."

fn spec.withUse_websocket

withUse_websocket(use_websocket)

"use_websocket is deprecated, and is equivlaent to setting allow_upgrade: [\"websocket\"]"

fn spec.withV3StatsName

withV3StatsName(v3StatsName)

fn spec.withV3health_checks

withV3health_checks(v3health_checks)

fn spec.withV3health_checksMixin

withV3health_checksMixin(v3health_checks)

Note: This function appends passed data to existing values

fn spec.withWeight

withWeight(weight)

obj spec.circuit_breakers

fn spec.circuit_breakers.withMax_connections

withMax_connections(max_connections)

fn spec.circuit_breakers.withMax_pending_requests

withMax_pending_requests(max_pending_requests)

fn spec.circuit_breakers.withMax_requests

withMax_requests(max_requests)

fn spec.circuit_breakers.withMax_retries

withMax_retries(max_retries)

fn spec.circuit_breakers.withPriority

withPriority(priority)

obj spec.cors

fn spec.cors.withCredentials

withCredentials(credentials)

fn spec.cors.withMax_age

withMax_age(max_age)

obj spec.docs

"DocsInfo provides some extra information about the docs for the Mapping (used by the Dev Portal)"

fn spec.docs.withDisplay_name

withDisplay_name(display_name)

fn spec.docs.withIgnored

withIgnored(ignored)

fn spec.docs.withPath

withPath(path)

fn spec.docs.withTimeout_ms

withTimeout_ms(timeout_ms)

fn spec.docs.withUrl

withUrl(url)

obj spec.error_response_overrides

"Error response overrides for this Mapping. Replaces all of the error_response_overrides set on the Ambassador module, if any."

fn spec.error_response_overrides.withOn_status_code

withOn_status_code(on_status_code)

"The status code to match on -- not a pointer because it's required."

obj spec.error_response_overrides.body

"The new response body"

fn spec.error_response_overrides.body.withContent_type

withContent_type(content_type)

"The content type to set on the error response body when using text_format or text_format_source. Defaults to 'text/plain'."

fn spec.error_response_overrides.body.withJson_format

withJson_format(json_format)

"A JSON response with content-type: application/json. The values can contain format text like in text_format."

fn spec.error_response_overrides.body.withJson_formatMixin

withJson_formatMixin(json_format)

"A JSON response with content-type: application/json. The values can contain format text like in text_format."

Note: This function appends passed data to existing values

fn spec.error_response_overrides.body.withText_format

withText_format(text_format)

"A format string representing a text response body. Content-Type can be set using the content_type field below."

obj spec.error_response_overrides.body.text_format_source

"A format string sourced from a file on the Ambassador container. Useful for larger response bodies that should not be placed inline in configuration."

fn spec.error_response_overrides.body.text_format_source.withFilename

withFilename(filename)

"The name of a file on the Ambassador pod that contains a format text string."

obj spec.keepalive

fn spec.keepalive.withIdle_time

withIdle_time(idle_time)

fn spec.keepalive.withInterval

withInterval(interval)

fn spec.keepalive.withProbes

withProbes(probes)

obj spec.load_balancer

fn spec.load_balancer.withHeader

withHeader(header)

fn spec.load_balancer.withPolicy

withPolicy(policy)

fn spec.load_balancer.withSource_ip

withSource_ip(source_ip)

obj spec.load_balancer.cookie

fn spec.load_balancer.cookie.withName

withName(name)

fn spec.load_balancer.cookie.withPath

withPath(path)

fn spec.load_balancer.cookie.withTtl

withTtl(ttl)

obj spec.regex_redirect

"Prefix regex rewrite to use when generating an HTTP redirect. Used with host_redirect."

fn spec.regex_redirect.withPattern

withPattern(pattern)

fn spec.regex_redirect.withSubstitution

withSubstitution(substitution)

obj spec.regex_rewrite

fn spec.regex_rewrite.withPattern

withPattern(pattern)

fn spec.regex_rewrite.withSubstitution

withSubstitution(substitution)

obj spec.retry_policy

fn spec.retry_policy.withNum_retries

withNum_retries(num_retries)

fn spec.retry_policy.withPer_try_timeout

withPer_try_timeout(per_try_timeout)

fn spec.retry_policy.withRetry_on

withRetry_on(retry_on)

obj spec.v3health_checks

fn spec.v3health_checks.withHealthy_threshold

withHealthy_threshold(healthy_threshold)

"Number of expected responses for the upstream to be considered healthy. Defaults to 1."

fn spec.v3health_checks.withInterval

withInterval(interval)

"Interval between health checks. Defaults to every 5 seconds."

fn spec.v3health_checks.withTimeout

withTimeout(timeout)

"Timeout for connecting to the health checking endpoint. Defaults to 3 seconds."

fn spec.v3health_checks.withUnhealthy_threshold

withUnhealthy_threshold(unhealthy_threshold)

"Number of non-expected responses for the upstream to be considered unhealthy. A single 503 will mark the upstream as unhealthy regardless of the threshold. Defaults to 2."

obj spec.v3health_checks.health_check

"Configuration for where the healthcheck request should be made to"

obj spec.v3health_checks.health_check.grpc

"HealthCheck for gRPC upstreams. Only one of grpc_health_check or http_health_check may be specified"

fn spec.v3health_checks.health_check.grpc.withAuthority

withAuthority(authority)

"The value of the :authority header in the gRPC health check request. If left empty the upstream name will be used."

fn spec.v3health_checks.health_check.grpc.withUpstream_name

withUpstream_name(upstream_name)

"The upstream name parameter which will be sent to gRPC service in the health check message"

obj spec.v3health_checks.health_check.http

"HealthCheck for HTTP upstreams. Only one of http_health_check or grpc_health_check may be specified"

fn spec.v3health_checks.health_check.http.withAdd_request_headers

withAdd_request_headers(add_request_headers)

fn spec.v3health_checks.health_check.http.withAdd_request_headersMixin

withAdd_request_headersMixin(add_request_headers)

Note: This function appends passed data to existing values

fn spec.v3health_checks.health_check.http.withExpected_statuses

withExpected_statuses(expected_statuses)

fn spec.v3health_checks.health_check.http.withExpected_statusesMixin

withExpected_statusesMixin(expected_statuses)

Note: This function appends passed data to existing values

fn spec.v3health_checks.health_check.http.withHostname

withHostname(hostname)

fn spec.v3health_checks.health_check.http.withPath

withPath(path)

fn spec.v3health_checks.health_check.http.withRemove_request_headers

withRemove_request_headers(remove_request_headers)

fn spec.v3health_checks.health_check.http.withRemove_request_headersMixin

withRemove_request_headersMixin(remove_request_headers)

Note: This function appends passed data to existing values

obj spec.v3health_checks.health_check.http.expected_statuses

fn spec.v3health_checks.health_check.http.expected_statuses.withMax

withMax(max)

"End of the statuses to include. Must be between 100 and 599 (inclusive)"

fn spec.v3health_checks.health_check.http.expected_statuses.withMin

withMin(min)

"Start of the statuses to include. Must be between 100 and 599 (inclusive)"