Mixer Client

    APIKey defines the explicit configuration for generating the attribute from HTTP requests.

    See API Keys for a general overview of API keys as defined by OpenAPI.

    AttributeMatch

    Specifies a match clause to match Istio attributes

    FieldTypeDescriptionRequired
    clausemap<string, StringMatch>

    Map of attribute names to StringMatch type. Each map element specifies one condition to match.

    Example:

    clause: source.uid: exact: SOURCEUID request.httpmethod: exact: POST

    No

    HTTPAPISpec

    HTTPAPISpec defines the canonical configuration for generating API-related attributes from HTTP requests based on the method and uri templated path matches. It is sufficient for defining the API surface of a service for the purposes of API attribute generation. It is not intended to represent auth, quota, documentation, or other information commonly found in other API specifications, e.g. OpenAPI.

    Existing standards that define operations (or methods) in terms of HTTP methods and paths can be normalized to this format for use in Istio. For example, a simple petstore API described by OpenAPIv2 here can be represented with the following HTTPAPISpec.

    FieldTypeDescriptionRequired
    attributes

    List of attributes that are generated when any of the HTTP patterns match. This list typically includes the “api.service” and “api.version” attributes.

    No
    patternsHTTPAPISpecPattern[]

    List of HTTP patterns to match.

    No
    apiKeys

    List of APIKey that describes how to extract an API-KEY from an HTTP request. The first API-Key match found in the list is used, i.e. ‘OR’ semantics.

    The following default policies are used to generate the request.api_key attribute if no explicit APIKey is defined.

    1. query: key,query: api_key, and thenheader: x-api-key`
    No

    HTTPAPISpecBinding

    HTTPAPISpecBinding defines the binding between HTTPAPISpecs and one or more IstioService. For example, the following establishes a binding between the HTTPAPISpec petstore and service foo in namespace bar.

    1. apiVersion: config.istio.io/v1alpha2
    2. kind: HTTPAPISpecBinding
    3. metadata:
    4. name: my-binding
    5. namespace: default
    6. spec:
    7. - name: foo
    8. namespace: bar
    9. apiSpecs:
    10. - name: petstore
    11. namespace: default
    FieldTypeDescriptionRequired
    services

    One or more services to map the listed HTTPAPISpec onto.

    Yes
    apiSpecsHTTPAPISpecReference[]

    One or more HTTPAPISpec references that should be mapped to the specified service(s). The aggregate collection of match conditions defined in the HTTPAPISpecs should not overlap.

    Yes

    HTTPAPISpecPattern

    HTTPAPISpecPattern defines a single pattern to match against incoming HTTP requests. The per-pattern list of attributes is generated if both the httpmethod and uritemplate match. In addition, the top-level list of attributes in the HTTPAPISpec is also generated.

    FieldTypeDescriptionRequired
    attributesAttributes

    List of attributes that are generated if the HTTP request matches the specified httpmethod and uritemplate. This typically includes the “api.operation” attribute.

    No
    httpMethodstring

    HTTP request method to match against as defined by . For example: GET, HEAD, POST, PUT, DELETE.

    No
    uriTemplatestring (oneof)

    URI template to match against as defined by rfc6570. For example, the following are valid URI templates:

    1. /pets
    2. /pets/{id}
    3. /dictionary/{term:1}/{term}
    4. /search{?q,lang}
    Yes
    regex

    EXPERIMENTAL:

    ecmascript style regex-based match as defined by . For example,

    1. “^/pets/(.?)?”
    Yes

    HTTPAPISpecReference

    HTTPAPISpecReference defines a reference to an HTTPAPISpec. This is typically used for establishing bindings between an HTTPAPISpec and an IstioService. For example, the following defines an HTTPAPISpecReference for service foo in namespace bar.

    FieldTypeDescriptionRequired
    namestring

    The short name of the HTTPAPISpec. This is the resource name defined by the metadata name field.

    Yes
    namespacestring

    Optional namespace of the HTTPAPISpec. Defaults to the encompassing HTTPAPISpecBinding’s metadata namespace field.

    No

    Defines the client config for HTTP.

    IstioService

    IstioService identifies a service and optionally service version. The FQDN of the service is composed from the name, namespace, and implementation-specific domain suffix (e.g. on Kubernetes, “reviews” + “default” + “svc.cluster.local” -> “reviews.default.svc.cluster.local”).

    FieldTypeDescriptionRequired
    namestring

    The short name of the service such as “foo”.

    No
    namespacestring

    Optional namespace of the service. Defaults to value of metadata namespace field.

    No
    domainstring

    Domain suffix used to construct the service FQDN in implementations that support such specification.

    No
    servicestring

    The service FQDN.

    No
    labelsmap<string, string>

    Optional one or more labels that uniquely identify the service version.

    Note: When used for a VirtualService destination, labels MUST be empty.

    No

    NetworkFailPolicy

    Specifies the behavior when the client is unable to connect to Mixer.

    FieldTypeDescriptionRequired
    policy

    Specifies the behavior when the client is unable to connect to Mixer.

    No
    maxRetryuint32

    Max retries on transport error.

    No
    baseRetryWaitDuration

    Base time to wait between retries. Will be adjusted by exponential backoff and jitter.

    No
    maxRetryWait

    Max time to wait between retries.

    No

    NetworkFailPolicy.FailPolicy

    Describes the policy.

    NameDescription
    FAIL_OPEN

    If network connection fails, request is allowed and delivered to the service.

    FAIL_CLOSE

    If network connection fails, request is rejected.

    Quota

    Specifies a quota to use with quota name and amount.

    FieldTypeDescriptionRequired
    quotastring

    The quota name to charge

    No
    chargeint32

    The quota amount to charge

    No

    QuotaRule

    Specifies a rule with list of matches and list of quotas. If any clause matched, the list of quotas will be used.

    FieldTypeDescriptionRequired
    match

    If empty, match all request. If any of match is true, it is matched.

    No
    quotasQuota[]

    The list of quotas to charge.

    No

    Determines the quotas used for individual requests.

    QuotaSpecBinding

    QuotaSpecBinding defines the binding between QuotaSpecs and one or more IstioService.

    FieldTypeDescriptionRequired
    servicesIstioService[]

    One or more services to map the listed QuotaSpec onto.

    Yes
    quotaSpecs

    One or more QuotaSpec references that should be mapped to the specified service(s). The aggregate collection of match conditions defined in the QuotaSpecs should not overlap.

    Yes

    QuotaSpecBinding.QuotaSpecReference

    QuotaSpecReference uniquely identifies the QuotaSpec used in the Binding.

    FieldTypeDescriptionRequired
    namestring

    The short name of the QuotaSpec. This is the resource name defined by the metadata name field.

    Yes
    namespacestring

    Optional namespace of the QuotaSpec. Defaults to the value of the metadata namespace field.

    No

    ServiceConfig

    Defines the per-service client configuration.

    FieldTypeDescriptionRequired
    bool

    If true, do not call Mixer Check.

    No
    disableReportCallsbool

    If true, do not call Mixer Report.

    No
    mixerAttributesAttributes

    Send these attributes to Mixer in both Check and Report. This typically includes the “destination.service” attribute. In case of a per-route override, per-route attributes take precedence over the attributes supplied in the client configuration.

    No
    httpApiSpec

    HTTP API specifications to generate API attributes.

    No
    quotaSpecQuotaSpec[]No
    networkFailPolicy

    Specifies the behavior when the client is unable to connect to Mixer. This is the service-level policy. It overrides [mesh-level policy][istio.mixer.v1.config.client.TransportConfig.networkfailpolicy].

    No
    forwardAttributesAttributes

    Default attributes to forward to upstream. This typically includes the “source.ip” and “source.uid” attributes. In case of a per-route override, per-route attributes take precedence over the attributes supplied in the client configuration.

    Forwarded attributes take precedence over the static Mixer attributes, except in cases where there is clear configuration to ignore forwarded attributes. Gateways, for instance, should never use forwarded attributes.

    The full order of application is as follows: 1. static Mixer attributes from the filter config; 2. static Mixer attributes from the route config; 3. forwarded attributes from the source filter config (if any and not ignored); 4. forwarded attributes from the source route config (if any and not ignored); 5. derived attributes from the request metadata.

    No

    StringMatch

    Describes how to match a given string in HTTP headers. Match is case-sensitive.

    FieldTypeDescriptionRequired
    exactstring (oneof)

    exact string match

    Yes
    prefixstring (oneof)

    prefix-based match

    Yes
    regexstring (oneof)

    ECMAscript style regex-based match

    Yes

    TcpClientConfig

    Defines the client config for TCP.

    FieldTypeDescriptionRequired
    transport

    The transport config.

    No
    mixerAttributesAttributes

    Default attributes to send to Mixer in both Check and Report. This typically includes “destination.ip” and “destination.uid” attributes.

    No
    disableCheckCallsbool

    If set to true, disables Mixer check calls.

    No
    disableReportCallsbool

    If set to true, disables Mixer check calls.

    No
    connectionQuotaSpec

    Quota specifications to generate quota requirements. It applies on the new TCP connections.

    No
    reportIntervalDuration

    Specify report interval to send periodical reports for long TCP connections. If not specified, the interval is 10 seconds. This interval should not be less than 1 second, otherwise it will be reset to 1 second.

    No

    Defines the transport config on how to call Mixer.

    istio.mixer.v1.Attributes

    Attributes represents a set of typed name/value pairs. Many of Mixer’s API either consume and/or return attributes.

    Istio uses attributes to control the runtime behavior of services running in the service mesh. Attributes are named and typed pieces of metadata describing ingress and egress traffic and the environment this traffic occurs in. An Istio attribute carries a specific piece of information such as the error code of an API request, the latency of an API request, or the original IP address of a TCP connection. For example:

    1. request.path: xyz/abc
    2. request.size: 234
    3. request.time: 12:34:56.789 04/17/2017
    4. source.ip: 192.168.0.1
    5. target.service: example

    A given Istio deployment has a fixed vocabulary of attributes that it understands. The specific vocabulary is determined by the set of attribute producers being used in the deployment. The primary attribute producer in Istio is Envoy, although specialized Mixer adapters and services can also generate attributes.

    The common baseline set of attributes available in most Istio deployments is defined here.

    Attributes are strongly typed. The supported attribute types are defined by . Each type of value is encoded into one of the so-called transport types present in this message.

    Defines a map of attributes in uncompressed format. Following places may use this message: 1) Configure Istio/Proxy with static per-proxy attributes, such as source.uid. 2) Service IDL definition to extract api attributes for active requests. 3) Forward attributes from client proxy to server proxy for HTTP requests.

    FieldTypeDescriptionRequired
    attributes

    A map of attribute name to its value.

    No