From e37ba018d07c1a3c6a9bd8287d3f2cd0b8ead889 Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Thu, 10 Oct 2019 08:44:34 -0700 Subject: [PATCH] Update common files (#17757) --- Makefile | 2 +- common/.commonfiles.sha | 2 +- .../config/adapter.bypass.config.pb.html | 24 + .../config/adapter.circonus.config.pb.html | 48 ++ .../config/adapter.cloudwatch.config.pb.html | 193 ++++++++ .../config/adapter.denier.config.pb.html | 37 ++ .../config/adapter.dogstatsd.config.pb.html | 107 ++++ .../config/adapter.fluentd.config.pb.html | 44 ++ .../adapter.kubernetesenv.config.pb.html | 35 ++ .../adapter.template.kubernetes.pb.html | 226 +++++++++ .../list/config/adapter.list.config.pb.html | 69 +++ .../config/adapter.memquota.config.pb.html | 33 ++ .../opa/config/adapter.opa.config.pb.html | 27 + .../config/adapter.prometheus.config.pb.html | 195 ++++++++ .../config/adapter.redisquota.config.pb.html | 74 +++ .../config/adapter.signalfx.config.pb.html | 109 +++++ .../config/adapter.solarwinds.config.pb.html | 68 +++ .../config/adapter.stackdriver.config.pb.html | 461 ++++++++++++++++++ .../config/adapter.statsd.config.pb.html | 81 +++ .../stdio/config/adapter.stdio.config.pb.html | 150 ++++++ .../config/adapter.zipkin.config.pb.html | 21 + mixer/template/apikey/apiKey.pb.html | 40 ++ .../authorization/authorization.pb.html | 84 ++++ mixer/template/edge/edge.pb.html | 104 ++++ mixer/template/listentry/listEntry.pb.html | 8 + mixer/template/logentry/logEntry.pb.html | 44 ++ mixer/template/metric/metric.pb.html | 36 ++ mixer/template/quota/quota.pb.html | 8 + mixer/template/tracespan/traceSpan.pb.html | 210 ++++++++ mixer/test/keyval/keyval.pb.html | 8 + .../template/quota/sampleQuota.pb.html | 8 + pkg/test/fakes/policy/policy.pb.html | 40 ++ security/proto/istio.v1.auth.pb.html | 33 ++ 33 files changed, 2627 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index ee59476d356..59e5ef44c3e 100644 --- a/Makefile +++ b/Makefile @@ -56,7 +56,7 @@ ifeq ($(BUILD_WITH_CONTAINER),1) export TARGET_OUT = /work/out/$(TARGET_ARCH)_$(TARGET_OS) CONTAINER_CLI ?= docker DOCKER_SOCKET_MOUNT ?= -v /var/run/docker.sock:/var/run/docker.sock -IMG ?= gcr.io/istio-testing/build-tools:2019-10-09T18-20-54 +IMG ?= gcr.io/istio-testing/build-tools:2019-10-10T00-49-39 UID = $(shell id -u) PWD = $(shell pwd) diff --git a/common/.commonfiles.sha b/common/.commonfiles.sha index aea30b4ab3b..ec62b9dff91 100644 --- a/common/.commonfiles.sha +++ b/common/.commonfiles.sha @@ -1 +1 @@ -23964a61fe765efb932204b72458f2915e1e17b7 +eac4ed8cc8677dbe78252204db6deaa3d924818b diff --git a/mixer/adapter/bypass/config/adapter.bypass.config.pb.html b/mixer/adapter/bypass/config/adapter.bypass.config.pb.html index dff74104cb9..3fd9c8645a3 100644 --- a/mixer/adapter/bypass/config/adapter.bypass.config.pb.html +++ b/mixer/adapter/bypass/config/adapter.bypass.config.pb.html @@ -63,6 +63,30 @@

Params

Indicates whether the protocol is session based or not.

+ + + +backendAddress +string + +

The backend address for the remote policy backend.

+ + + + +params +google.protobuf.Any + +

The actual config parameters to send to the remote backend.

+ + + + +sessionBased +bool + +

Indicates whether the protocol is session based or not.

+ diff --git a/mixer/adapter/circonus/config/adapter.circonus.config.pb.html b/mixer/adapter/circonus/config/adapter.circonus.config.pb.html index 266d6fcbad5..53a00af5253 100644 --- a/mixer/adapter/circonus/config/adapter.circonus.config.pb.html +++ b/mixer/adapter/circonus/config/adapter.circonus.config.pb.html @@ -39,6 +39,20 @@

Params

submissionInterval google.protobuf.Duration + + + +metrics +Params.MetricInfo[] + + + + +submissionUrl +string + +

Circonus SubmissionURL to HTTPTrap check

+ @@ -69,6 +83,20 @@

Params.MetricInfo

name

+ + + +type +Params.MetricInfo.Type + + + + +name +string + +

name

+ @@ -112,6 +140,26 @@

Params.MetricInfo.Type

+ +UNKNOWN + + + + +COUNTER + + + + +GAUGE + + + + +DISTRIBUTION + + + diff --git a/mixer/adapter/cloudwatch/config/adapter.cloudwatch.config.pb.html b/mixer/adapter/cloudwatch/config/adapter.cloudwatch.config.pb.html index b7f36780987..a443f0f8427 100644 --- a/mixer/adapter/cloudwatch/config/adapter.cloudwatch.config.pb.html +++ b/mixer/adapter/cloudwatch/config/adapter.cloudwatch.config.pb.html @@ -74,6 +74,46 @@

Params

A map of Istio logentry name to CloudWatch logentry info.

+ + + +namespace +string + +

CloudWatch metric namespace.

+ + + + +metricInfo +map<string, Params.MetricDatum> + +

A map of Istio metric name to CloudWatch metric info.

+ + + + +logGroupName +string + +

The name of the log group in cloudwatchlogs.

+ + + + +logStreamName +string + +

The name of the log stream in cloudwatchlogs.

+ + + + +logs +map<string, Params.LogInfo> + +

A map of Istio logentry name to CloudWatch logentry info.

+ @@ -97,6 +137,15 @@

Params.LogInfo

A golang text/template template that will be executed to construct the payload for this log entry. It will be given the full set of variables for the log to use to construct its result.

+ + + +payloadTemplate +string + +

A golang text/template template that will be executed to construct the payload for this log entry. +It will be given the full set of variables for the log to use to construct its result.

+ @@ -122,6 +171,15 @@

Params.MetricDatum

The unit of the metric. Must be valid cloudwatch unit value. CloudWatch docs

+ + + +unit +Params.MetricDatum.Unit + +

The unit of the metric. Must be valid cloudwatch unit value. +CloudWatch docs

+ @@ -272,6 +330,141 @@

Params.MetricDatum.Unit

+ +None + + + + +Seconds + + + + +Microseconds + + + + +Milliseconds + + + + +Count + + + + +Bytes + + + + +Kilobytes + + + + +Megabytes + + + + +Gigabytes + + + + +Terabytes + + + + +Bits + + + + +Kilobits + + + + +Megabits + + + + +Gigabits + + + + +Terabits + + + + +Percent + + + + +Bytes_Second + + + + +Kilobytes_Second + + + + +Megabytes_Second + + + + +Gigabytes_Second + + + + +Terabytes_Second + + + + +Bits_Second + + + + +Kilobits_Second + + + + +Megabits_Second + + + + +Gigabits_Second + + + + +Terabits_Second + + + + +Count_Second + + + diff --git a/mixer/adapter/denier/config/adapter.denier.config.pb.html b/mixer/adapter/denier/config/adapter.denier.config.pb.html index 112c4cbe906..990aaef7a50 100644 --- a/mixer/adapter/denier/config/adapter.denier.config.pb.html +++ b/mixer/adapter/denier/config/adapter.denier.config.pb.html @@ -51,6 +51,14 @@

Params

The number of times the denial may be used.

+ + + +validUseCount +int32 + +

The number of times the denial may be used.

+ @@ -152,6 +160,35 @@

Other uses

A list of messages that carry the error details. There is a common set of message types for APIs to use.

+ + + +code +int32 + +

The status code, which should be an enum value of +google.rpc.Code.

+ + + + +message +string + +

A developer-facing error message, which should be in English. Any +user-facing error message should be localized and sent in the +google.rpc.Status.details field, or localized +by the client.

+ + + + +details +google.protobuf.Any[] + +

A list of messages that carry the error details. There is a common set of +message types for APIs to use.

+ diff --git a/mixer/adapter/dogstatsd/config/adapter.dogstatsd.config.pb.html b/mixer/adapter/dogstatsd/config/adapter.dogstatsd.config.pb.html index 27ba18c340e..090f1e5c06b 100644 --- a/mixer/adapter/dogstatsd/config/adapter.dogstatsd.config.pb.html +++ b/mixer/adapter/dogstatsd/config/adapter.dogstatsd.config.pb.html @@ -82,6 +82,60 @@

Params

Map of a specific metric instance name -> info. If a metric’s instance name is not in the map then the metric will not be exported to DataDog.

+ + + +address +string + +

Address of the dogstatsd server. +Default: localhost:8125

+ + + + +prefix +string + +

Prefix to prepend to all metrics handled by the adapter. Metric “bar” with prefix “foo.” becomes “foo.bar” in DataDog. In order to make sure the metrics get populated into Datadog properly and avoid any billing issues, it’s important to leave the metric prefix to its default value of ‘istio.’ +Default: “istio.”

+ + + + +bufferLength +int32 + +

Number of individual metrics to buffer before flushing metrics to the network. When buffered, metrics are flushed every 100ms or when the buffer is filled. +When buffer is 0, metrics are not buffered. +Default: 0

+ + + + +globalTags +map<string, string> + +

Tags to add to every metric. “global”: “tag” becomes “global:tag” in DataDog +Default: []

+ + + + +sampleRate +double + +

Chance that any particular metric is sampled when emitted; can take the range [0, 1]. +Default: 1

+ + + + +metrics +map<string, Params.MetricInfo> + +

Map of a specific metric instance name -> info. If a metric’s instance name is not in the map then the metric will not be exported to DataDog.

+ @@ -123,6 +177,31 @@

Params.MetricInfo

Tags to add to the metric in addition to the dimensions. “tag”: “val” becomes “tag:val” in DataDog Default: []

+ + + +name +string + +

Name of the metric in DataDog

+ + + + +type +Params.MetricInfo.Type + +

The type of metric

+ + + + +tags +map<string, string> + +

Tags to add to the metric in addition to the dimensions. “tag”: “val” becomes “tag:val” in DataDog +Default: []

+ @@ -166,6 +245,34 @@

Params.MetricInfo.Type

DISTRIBUTION is converted to a Timing Histogram for metrics with a time unit and a Histogram for all other units

+ + + +UNKNOWN_TYPE + +

Default Unknown Type

+ + + + +COUNTER + +

Increments a DataDog counter

+ + + + +GAUGE + +

Sets the new value of a DataDog gauge

+ + + + +DISTRIBUTION + +

DISTRIBUTION is converted to a Timing Histogram for metrics with a time unit and a Histogram for all other units

+ diff --git a/mixer/adapter/fluentd/config/adapter.fluentd.config.pb.html b/mixer/adapter/fluentd/config/adapter.fluentd.config.pb.html index f692964c72a..12c182e615a 100644 --- a/mixer/adapter/fluentd/config/adapter.fluentd.config.pb.html +++ b/mixer/adapter/fluentd/config/adapter.fluentd.config.pb.html @@ -95,6 +95,50 @@

Params

the configured timeout, the request will be cancelled and dropped. Default to 1m.

+ + + +address +string + +

Address of listening fluentd daemon. Example: fluentd-server:24224 +Default value is localhost:24224

+ + + + +integerDuration +bool + +

Convert attributes of type duration to integers of unit ms in +logs. Default behaviour is a string representation including +unit.

+ + + + +instanceBufferSize +int64 + +

Controls the size of the queue of log entries awaiting processing by the +data push goroutine. This impacts the overall size of the backlog of +log entries that the handler will accept. If the handler falls behind and +the number of outstanding instances exceeds this limit, the handler will +begin to drop log entries. +Defaults to 1024.

+ + + + +maxBatchSizeBytes +int64 + +

Controls the number of data bytes that are encoded and buffered by the handler before +they are pushed to the fluentd backend. This impacts the size and frequency of requests +sent to the fluentd backend. Once the buffer exceeds this limit, the handler will attempt to push +data to the backend. +Defaults to 8,388,608 (8 MiB).

+ diff --git a/mixer/adapter/kubernetesenv/config/adapter.kubernetesenv.config.pb.html b/mixer/adapter/kubernetesenv/config/adapter.kubernetesenv.config.pb.html index 0f1e69e3301..3396260ea4a 100644 --- a/mixer/adapter/kubernetesenv/config/adapter.kubernetesenv.config.pb.html +++ b/mixer/adapter/kubernetesenv/config/adapter.kubernetesenv.config.pb.html @@ -82,6 +82,41 @@

Params

Default: “istio-system”

+ + + +kubeconfigPath +string + +

File path to discover kubeconfig. For in-cluster configuration, +this should be left unset. For local configuration, this should +be set to the path of a kubeconfig file that can be used to +reach a kubernetes API server.

+ +

NOTE: The kubernetesenv adapter will use the value of the KUBECONFIG environment variable +in the case where it is set (overriding any value configured +through this proto).

+ +

Default: “” (unset)

+ + + + +clusterRegistriesNamespace +string + +

Namespace of the secret created for multicluster support.

+ +

Details on multicluster and the Kubernetes secret required to +access the remote cluster’s credentials can be found in +multicluster install.

+ +

NOTE: If cluster_registries_namespace is not set then the environment +variable POD_NAMESPACE is checked/used. If POD_NAMESPACE is not +set then cluster_registries_namespace defaults to “istio-system”.

+ +

Default: “istio-system”

+ diff --git a/mixer/adapter/kubernetesenv/template/adapter.template.kubernetes.pb.html b/mixer/adapter/kubernetesenv/template/adapter.template.kubernetes.pb.html index 3a685756c05..5a205677347 100644 --- a/mixer/adapter/kubernetesenv/template/adapter.template.kubernetes.pb.html +++ b/mixer/adapter/kubernetesenv/template/adapter.template.kubernetes.pb.html @@ -236,6 +236,192 @@

OutputTemplate

Refers to the Istio workload name for the destination pod. Attributebindings can refer to this field using $out.destinationworkload_namespace

+ + + +sourcePodUid +string + +

Refers to the source.uid for a pod. This is for TCP use cases where the attribute is not present. +attributebindings can refer to this field using $out.sourcepod_uid

+ + + + +sourcePodIp +istio.policy.v1beta1.IPAddress + +

Refers to source pod ip address. attributebindings can refer to this field using $out.sourcepod_ip

+ + + + +sourcePodName +string + +

Refers to source pod name. attributebindings can refer to this field using $out.sourcepod_name

+ + + + +sourceLabels +map<string, string> + +

Refers to source pod labels. attributebindings can refer to this field using $out.sourcelabels

+ + + + +sourceNamespace +string + +

Refers to source pod namespace. attributebindings can refer to this field using $out.sourcenamespace

+ + + + +sourceServiceAccountName +string + +

Refers to source pod service account name. attributebindings can refer to this field using $out.sourceserviceaccountname

+ + + + +sourceHostIp +istio.policy.v1beta1.IPAddress + +

Refers to source pod host ip address. attributebindings can refer to this field using $out.sourcehost_ip

+ + + + +sourceWorkloadUid +string + +

Refers to the Istio workload identifier for the source pod. Attributebindings can refer to this field using $out.sourceworkload_uid

+ + + + +sourceWorkloadName +string + +

Refers to the Istio workload name for the source pod. Attributebindings can refer to this field using $out.sourceworkload_name

+ + + + +sourceWorkloadNamespace +string + +

Refers to the Istio workload namespace for the source pod. Attributebindings can refer to this field using $out.sourceworkload_namespace

+ + + + +sourceOwner +string + +

Refers to the (controlling) owner of the source pod. Attributebindings can refer to this field using $out.sourceowner

+ + + + +destinationPodUid +string + +

Refers to the destination.uid for a pod. This is for TCP use cases where the attribute is not present. +attributebindings can refer to this field using $out.destinationpod_uid

+ + + + +destinationPodIp +istio.policy.v1beta1.IPAddress + +

Refers to destination pod ip address. attributebindings can refer to this field using $out.destinationpod_ip

+ + + + +destinationPodName +string + +

Refers to destination pod name. attributebindings can refer to this field using $out.destinationpod_name

+ + + + +destinationContainerName +string + +

Refers to destination container name. attributebindings can refer to this field using $out.destinationcontainer_name

+ + + + +destinationLabels +map<string, string> + +

Refers to destination pod labels. attributebindings can refer to this field using $out.destinationlabels

+ + + + +destinationNamespace +string + +

Refers to destination pod namespace. attributebindings can refer to this field using $out.destinationnamespace

+ + + + +destinationServiceAccountName +string + +

Refers to destination pod service account name. attributebindings can refer to this field using $out.destinationserviceaccountname

+ + + + +destinationHostIp +istio.policy.v1beta1.IPAddress + +

Refers to destination pod host ip address. attributebindings can refer to this field using $out.destinationhost_ip

+ + + + +destinationOwner +string + +

Refers to the (controlling) owner of the destination pod. Attributebindings can refer to this field using $out.destinationowner

+ + + + +destinationWorkloadUid +string + +

Refers to the Istio workload identifier for the destination pod. Attributebindings can refer to this field using $out.destinationworkload_uid

+ + + + +destinationWorkloadName +string + +

Refers to the Istio workload name for the destination pod. Attributebindings can refer to this field using $out.destinationworkload_name

+ + + + +destinationWorkloadNamespace +string + +

Refers to the Istio workload name for the destination pod. Attributebindings can refer to this field using $out.destinationworkload_namespace

+ @@ -296,6 +482,46 @@

Template

Destination container’s port number.

+ + + +sourceUid +string + +

Source pod’s uid. Must be of the form: “kubernetes://pod.namespace”

+ + + + +sourceIp +istio.policy.v1beta1.IPAddress + +

Source pod’s ip.

+ + + + +destinationUid +string + +

Destination pod’s uid. Must be of the form: “kubernetes://pod.namespace”

+ + + + +destinationIp +istio.policy.v1beta1.IPAddress + +

Destination pod’s ip.

+ + + + +destinationPort +int64 + +

Destination container’s port number.

+ diff --git a/mixer/adapter/list/config/adapter.list.config.pb.html b/mixer/adapter/list/config/adapter.list.config.pb.html index 055f5e1059b..2c6595f4e05 100644 --- a/mixer/adapter/list/config/adapter.list.config.pb.html +++ b/mixer/adapter/list/config/adapter.list.config.pb.html @@ -97,6 +97,47 @@

Params

Whether the list operates as a blacklist or a whitelist.

+ + + +providerUrl +string + +

Where to find the list to check against. This may be omitted for a completely local list.

+ + + + +cachingUseCount +int32 + +

Indicates the number of times a caller of this adapter can use a cached answer +before it should ask the adapter again.

+ + + + +overrides +string[] + +

List entries that are consulted first, before the list from the server

+ + + + +entryType +Params.ListEntryType + +

Determines the kind of list entry and overrides.

+ + + + +blacklist +bool + +

Whether the list operates as a blacklist or a whitelist.

+ @@ -140,6 +181,34 @@

Params.ListEntryType

List entries are treated as re2 regexp. See here for the supported syntax.

+ + + +STRINGS + +

List entries are treated as plain strings.

+ + + + +CASE_INSENSITIVE_STRINGS + +

List entries are treated as case-insensitive strings.

+ + + + +IP_ADDRESSES + +

List entries are treated as IP addresses and ranges.

+ + + + +REGEX + +

List entries are treated as re2 regexp. See here for the supported syntax.

+ diff --git a/mixer/adapter/memquota/config/adapter.memquota.config.pb.html b/mixer/adapter/memquota/config/adapter.memquota.config.pb.html index 7f42309a1c7..f9bd2d32314 100644 --- a/mixer/adapter/memquota/config/adapter.memquota.config.pb.html +++ b/mixer/adapter/memquota/config/adapter.memquota.config.pb.html @@ -90,6 +90,23 @@

Params.Override

automatically released. This is only meaningful for rate limit quotas, otherwise the value must be zero.

+ + + +dimensions +map<string, string> + +

The specific dimensions for which this override applies. +String representation of instance dimensions is used to check against configured dimensions.

+ + + + +maxAmount +int64 + +

The upper limit for this quota.

+ @@ -141,6 +158,22 @@

Params.Quota

Overrides associated with this quota. The first matching override is applied.

+ + + +name +string + +

The name of the quota

+ + + + +maxAmount +int64 + +

The upper limit for this quota.

+ diff --git a/mixer/adapter/opa/config/adapter.opa.config.pb.html b/mixer/adapter/opa/config/adapter.opa.config.pb.html index 27bb3dfb8f5..2801598180c 100644 --- a/mixer/adapter/opa/config/adapter.opa.config.pb.html +++ b/mixer/adapter/opa/config/adapter.opa.config.pb.html @@ -81,6 +81,33 @@

Params

If failClose is set to true and there is a runtime error, instead of disabling the adapter, close the client request

+ + + +policy +string[] + +

List of OPA policies

+ + + + +checkMethod +string + +

Query method to check. +Format: data.<package name>.<method name>

+ + + + +failClose +bool + +

Close the client request when adapter has a issue. +If failClose is set to true and there is a runtime error, +instead of disabling the adapter, close the client request

+ diff --git a/mixer/adapter/prometheus/config/adapter.prometheus.config.pb.html b/mixer/adapter/prometheus/config/adapter.prometheus.config.pb.html index cc5e45b4a94..fc0ab378cce 100644 --- a/mixer/adapter/prometheus/config/adapter.prometheus.config.pb.html +++ b/mixer/adapter/prometheus/config/adapter.prometheus.config.pb.html @@ -52,6 +52,33 @@

Params

expiryCheckIntervalDuration: "1s" + + + +metrics +Params.MetricInfo[] + +

The set of metrics to represent in Prometheus. If a metric is defined in Istio but doesn’t have a corresponding +shape here, it will not be populated at runtime.

+ + + + +metricsExpirationPolicy +Params.MetricsExpirationPolicy + +

Optional. The rate at which to expire metrics from the adapter. This option controls the amount of metric data +that the adapter will maintain over its lifetime.

+ +

EXPERIMENTAL: This feature should only be used in advanced cases.

+ +

Example config stanza:

+ +
metricsExpirationPolicy:
+  metricsExpiryDuration: "5s"
+  expiryCheckIntervalDuration: "1s"
+
+ @@ -136,6 +163,74 @@

Params.MetricInfo

The names of labels to use: these need to match the dimensions of the Istio metric. TODO: see if we can remove this and rely on only the dimensions in the future.

+ + + +namespace +string + +

Optional. The namespace is used as a prefix on the metric names. +An example: for a metric named requests_total with a namespace of istio, +the full metric name becomes istio_requests_total. +NOTE: The specified namespace should be a prometheus-safe name. If not, the adapter +will attempt to convert the namespace to a prometheus-safe name. +NOTE: Changing the value for this will potentially impact downstream integrations +and should be used with caution. +Default value: istio.

+ + + + +name +string + +

Recommended. The name is used to register the prometheus metric. +It must be unique across all prometheus metrics as prometheus does not allow duplicate names. +If name is not specified a sanitized version of instance_name is used.

+ + + + +instanceName +string + +

Required. The name is the fully qualified name of the Istio metric instance +that this MetricInfo processes.

+ + + + +description +string + +

Optional. A human readable description of this metric.

+ + + + +kind +Params.MetricInfo.Kind + + + + +buckets +Params.MetricInfo.BucketsDefinition + +

For metrics with a metric kind of DISTRIBUTION, this provides a mechanism +for configuring the buckets that will be used to store the aggregated values. +This field must be provided for metrics declared to be of type DISTRIBUTION. +This field will be ignored for non-distribution metric kinds.

+ + + + +labelNames +string[] + +

The names of labels to use: these need to match the dimensions of the Istio metric. +TODO: see if we can remove this and rely on only the dimensions in the future.

+ @@ -176,6 +271,30 @@

Params.MetricInfo.BucketsDefinition

The explicit buckets.

+ + + +linearBuckets +Params.MetricInfo.BucketsDefinition.Linear (oneof) + +

The linear buckets.

+ + + + +exponentialBuckets +Params.MetricInfo.BucketsDefinition.Exponential (oneof) + +

The exponential buckets.

+ + + + +explicitBuckets +Params.MetricInfo.BucketsDefinition.Explicit (oneof) + +

The explicit buckets.

+ @@ -212,6 +331,14 @@

Params.MetricInfo.BucketsD

The values must be monotonically increasing.

+ + + +bounds +double[] + +

The values must be monotonically increasing.

+ @@ -264,6 +391,30 @@

Params.MetricInfo.Bucke

Must be greater than 0.

+ + + +numFiniteBuckets +int32 + +

Must be greater than 0.

+ + + + +growthFactor +double + +

Must be greater than 1.

+ + + + +scale +double + +

Must be greater than 0.

+ @@ -316,6 +467,30 @@

Params.MetricInfo.BucketsDef

Lower bound of the first bucket.

+ + + +numFiniteBuckets +int32 + +

Must be greater than 0.

+ + + + +width +double + +

Must be greater than 0.

+ + + + +offset +double + +

Lower bound of the first bucket.

+ @@ -353,6 +528,26 @@

Params.MetricInfo.Kind

+ +UNSPECIFIED + + + + +GAUGE + + + + +COUNTER + + + + +DISTRIBUTION + + + diff --git a/mixer/adapter/redisquota/config/adapter.redisquota.config.pb.html b/mixer/adapter/redisquota/config/adapter.redisquota.config.pb.html index ad9bf1973fc..a8e062fead8 100644 --- a/mixer/adapter/redisquota/config/adapter.redisquota.config.pb.html +++ b/mixer/adapter/redisquota/config/adapter.redisquota.config.pb.html @@ -72,6 +72,24 @@

Params

Maximum number of idle connections to redis Default is 10 connections per every CPU as reported by runtime.NumCPU.

+ + + +redisServerUrl +string + +

Redis connection string <hostname>:<port number> +ex) localhost:6379

+ + + + +connectionPoolSize +int64 + +

Maximum number of idle connections to redis +Default is 10 connections per every CPU as reported by runtime.NumCPU.

+ @@ -105,6 +123,15 @@

Params.Override

The upper limit for this quota override. This value should be bigger than 0

+ + + +maxAmount +int64 + +

The upper limit for this quota override. +This value should be bigger than 0

+ @@ -171,6 +198,39 @@

Params.Quota

Overrides associated with this quota. The first matching override is applied.

+ + + +name +string + +

The name of the quota

+ + + + +maxAmount +int64 + +

The upper limit for this quota. max_amount should be bigger than 0

+ + + + +rateLimitAlgorithm +Params.QuotaAlgorithm + +

Quota management algorithm. The default value is FIXED_WINDOW

+ + + + +overrides +Params.Override[] + +

Overrides associated with this quota. +The first matching override is applied.

+ @@ -200,6 +260,20 @@

Params.QuotaAlgorithm

ROLLING_WINDOW The rolling window algorithm’s additional precision comes at the cost of increased redis resource usage.

+ + + +FIXED_WINDOW + +

FIXED_WINDOW The fixed window approach can allow 2x peak specified rate, whereas the rolling-window doesn’t.

+ + + + +ROLLING_WINDOW + +

ROLLING_WINDOW The rolling window algorithm’s additional precision comes at the cost of increased redis resource usage.

+ diff --git a/mixer/adapter/signalfx/config/adapter.signalfx.config.pb.html b/mixer/adapter/signalfx/config/adapter.signalfx.config.pb.html index 2e8b88d4cbe..280dbc10172 100644 --- a/mixer/adapter/signalfx/config/adapter.signalfx.config.pb.html +++ b/mixer/adapter/signalfx/config/adapter.signalfx.config.pb.html @@ -157,6 +157,73 @@

Params

be sampled if their parent is. If not provided, defaults to sending all spans.

+ + + +metrics +Params.MetricConfig[] + +

Required. The set of metrics to send to SignalFx. If an Istio metric is +configured to be sent to this adapter, it must have a corresponding +description here.

+ + + + +ingestUrl +string + +

Optional. The URL of the SignalFx ingest server to use. Will default to +the global ingest server if not specified.

+ + + + +accessToken +string + +

Required. The access token for the SignalFx organization that should +receive the metrics.

+ + + + +enableMetrics +bool + +

Optional. If set to false, metrics won’t be sent (but trace spans will +be sent, unless otherwise disabled).

+ + + + +enableTracing +bool + +

Optional. If set to false, trace spans won’t be sent (but metrics will +be sent, unless otherwise disabled).

+ + + + +tracingBufferSize +uint32 + +

Optional. The number of trace spans that the adapter will buffer before +dropping them. This defaults to 1000 spans but can be configured higher +if needed. An error message will be logged if spans are dropped.

+ + + + +tracingSampleProbability +double + +

Optional. The uniform probability ([0.0, 1.0]) that a given span gets +sampled if its parent was not already sampled. Child spans will always +be sampled if their parent is. If not provided, defaults to sending all +spans.

+ @@ -192,6 +259,25 @@

Params.MetricConfig

The metric type of the metric

+ + + +name +string + +

Required. The name of the metric as it is sent to the adapter. In +Kubernetes this is of the form <name>.metric.<namespace> where +<name> is the name field of the metric resource, and <namespace> +is the namespace of the metric resource.

+ + + + +type +Params.MetricConfig.Type + +

The metric type of the metric

+ @@ -230,6 +316,29 @@

Params.MetricConfig.Type

A histogram distribution. This will result in several metrics emitted for each unique set of dimensions.

+ + + +NONE + +

None is the default and is invalid

+ + + + +COUNTER + +

Values with the same set of dimensions will be added together +as a continuously incrementing value.

+ + + + +HISTOGRAM + +

A histogram distribution. This will result in several metrics +emitted for each unique set of dimensions.

+ diff --git a/mixer/adapter/solarwinds/config/adapter.solarwinds.config.pb.html b/mixer/adapter/solarwinds/config/adapter.solarwinds.config.pb.html index 1ff6bbe9150..86cb6946291 100644 --- a/mixer/adapter/solarwinds/config/adapter.solarwinds.config.pb.html +++ b/mixer/adapter/solarwinds/config/adapter.solarwinds.config.pb.html @@ -139,6 +139,50 @@

Params

A map of Istio logentry name to solarwinds log info.

+ + + +appopticsAccessToken +string + +

AppOptics Access Token needed to send metrics to AppOptics. If no access token is given then metrics +will NOT be shipped to AppOptics

+ + + + +appopticsBatchSize +int32 + +

Optional. Max batch size of metrics to be sent to AppOptics. +AppOptics does not allow batch size greater than 1000. +If this is unspecified or given a value 0 explicitly, a default batch size of 1000 will be used.

+ + + + +papertrailUrl +string + +

Papertrail url to ship logs to. If no papertrail url is given then the logs will NOT be shipped but rather +dropped.

+ + + + +metrics +map<string, Params.MetricInfo> + +

A map of Istio metric name to solarwinds metric info.

+ + + + +logs +map<string, Params.LogInfo> + +

A map of Istio logentry name to solarwinds log info.

+ @@ -171,6 +215,22 @@

Params.LogInfo

It will be given the full set of variables for the log to use to construct its result. If it is not provided, a default template in place will be used.

+ + + +payloadTemplate +string + +

Optional. A golang text/template template (more details about golang text/template’s templating can be +found here: https://golang.org/pkg/text/template/) that will be executed to construct the payload for +this log entry. +An example template that could be used: +{{or (.originIp) “-”}} - {{or (.sourceUser) “-”}} [{{or (.timestamp.Format “2006-01-02T15:04:05Z07:00”) “-”}}] “{{or (.method) “-”}} {{or (.url) “-”}} {{or (.protocol) “-”}}” {{or (.responseCode) “-”}} {{or (.responseSize) “-”}} +A sample log that will be created after parsing the template with appropriate variables will look like this: +Jan 23 21:53:02 istio-mixer-57d88dc4b4-rbgmc istio: 10.32.0.15 - kubernetes://istio-ingress-78545c5bc9-wbr6g.istio-system [2018-01-24T02:53:02Z] “GET /productpage http” 200 5599 +It will be given the full set of variables for the log to use to construct its result. +If it is not provided, a default template in place will be used.

+ @@ -195,6 +255,14 @@

Params.MetricInfo

The names of labels to use: these need to match the dimensions of the Istio metric.

+ + + +labelNames +string[] + +

The names of labels to use: these need to match the dimensions of the Istio metric.

+ diff --git a/mixer/adapter/stackdriver/config/adapter.stackdriver.config.pb.html b/mixer/adapter/stackdriver/config/adapter.stackdriver.config.pb.html index 78146e65ae6..1fbc3274f86 100644 --- a/mixer/adapter/stackdriver/config/adapter.stackdriver.config.pb.html +++ b/mixer/adapter/stackdriver/config/adapter.stackdriver.config.pb.html @@ -106,6 +106,76 @@

Params

Stackdriver Trace configuration.

+ + + +endpoint +string + +

Endpoint URL to send stackdriver data - leave empty to use the +StackDriver SDK’s default value (monitoring.googleapis.com).

+ + + + +projectId +string + +

GCP Project to attach metrics to.

+ + + + +appCredentials +bool (oneof) + +

Use Google’s Application Default Credentials to authorize calls made +by the StackDriver SDK.

+ +

See Google’s documentation.

+ + + + +apiKey +string (oneof) + +

The API Key to be used for auth. API Key is no longer supported, use service account instead.

+ + + + +serviceAccountPath +string (oneof) + +

The path to a Google service account credential file, relative to +the Mixer. E.g. /etc/opt/mixer/gcp-serviceaccount-creds.json +or ./testdata/my-test-account-creds.json.

+ + + + +metricInfo +map<string, Params.MetricInfo> + +

A map of Istio metric name to Stackdriver metric info.

+ + + + +logInfo +map<string, Params.LogInfo> + +

A map of Istio LogEntry name to Stackdriver log info.

+ + + + +trace +Params.Trace + +

Stackdriver Trace configuration.

+ @@ -157,6 +227,41 @@

Params.LogInfo

If SinkInfo is provided, Stackriver logs would be exported to that sink.

+ + + +labelNames +string[] + +

The logging template provides a set of variables; these list the subset of variables that should be used to +form Stackdriver labels for the log entry.

+ + + + +payloadTemplate +string + +

A golang text/template template that will be executed to construct the payload for this log entry. +It will be given the full set of variables for the log to use to construct its result.

+ + + + +httpMapping +Params.LogInfo.HttpRequestMapping + +

If an HttpRequestMapping is provided, a HttpRequest object will be filled out for this log entry using the +variables named in the mapping to populate the fields of the request struct from the instance’s variables.

+ + + + +sinkInfo +Params.LogInfo.SinkInfo + +

If SinkInfo is provided, Stackriver logs would be exported to that sink.

+ @@ -254,6 +359,86 @@

Params.LogInfo.HttpRequestMapping

template variable name to map into HTTPRequest.Referer

+ + + +status +string + +

template variable name to map into HTTPRequest.Status

+ + + + +requestSize +string + +

template variable name to map into HTTPRequest.RequestSize

+ + + + +responseSize +string + +

template variable name to map into HTTPRequest.ResponseSize

+ + + + +latency +string + +

template variable name to map into HTTPRequest.Latency

+ + + + +localIp +string + +

template variable name to map into HTTPRequest.LocalIP

+ + + + +remoteIp +string + +

template variable name to map into HTTPRequest.RemoteIP

+ + + + +url +string + +

template variable name to map into HTTPRequest.Request.Url

+ + + + +method +string + +

template variable name to map into HTTPRequest.RequestMethod

+ + + + +userAgent +string + +

template variable name to map into HTTPRequest.UserAgent

+ + + + +referer +string + +

template variable name to map into HTTPRequest.Referer

+ @@ -346,6 +531,73 @@

Params.LogInfo.SinkInfo

Update includes children.

+ + + +id +string + +

Client assigned sink identifier.

+ + + + +destination +string + +

Export Destination.

+ + + + +filter +string + +

Filter that specifies any filtering to be done on logs.

+ + + + +UniqueWriterIdentity +bool + +

Determines the kind of IAM identity returned as WriterIdentity in the new +sink. If this value is omitted or set to false, and if the sink’s parent is a +project, then the value returned as WriterIdentity is the same group or +service account used by Stackdriver Logging before the addition of writer +identities to the API. The sink’s destination must be in the same project as +the sink itself.

+ +

If this field is set to true, or if the sink is owned by a non-project +resource such as an organization, then the value of WriterIdentity will +be a unique service account used only for exports from the new sink.

+ + + + +UpdateDestination +bool + +

These fields apply only to UpdateSinkOpt calls. The corresponding sink field +is updated if and only if the Update field is true. +Upate sink destination.

+ + + + +UpdateFilter +bool + +

Update sink filter.

+ + + + +UpdateIncludeChildren +bool + +

Update includes children.

+ @@ -401,6 +653,44 @@

Params.MetricInfo

concantenation of custom metric prefix (custom.googleapis.com/) and Istio metric name will be used.

+ + + +kind +google.api.MetricDescriptor.MetricKind + +

The kind of measurement for a metric, which describes how the data is reported. Ex: Gauge.

+ + + + +value +google.api.MetricDescriptor.ValueType + +

The type of the metric’s value. Ex: Distribution.

+ + + + +buckets +Params.MetricInfo.BucketsDefinition + +

For metrics with a metric value of DISTRIBUTION, this provides a mechanism +for configuring the buckets that will be used to store the aggregated values. +This field must be provided for metrics declared to be of type DISTRIBUTION. +This field will be ignored for non-distribution metric kinds.

+ + + + +metricType +string + +

Stackdriver metric type name, e.g. +istio.io/service/server/request_count. If this is not provided, a +concantenation of custom metric prefix (custom.googleapis.com/) and +Istio metric name will be used.

+ @@ -443,6 +733,30 @@

Params.MetricInfo.BucketsDefinition

The explicit buckets.

+ + + +linearBuckets +Params.MetricInfo.BucketsDefinition.Linear (oneof) + +

The linear buckets.

+ + + + +exponentialBuckets +Params.MetricInfo.BucketsDefinition.Exponential (oneof) + +

The exponential buckets.

+ + + + +explicitBuckets +Params.MetricInfo.BucketsDefinition.Explicit (oneof) + +

The explicit buckets.

+ @@ -479,6 +793,14 @@

Params.MetricInfo.BucketsD

The values must be monotonically increasing.

+ + + +bounds +double[] + +

The values must be monotonically increasing.

+ @@ -531,6 +853,30 @@

Params.MetricInfo.Bucke

Must be greater than 0.

+ + + +numFiniteBuckets +int32 + +

Must be greater than 0.

+ + + + +growthFactor +double + +

Must be greater than 1.

+ + + + +scale +double + +

Must be greater than 0.

+ @@ -583,6 +929,30 @@

Params.MetricInfo.BucketsDef

Lower bound of the first bucket.

+ + + +numFiniteBuckets +int32 + +

Must be greater than 0.

+ + + + +width +double + +

Must be greater than 0.

+ + + + +offset +double + +

Lower bound of the first bucket.

+ @@ -607,6 +977,14 @@

Params.Trace

Proability that a particular trace ID will be sampled.

+ + + +sampleProbability +double + +

Proability that a particular trace ID will be sampled.

+ @@ -654,6 +1032,38 @@

google.api.MetricDescriptor.Metr value to zero and sets a new start time for the following points.

+ + + +METRIC_KIND_UNSPECIFIED + +

Do not use this default value.

+ + + + +GAUGE + +

An instantaneous measurement of a value.

+ + + + +DELTA + +

The change in a value during a time interval.

+ + + + +CUMULATIVE + +

A value accumulated over a time interval. Cumulative +measurements in a time series should have the same start time +and increasing end times, until an event resets the cumulative +value to zero and sets a new start time for the following +points.

+ @@ -720,6 +1130,57 @@

google.api.MetricDescriptor.Value

The value is money.

+ + + +VALUE_TYPE_UNSPECIFIED + +

Do not use this default value.

+ + + + +BOOL + +

The value is a boolean. +This value type can be used only if the metric kind is GAUGE.

+ + + + +INT64 + +

The value is a signed 64-bit integer.

+ + + + +DOUBLE + +

The value is a double precision floating point number.

+ + + + +STRING + +

The value is a text string. +This value type can be used only if the metric kind is GAUGE.

+ + + + +DISTRIBUTION + +

The value is a Distribution.

+ + + + +MONEY + +

The value is money.

+ diff --git a/mixer/adapter/statsd/config/adapter.statsd.config.pb.html b/mixer/adapter/statsd/config/adapter.statsd.config.pb.html index d4f440a2f1c..0f58b89faa4 100644 --- a/mixer/adapter/statsd/config/adapter.statsd.config.pb.html +++ b/mixer/adapter/statsd/config/adapter.statsd.config.pb.html @@ -75,6 +75,47 @@

Params

Map of metric name -> info. If a metric’s name is not in the map then the metric will not be exported to statsd.

+ + + +address +string + +

Address of the statsd server, e.g. localhost:8125

+ + + + +prefix +string + +

Metric prefix, do not specify for no prefix

+ + + + +flushBytes +int32 + +

Maximum UDP packet size to send; if not specified defaults to 512 bytes. If the statsd server is running on the +same (private) network 1432 bytes is recommended for better performance.

+ + + + +samplingRate +float + +

Chance that any particular metric is sampled when incremented; can take the range [0, 1], defaults to 1 if unspecified.

+ + + + +metrics +map<string, Params.MetricInfo> + +

Map of metric name -> info. If a metric’s name is not in the map then the metric will not be exported to statsd.

+ @@ -111,6 +152,26 @@

Params.MetricInfo

If name_template is the empty string the Istio metric name will be used for statsd metric’s name.

+ + + +type +Params.MetricInfo.Type + + + + +nameTemplate +string + +

The template will be filled with values from the metric’s labels and the resulting string will be used as +the statsd metric name. This allows easier creation of statsd metrics like action_name-response_code. +The template strings must conform to go’s text/template syntax. For the example of action_name-response_code, +we use the template: + {{.apiMethod}}-{{.responseCode}}

+ +

If name_template is the empty string the Istio metric name will be used for statsd metric’s name.

+ @@ -148,6 +209,26 @@

Params.MetricInfo.Type

+ +UNKNOWN + + + + +COUNTER + + + + +GAUGE + + + + +DISTRIBUTION + + + diff --git a/mixer/adapter/stdio/config/adapter.stdio.config.pb.html b/mixer/adapter/stdio/config/adapter.stdio.config.pb.html index e6588f9f5c0..0558bc32f66 100644 --- a/mixer/adapter/stdio/config/adapter.stdio.config.pb.html +++ b/mixer/adapter/stdio/config/adapter.stdio.config.pb.html @@ -131,6 +131,107 @@

Params

The maximum number of old rotated log files to retain. The default is to retain at most 1000 logs. 0 indicates no limit.

+ + + +logStream +Params.Stream + +

Selects which standard stream to write to for log entries. +STDERR is the default Stream.

+ + + + +severityLevels +map<string, Params.Level> + +

Maps from severity strings as specified in LogEntry instances to +the set of levels supported by this adapter. This defaults to a map of

+ +
"INFORMATIONAL" : INFO,
+"informational" : INFO,
+"INFO" : INFO,
+"info" : INFO,
+"WARNING" : WARNING,
+"warning" : WARNING,
+"WARN": WARNING,
+"warning": WARNING,
+"ERROR": ERROR,
+"error": ERROR,
+"ERR": ERROR,
+"err": ERROR,
+"FATAL": ERROR,
+"fatal": ERROR,
+
+ + + + +metricLevel +Params.Level + +

The level to assign to metrics being output. Defaults to INFO.

+ + + + +outputAsJson +bool + +

Whether to output a console-friendly or json-friendly format. Defaults to true.

+ + + + +outputLevel +Params.Level + +

The minimum level to output, anything less than this level is ignored. Defaults to INFO (everything).

+ + + + +outputPath +string + +

The file system path when outputting to a file or rotating file.

+ +

When using rotated log files, this path is used as a foundational path. This is where log +output is normally saved. When a rotation needs to take place because the file got too big +or too old, then the file is renamed by appending a timestamp to the name. Such renamed +files are called backups. Once a backup has been created, output resumes to this path.

+ + + + +maxMegabytesBeforeRotation +int32 + +

The maximum size in megabytes of a log file before it gets +rotated. It defaults to 100 megabytes.

+ + + + +maxDaysBeforeRotation +int32 + +

The maximum number of days to retain old rotated log files based on the +timestamp encoded in their filename. Note that a day is defined as 24 +hours and may not exactly correspond to calendar days due to daylight +savings, leap seconds, etc. The default is to remove log files +older than 30 days. 0 indicates no limit.

+ + + + +maxRotatedFiles +int32 + +

The maximum number of old rotated log files to retain. The default +is to retain at most 1000 logs. 0 indicates no limit.

+ @@ -167,6 +268,27 @@

Params.Level

only error log messages are included

+ + + +INFO + +

informational, warning, and error log messages are included

+ + + + +WARNING + +

warning and error log messges are included

+ + + + +ERROR + +

only error log messages are included

+ @@ -210,6 +332,34 @@

Params.Stream

Output to a specific rotating file, controlled by the various file rotation options.

+ + + +STDOUT + +

Output to the Mixer process’ standard output stream. This is the default value.

+ + + + +STDERR + +

Output to the Mixer process’ standard error stream.

+ + + + +FILE + +

Output to a specific file.

+ + + + +ROTATED_FILE + +

Output to a specific rotating file, controlled by the various file rotation options.

+ diff --git a/mixer/adapter/zipkin/config/adapter.zipkin.config.pb.html b/mixer/adapter/zipkin/config/adapter.zipkin.config.pb.html index dd7a18cb0c8..dc79d07ee1e 100644 --- a/mixer/adapter/zipkin/config/adapter.zipkin.config.pb.html +++ b/mixer/adapter/zipkin/config/adapter.zipkin.config.pb.html @@ -44,6 +44,27 @@

Params

Optional.

+ + + +url +string + +

URL of Zipkin HTTP endpoint.

+ +

Required.

+ + + + +sampleProbability +double + +

Uniform probability that a trace will be sampled. +Defaults to 0 (sampling disabled) if unset.

+ +

Optional.

+ diff --git a/mixer/template/apikey/apiKey.pb.html b/mixer/template/apikey/apiKey.pb.html index 3fd474dbb2b..4ccb2541ea1 100644 --- a/mixer/template/apikey/apiKey.pb.html +++ b/mixer/template/apikey/apiKey.pb.html @@ -78,6 +78,46 @@

Template

Timestamp of API call.

+ + + +api +string + +

The API being called (api.service).

+ + + + +apiVersion +string + +

The version of the API (api.version).

+ + + + +apiOperation +string + +

The API operation is being called.

+ + + + +apiKey +string + +

API key used in API call.

+ + + + +timestamp +istio.policy.v1beta1.TimeStamp + +

Timestamp of API call.

+ diff --git a/mixer/template/authorization/authorization.pb.html b/mixer/template/authorization/authorization.pb.html index 38e18e01ee1..b0766d18a70 100644 --- a/mixer/template/authorization/authorization.pb.html +++ b/mixer/template/authorization/authorization.pb.html @@ -86,6 +86,46 @@

Action

Additional data about the action for use in policy.

+ + + +namespace +string + +

Namespace the target action is taking place in.

+ + + + +service +string + +

The Service the action is being taken on.

+ + + + +method +string + +

What action is being taken.

+ + + + +path +string + +

HTTP REST path within the service

+ + + + +properties +map<string, istio.policy.v1beta1.Value> + +

Additional data about the action for use in policy.

+ @@ -130,6 +170,33 @@

Subject

Additional attributes about the subject.

+ + + +user +string + +

The user name/ID that the subject represents.

+ + + + +groups +string + +

Groups the subject belongs to depending on the authentication mechanism, +“groups” are normally populated from JWT claim or client certificate. +The operator can define how it is populated when creating an instance of +the template.

+ + + + +properties +map<string, istio.policy.v1beta1.Value> + +

Additional attributes about the subject.

+ @@ -169,6 +236,23 @@

Template

An action defines “how a resource is accessed”.

+ + + +subject +Subject + +

A subject contains a list of attributes that identify +the caller identity.

+ + + + +action +Action + +

An action defines “how a resource is accessed”.

+ diff --git a/mixer/template/edge/edge.pb.html b/mixer/template/edge/edge.pb.html index 094b885ae89..347fb73cc95 100644 --- a/mixer/template/edge/edge.pb.html +++ b/mixer/template/edge/edge.pb.html @@ -156,6 +156,110 @@

Template

The protocol type of the API call (http, https, grpc)

+ + + +timestamp +istio.policy.v1beta1.TimeStamp + +

Timestamp of the edge

+ + + + +sourceWorkloadNamespace +string + +

Namespace of the source workload

+ + + + +sourceWorkloadName +string + +

Name of the source workload

+ + + + +sourceOwner +string + +

Owner of the source workload (often k8s deployment)

+ + + + +sourceUid +string + +

UID of the source workload

+ + + + +destinationWorkloadNamespace +string + +

Namespace of the destination workload

+ + + + +destinationWorkloadName +string + +

Name of the destination workload

+ + + + +destinationOwner +string + +

Owner of the destination workload (often k8s deployment)

+ + + + +destinationUid +string + +

UID of the destination workload

+ + + + +destinationServiceNamespace +string + +

Namespace of the destination Service

+ + + + +destinationServiceName +string + +

Name of the destination Service

+ + + + +contextProtocol +string + +

Protocol used for communication (http, tcp)

+ + + + +apiProtocol +string + +

The protocol type of the API call (http, https, grpc)

+ diff --git a/mixer/template/listentry/listEntry.pb.html b/mixer/template/listentry/listEntry.pb.html index 80ccb4b46b7..1955c9fb714 100644 --- a/mixer/template/listentry/listEntry.pb.html +++ b/mixer/template/listentry/listEntry.pb.html @@ -48,6 +48,14 @@

Template

Specifies the entry to verify in the list. This value can either be a string or an IP address.

+ + + +value +istio.policy.v1beta1.Value + +

Specifies the entry to verify in the list. This value can either be a string or an IP address.

+ diff --git a/mixer/template/logentry/logEntry.pb.html b/mixer/template/logentry/logEntry.pb.html index f63bdfb51c9..9239b97ec1c 100644 --- a/mixer/template/logentry/logEntry.pb.html +++ b/mixer/template/logentry/logEntry.pb.html @@ -95,6 +95,50 @@

Template

recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource. Otherwise these fields will be ignored by the adapter.

+ + + +variables +map<string, istio.policy.v1beta1.Value> + +

Variables that are delivered for each log entry.

+ + + + +timestamp +istio.policy.v1beta1.TimeStamp + +

Timestamp is the time value for the log entry

+ + + + +severity +string + +

Severity indicates the importance of the log entry.

+ + + + +monitoredResourceType +string + +

Optional. An expression to compute the type of the monitored resource this log entry is being recorded on. +If the logging backend supports monitored resources, these fields are used to populate that resource. +Otherwise these fields will be ignored by the adapter.

+ + + + +monitoredResourceDimensions +map<string, istio.policy.v1beta1.Value> + +

Optional. A set of expressions that will form the dimensions of the monitored resource this log entry is being +recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource. +Otherwise these fields will be ignored by the adapter.

+ diff --git a/mixer/template/metric/metric.pb.html b/mixer/template/metric/metric.pb.html index 516637c85b5..fff1690914b 100644 --- a/mixer/template/metric/metric.pb.html +++ b/mixer/template/metric/metric.pb.html @@ -81,6 +81,42 @@

Template

If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise these fields will be ignored by the adapter.

+ + + +value +istio.policy.v1beta1.Value + +

The value being reported.

+ + + + +dimensions +map<string, istio.policy.v1beta1.Value> + +

The unique identity of the particular metric to report.

+ + + + +monitoredResourceType +string + +

Optional. An expression to compute the type of the monitored resource this metric is being reported on. +If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise +these fields will be ignored by the adapter.

+ + + + +monitoredResourceDimensions +map<string, istio.policy.v1beta1.Value> + +

Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on. +If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise +these fields will be ignored by the adapter.

+ diff --git a/mixer/template/quota/quota.pb.html b/mixer/template/quota/quota.pb.html index a1cb2b98a5e..51d64f464c8 100644 --- a/mixer/template/quota/quota.pb.html +++ b/mixer/template/quota/quota.pb.html @@ -50,6 +50,14 @@

Template

The unique identity of the particular quota to manipulate.

+ + + +dimensions +map<string, istio.policy.v1beta1.Value> + +

The unique identity of the particular quota to manipulate.

+ diff --git a/mixer/template/tracespan/traceSpan.pb.html b/mixer/template/tracespan/traceSpan.pb.html index f9a0e8e2767..d175b43783f 100644 --- a/mixer/template/tracespan/traceSpan.pb.html +++ b/mixer/template/tracespan/traceSpan.pb.html @@ -264,6 +264,216 @@

Template

Optional.

+ + + +traceId +string + +

Trace ID is the unique identifier for a trace. All spans from the same +trace share the same Trace ID.

+ +

Required.

+ + + + +spanId +string + +

Span ID is the unique identifier for a span within a trace. It is assigned +when the span is created.

+ +

Optional.

+ + + + +parentSpanId +string + +

Parent Span ID is the unique identifier for a parent span of this span +instance. If this is a root span, then this field MUST be empty.

+ +

Optional.

+ + + + +spanName +string + +

Span name is a description of the span’s operation.

+ +

For example, the name can be a qualified method name or a file name +and a line number where the operation is called. A best practice is to use +the same display name within an application and at the same call point. +This makes it easier to correlate spans in different traces.

+ +

Required.

+ + + + +startTime +istio.policy.v1beta1.TimeStamp + +

The start time of the span.

+ +

Required.

+ + + + +endTime +istio.policy.v1beta1.TimeStamp + +

The end time of the span.

+ +

Required.

+ + + + +spanTags +map<string, istio.policy.v1beta1.Value> + +

Span tags are a set of < key, value > pairs that provide metadata for the +entire span. The values can be specified in the form of expressions.

+ +

Optional.

+ + + + +httpStatusCode +int64 + +

HTTP status code used to set the span status. If unset or set to 0, the +span status will be assumed to be successful.

+ + + + +clientSpan +bool + +

client_span indicates the span kind. True for client spans and False or +not provided for server spans. Using bool instead of enum is a temporary +work around since mixer expression language does not yet support enum +type.

+ +

Optional

+ + + + +rewriteClientSpanId +bool + +

rewriteclientspan_id is used to indicate whether to create a new client +span id to accommodate Zipkin shared span model. Some tracing systems like +Stackdriver separates a RPC into client span and server span. To solve this +incompatibility, deterministically rewriting both span id of client span and +parent span id of server span to the same newly generated id.

+ +

Optional

+ + + + +sourceName +string + +

Identifies the source (client side) of this span. +Should usually be set to source.workload.name.

+ +

Optional.

+ + + + +sourceIp +istio.policy.v1beta1.IPAddress + +

Client IP address. Should usually be set to source.ip.

+ +

Optional.

+ + + + +destinationName +string + +

Identifies the destination (server side) of this span. +Should usually be set to destination.workload.name.

+ +

Optional.

+ + + + +destinationIp +istio.policy.v1beta1.IPAddress + +

Server IP address. Should usually be set to destination.ip.

+ +

Optional.

+ + + + +requestSize +int64 + +

Request body size. Should usually be set to request.size.

+ +

Optional.

+ + + + +requestTotalSize +int64 + +

Total request size (headers and body). +Should usually be set to request.total_size.

+ +

Optional.

+ + + + +responseSize +int64 + +

Response body size. Should usually be set to response.size.

+ +

Optional.

+ + + + +responseTotalSize +int64 + +

Response total size (headers and body). +Should usually be set to response.total_size.

+ +

Optional.

+ + + + +apiProtocol +string + +

One of “http”, “https”, or “grpc” or any other value of +the api.protocol attribute. Should usually be set to api.protocol.

+ +

Optional.

+ diff --git a/mixer/test/keyval/keyval.pb.html b/mixer/test/keyval/keyval.pb.html index 479a93869a9..86e4aa59d14 100644 --- a/mixer/test/keyval/keyval.pb.html +++ b/mixer/test/keyval/keyval.pb.html @@ -23,6 +23,14 @@

Params

Lookup table

+ + + +table +map<string, string> + +

Lookup table

+ diff --git a/mixer/test/spyAdapter/template/quota/sampleQuota.pb.html b/mixer/test/spyAdapter/template/quota/sampleQuota.pb.html index 18704b9dfc8..119a64aff26 100644 --- a/mixer/test/spyAdapter/template/quota/sampleQuota.pb.html +++ b/mixer/test/spyAdapter/template/quota/sampleQuota.pb.html @@ -21,6 +21,14 @@

Template

The unique identity of the particular quota to manipulate.

+ + + +dimensions +map<string, istio.policy.v1beta1.Value> + +

The unique identity of the particular quota to manipulate.

+ diff --git a/pkg/test/fakes/policy/policy.pb.html b/pkg/test/fakes/policy/policy.pb.html index ade015e2282..ae53e29e99f 100644 --- a/pkg/test/fakes/policy/policy.pb.html +++ b/pkg/test/fakes/policy/policy.pb.html @@ -34,6 +34,22 @@

Params

Specify route directive related params.

+ + + +checkParams +Params.CheckParams + +

Specify check related params.

+ + + + +table +map<string, string> + +

Specify route directive related params.

+ @@ -74,6 +90,30 @@

Params.CheckParams

Valid request count of the check result.

+ + + +checkAllow +bool + +

Controls that request should be allowed or not.

+ + + + +validDuration +google.protobuf.Duration + +

Valid duration of the check result.

+ + + + +validCount +int64 + +

Valid request count of the check result.

+ diff --git a/security/proto/istio.v1.auth.pb.html b/security/proto/istio.v1.auth.pb.html index 1545d03efbe..82dc6551553 100644 --- a/security/proto/istio.v1.auth.pb.html +++ b/security/proto/istio.v1.auth.pb.html @@ -50,6 +50,30 @@

IstioCertificateRequest

Optional: requested certificate validity period, in seconds.

+ + + +csr +string + +

PEM-encoded certificate request.

+ + + + +subjectId +string + +

Optional subject ID field.

+ + + + +validityDuration +int64 + +

Optional: requested certificate validity period, in seconds.

+ @@ -75,6 +99,15 @@

IstioCertificateResponse

PEM-encoded certificate chain. Leaf cert is element ‘0’. Root cert is element ‘n’.

+ + + +certChain +string[] + +

PEM-encoded certificate chain. +Leaf cert is element ‘0’. Root cert is element ‘n’.

+