diff --git a/content/docs/reference/config/istio.mixer.v1.config.client/index.html b/content/docs/reference/config/istio.mixer.v1.config.client/index.html new file mode 100644 index 0000000000..e9ee2f40ee --- /dev/null +++ b/content/docs/reference/config/istio.mixer.v1.config.client/index.html @@ -0,0 +1,1099 @@ +--- +WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/api REPO +source_repo: https://github.com/istio/api +title: Mixer Client +description: Configuration state for the Mixer client library. +location: https://istio.io/docs/reference/config/istio.mixer.v1.config.client +layout: protoc-gen-docs +generator: protoc-gen-docs +number_of_entries: 20 +--- +

Describes the configuration state for the Mixer client library that’s built into Envoy.

+ +

APIKey

+
+

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

+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
querystring (oneof) +

API Key is sent as a query parameter. query represents the +query string parameter name.

+ +

For example, query=api_key should be used with the +following request:

+ +
GET /something?api_key=abcdef12345
+
+ +
headerstring (oneof) +

API key is sent in a request header. header represents the +header name.

+ +

For example, header=X-API-KEY should be used with the +following request:

+ +
GET /something HTTP/1.1
+X-API-Key: abcdef12345
+
+ +
+
+

AttributeMatch

+
+

Specifies a match clause to match Istio attributes

+ + + + + + + + + + + + + + + + +
FieldTypeDescription
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

+ +
+
+

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.

+ +
apiVersion: config.istio.io/v1alpha2
+kind: HTTPAPISpec
+metadata:
+  name: petstore
+  namespace: default
+spec:
+  attributes:
+    attributes:
+      api.service:
+        stringValue: petstore.swagger.io
+      api.version:
+        stringValue: 1.0.0
+  patterns:
+  - attributes:
+      attributes:
+        api.operation:
+          stringValue: findPets
+    httpMethod: GET
+    uriTemplate: /api/pets
+  - attributes:
+      attributes:
+        api.operation:
+          stringValue: addPet
+    httpMethod: POST
+    uriTemplate: /api/pets
+  - attributes:
+      attributes:
+        api.operation:
+          stringValue: findPetById
+    httpMethod: GET
+    uriTemplate: /api/pets/{id}
+  - attributes:
+      attributes:
+        api.operation:
+          stringValue: deletePet
+    httpMethod: DELETE
+    uriTemplate: /api/pets/{id}
+  api_keys:
+  - query: api-key
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
attributesistio.mixer.v1.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.

+ +
patternsHTTPAPISpecPattern[] +

List of HTTP patterns to match.

+ +
apiKeysAPIKey[] +

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.

+ +
`query: key, `query: api_key`, and then `header: x-api-key`
+
+ +
+
+

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.

+ +
apiVersion: config.istio.io/v1alpha2
+kind: HTTPAPISpecBinding
+metadata:
+  name: my-binding
+  namespace: default
+spec:
+  services:
+  - name: foo
+    namespace: bar
+  api_specs:
+  - name: petstore
+    namespace: default
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
servicesIstioService[] +

REQUIRED. One or more services to map the listed HTTPAPISpec onto.

+ +
apiSpecsHTTPAPISpecReference[] +

REQUIRED. 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.

+ +
+
+

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.

+ +
pattern:
+- attributes
+    api.operation: doFooBar
+  httpMethod: GET
+  uriTemplate: /foo/bar
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
attributesistio.mixer.v1.Attributes +

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

+ +
httpMethodstring +

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

+ +
uriTemplatestring (oneof) +

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

+ +
/pets
+/pets/{id}
+/dictionary/{term:1}/{term}
+/search{?q*,lang}
+
+ +
regexstring (oneof) +

EXPERIMENTAL:

+ +

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

+ +
"^/pets/(.*?)?"
+
+ +
+
+

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.

+ +
- name: foo
+  namespace: bar
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
namestring +

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

+ +
namespacestring +

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

+ +
+
+

HttpClientConfig

+
+

Defines the client config for HTTP.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
transportTransportConfig +

The transport config.

+ +
serviceConfigsmap<string, ServiceConfig> +

Map of control configuration indexed by destination.service. This +is used to support per-service configuration for cases where a +mixerclient serves multiple services.

+ +
defaultDestinationServicestring +

Default destination service name if none was specified in the +client request.

+ +
mixerAttributesistio.mixer.v1.Attributes +

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

+ +
forwardAttributesistio.mixer.v1.Attributes +

Default attributes to forward to upstream. This typically +includes the “source.ip” and “source.uid” attributes.

+ +
+
+

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”).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
namestring +

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

+ +
namespacestring +

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

+ +
domainstring +

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

+ +
servicestring +

The service FQDN.

+ +
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.

+ +
+
+

NetworkFailPolicy

+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
policyNetworkFailPolicy.FailPolicy +

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

+ +
maxRetryuint32 +

Max retries on transport error.

+ +
baseRetryWaitgoogle.protobuf.Duration +

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

+ +
maxRetryWaitgoogle.protobuf.Duration +

Max time to wait between retries.

+ +
+
+

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.

+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
quotastring +

The quota name to charge

+ +
chargeint64 +

The quota amount to charge

+ +
+
+

QuotaRule

+
+

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

+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
matchAttributeMatch[] +

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

+ +
quotasQuota[] +

The list of quotas to charge.

+ +
+
+

QuotaSpec

+
+

Determines the quotas used for individual requests.

+ + + + + + + + + + + + + + + + +
FieldTypeDescription
rulesQuotaRule[] +

A list of Quota rules.

+ +
+
+

QuotaSpecBinding

+
+

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

+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
servicesIstioService[] +

REQUIRED. One or more services to map the listed QuotaSpec onto.

+ +
quotaSpecsQuotaSpecBinding.QuotaSpecReference[] +

REQUIRED. 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.

+ +
+
+

QuotaSpecBinding.QuotaSpecReference

+
+

QuotaSpecReference uniquely identifies the QuotaSpec used in the +Binding.

+ + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
namestring +

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

+ +
namespacestring +

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

+ +
+
+

ServiceConfig

+
+

Defines the per-service client configuration.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
disableCheckCallsbool +

If true, do not call Mixer Check.

+ +
disableReportCallsbool +

If true, do not call Mixer Report.

+ +
mixerAttributesistio.mixer.v1.Attributes +

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.

+ +
httpApiSpecHTTPAPISpec[] +

HTTP API specifications to generate API attributes.

+ +
quotaSpecQuotaSpec[] +

Quota specifications to generate quota requirements.

+ +
networkFailPolicyNetworkFailPolicy +

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].

+ +
forwardAttributesistio.mixer.v1.Attributes +

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. +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); +4. forwarded attributes from the source route config (if any); +5. derived attributes from the request metadata.

+ +
+
+

StringMatch

+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
exactstring (oneof) +

exact string match

+ +
prefixstring (oneof) +

prefix-based match

+ +
regexstring (oneof) +

ECMAscript style regex-based match

+ +
+
+

TcpClientConfig

+
+

Defines the client config for TCP.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
transportTransportConfig +

The transport config.

+ +
mixerAttributesistio.mixer.v1.Attributes +

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

+ +
disableCheckCallsbool +

If set to true, disables Mixer check calls.

+ +
disableReportCallsbool +

If set to true, disables Mixer check calls.

+ +
connectionQuotaSpecQuotaSpec +

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

+ +
reportIntervalgoogle.protobuf.Duration +

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.

+ +
+
+

TransportConfig

+
+

Defines the transport config on how to call Mixer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
disableCheckCachebool +

The flag to disable check cache.

+ +
disableQuotaCachebool +

The flag to disable quota cache.

+ +
disableReportBatchbool +

The flag to disable report batch.

+ +
networkFailPolicyNetworkFailPolicy +

Specifies the behavior when the client is unable to connect to Mixer. +This is the mesh level policy. The default value for policy is FAIL_OPEN.

+ +
statsUpdateIntervalgoogle.protobuf.Duration +

Specify refresh interval to write Mixer client statistics to Envoy share +memory. If not specified, the interval is 10 seconds.

+ +
checkClusterstring +

Name of the cluster that will forward check calls to a pool of mixer +servers. Defaults to “mixer_server”. By using different names for +checkCluster and reportCluster, it is possible to have one set of +Mixer servers handle check calls, while another set of Mixer servers +handle report calls.

+ +

NOTE: Any value other than the default “mixer_server” will require the +Istio Grafana dashboards to be reconfigured to use the new name.

+ +
reportClusterstring +

Name of the cluster that will forward report calls to a pool of mixer +servers. Defaults to “mixer_server”. By using different names for +checkCluster and reportCluster, it is possible to have one set of +Mixer servers handle check calls, while another set of Mixer servers +handle report calls.

+ +

NOTE: Any value other than the default “mixer_server” will require the +Istio Grafana dashboards to be reconfigured to use the new name.

+ +
attributesForMixerProxyistio.mixer.v1.Attributes +

Default attributes to forward to Mixer upstream. This typically +includes the “source.ip” and “source.uid” attributes. These +attributes are consumed by the proxy in front of 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:

+ +
request.path: xyz/abc
+request.size: 234
+request.time: 12:34:56.789 04/17/2017
+source.ip: 192.168.0.1
+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 +ValueType. +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.

+ + + + + + + + + + + + + + + + +
FieldTypeDescription
attributesmap<string, istio.mixer.v1.Attributes.AttributeValue> +

A map of attribute name to its value.

+ +
+
diff --git a/content/docs/reference/config/networking/v1alpha3/envoy-filter/index.html b/content/docs/reference/config/networking/v1alpha3/envoy-filter/index.html index de11849fbd..a7fdbe36d3 100644 --- a/content/docs/reference/config/networking/v1alpha3/envoy-filter/index.html +++ b/content/docs/reference/config/networking/v1alpha3/envoy-filter/index.html @@ -23,6 +23,9 @@ configurations will be processed sequentially in order of creation time. The behavior is undefined if multiple EnvoyFilter configurations conflict with each other.

+

NOTE 3: For filters of filterType: HTTP you must include a listenerMatch section +with a listenerProtocol: HTTP or the filter have no effect.

+

The following example for Kubernetes enables Envoy’s Lua filter for all inbound HTTP calls arriving at service port 8080 of the reviews service pod with labels “app: reviews”.

@@ -61,7 +64,7 @@ spec: workloadLabels map<string, string> -

One or more labels that indicate a specific set of pods/VMs whose +

Zero or more labels that indicate a specific set of pods/VMs whose proxies should be configured to use these additional filters. The scope of label search is platform dependent. On Kubernetes, for example, the scope includes pods running in all reachable diff --git a/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html b/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html index 260830f815..ff752abd9a 100644 --- a/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html +++ b/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html @@ -1014,8 +1014,9 @@ include Istio CA certificates and system certificates in cert pool.

serverName string -

Indicates the name of adapter backend server which is useful for routing with -proxy-fronted backend.

+

Used to configure mixer mutual TLS client to supply server name for SNI. +It is not used to verify the hostname of the peer certificate, since +Istio verifies whitelisted SAN fields in mutual TLS.

@@ -1330,8 +1331,8 @@ passed as what it is.

serverName string -

Indicates the name of adapter backend which is useful for routing with -proxy-fronted backend.

+

Used to configure mixer TLS client to verify the hostname on the returned +certificates. It is also included in the client’s handshake to support SNI.