diff --git a/kubernetes/customresourcedefinitions.gen.yaml b/kubernetes/customresourcedefinitions.gen.yaml index 1ada8bdaa33..584c368db09 100644 --- a/kubernetes/customresourcedefinitions.gen.yaml +++ b/kubernetes/customresourcedefinitions.gen.yaml @@ -8228,7 +8228,7 @@ spec: nullable: true type: boolean match: - description: Match allows provides the scope of the override. + description: Match allows providing the scope of the override. oneOf: - not: anyOf: @@ -8246,8 +8246,8 @@ spec: minLength: 1 type: string metric: - description: One of the well-known Istio Standard - Metrics. + description: One of the well-known [Istio Standard + Metrics](https://istio.io/latest/docs/reference/config/metrics/). enum: - ALL_METRICS - REQUEST_COUNT @@ -8263,7 +8263,7 @@ spec: type: string mode: description: 'Controls which mode of metrics generation - is selected: CLIENT and/or SERVER.' + is selected: `CLIENT`, `SERVER`, or `CLIENT_AND_SERVER`.' enum: - CLIENT_AND_SERVER - CLIENT diff --git a/telemetry/v1alpha1/telemetry.pb.go b/telemetry/v1alpha1/telemetry.pb.go index 4a0a6343580..21b80bc9767 100644 --- a/telemetry/v1alpha1/telemetry.pb.go +++ b/telemetry/v1alpha1/telemetry.pb.go @@ -41,7 +41,7 @@ // 2. Namespace-specific configuration // 3. Root namespace configuration // -// Examples: +// ## Examples // // Policy to enable random sampling for 10% of traffic: // ```yaml @@ -56,7 +56,7 @@ // - randomSamplingPercentage: 10.00 // ``` // -// Policy to disable trace reporting for the "foo" workload (note: tracing +// Policy to disable trace reporting for the `foo` workload (note: tracing // context will still be propagated): // ```yaml // apiVersion: telemetry.istio.io/v1alpha1 @@ -146,7 +146,7 @@ // value: "request.host" // ``` // -// Policy to remove the response_code dimension on some Prometheus metrics for +// Policy to remove the `response_code` dimension on some Prometheus metrics for // the `bar.foo` workload: // ```yaml // apiVersion: telemetry.istio.io/v1alpha1 @@ -237,10 +237,10 @@ const ( ) // WorkloadMode allows selection of the role of the underlying workload in -// network traffic. A workload is considered as acting as a SERVER if it is +// network traffic. A workload is considered as acting as a `SERVER` if it is // the destination of the traffic (that is, traffic direction, from the // perspective of the workload is *inbound*). If the workload is the source of -// the network traffic, it is considered to be in CLIENT mode (traffic is +// the network traffic, it is considered to be in `CLIENT` mode (traffic is // *outbound* from the workload). type WorkloadMode int32 @@ -460,7 +460,7 @@ type MetricsOverrides_TagOverride_Operation int32 const ( // Insert or Update the tag with the provided value expression. The - // `value` field MUST be specified if UPSERT is used as the operation. + // `value` field MUST be specified if `UPSERT` is used as the operation. MetricsOverrides_TagOverride_UPSERT MetricsOverrides_TagOverride_Operation = 0 // Specifies that the tag should not be included in the metric when // generated. @@ -541,23 +541,23 @@ type Telemetry struct { // // At most, only one of the selector or targetRef can be set for a given policy. Selector *v1beta1.WorkloadSelector `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"` - // Optional. The targetRef specifies the gateway the policy should be + // Optional. The `targetRef` specifies the gateway the policy should be // applied to. The targeted resource specified will determine which // workloads the telemetry policy applies to. The targeted resource - // must be a k8s gateway. The resource must be in the same namespace as + // must be a Kubernetes gateway. The resource must be in the same namespace as // the Telemetry policy. // // If not set, the policy is applied as defined by the selector. - // At most, only one of the selector or targetRef can be set for a given policy. + // At most, only one of the selector or `targetRef` can be set for a given policy. // Waypoint proxies will not respect selectors even if they match. TargetRef *v1beta1.PolicyTargetReference `protobuf:"bytes,5,opt,name=targetRef,proto3" json:"targetRef,omitempty"` // Optional. Tracing configures the tracing behavior for all // selected workloads. Tracing []*Tracing `protobuf:"bytes,2,rep,name=tracing,proto3" json:"tracing,omitempty"` - // Optional. Metrics configure the metrics behavior for all + // Optional. Metrics configures the metrics behavior for all // selected workloads. Metrics []*Metrics `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"` - // Optional. AccessLogging configures the access logging behavior for all + // Optional. Access logging configures the access logging behavior for all // selected workloads. AccessLogging []*AccessLogging `protobuf:"bytes,4,rep,name=access_logging,json=accessLogging,proto3" json:"access_logging,omitempty"` } @@ -764,7 +764,7 @@ type ProviderRef struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // Required. Name of Telemetry provider in MeshConfig. + // Required. Name of Telemetry provider in [MeshConfig](https://istio.io/latest/docs/reference/config/istio.mesh.v1alpha1/#MeshConfig-ExtensionProvider). // +kubebuilder:validation:MinLength=1 Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` } @@ -908,8 +908,8 @@ type MetricSelector struct { // *MetricSelector_Metric // *MetricSelector_CustomMetric MetricMatch isMetricSelector_MetricMatch `protobuf_oneof:"metric_match"` - // Controls which mode of metrics generation is selected: CLIENT and/or - // SERVER. + // Controls which mode of metrics generation is selected: `CLIENT`, `SERVER`, + // or `CLIENT_AND_SERVER`. Mode WorkloadMode `protobuf:"varint,3,opt,name=mode,proto3,enum=istio.telemetry.v1alpha1.WorkloadMode" json:"mode,omitempty"` } @@ -978,7 +978,7 @@ type isMetricSelector_MetricMatch interface { } type MetricSelector_Metric struct { - // One of the well-known Istio Standard Metrics. + // One of the well-known [Istio Standard Metrics](https://istio.io/latest/docs/reference/config/metrics/). Metric MetricSelector_IstioMetric `protobuf:"varint,1,opt,name=metric,proto3,enum=istio.telemetry.v1alpha1.MetricSelector_IstioMetric,oneof"` } @@ -1000,16 +1000,16 @@ type MetricsOverrides struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // Match allows provides the scope of the override. It can be used to select - // individual metrics, as well as the workload modes (server and/or client) + // Match allows providing the scope of the override. It can be used to select + // individual metrics, as well as the workload modes (server, client, or both) // in which the metrics will be generated. // // If match is not specified, the overrides will apply to *all* metrics for // *both* modes of operation (client and server). Match *MetricSelector `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"` - // Optional. Must explicitly set this to "true" to turn off metrics reporting - // for the listed metrics. If disabled has been set to "true" in a parent - // configuration, it must explicitly be set to "false" to turn metrics + // Optional. Must explicitly set this to `true` to turn off metrics reporting + // for the listed metrics. If disabled has been set to `true` in a parent + // configuration, it must explicitly be set to `false` to turn metrics // reporting on in the workloads selected by the Telemetry resource. Disabled *wrappers.BoolValue `protobuf:"bytes,2,opt,name=disabled,proto3" json:"disabled,omitempty"` // Optional. Collection of tag names and tag expressions to override in the @@ -1497,8 +1497,8 @@ type MetricsOverrides_TagOverride struct { Operation MetricsOverrides_TagOverride_Operation `protobuf:"varint,1,opt,name=operation,proto3,enum=istio.telemetry.v1alpha1.MetricsOverrides_TagOverride_Operation" json:"operation,omitempty"` // Value is only considered if the operation is `UPSERT`. // Values are [CEL expressions](https://opensource.google/projects/cel) over - // attributes. Examples include: "string(destination.port)" and - // "request.host". Istio exposes all standard [Envoy + // attributes. Examples include: `string(destination.port)` and + // `request.host`. Istio exposes all standard [Envoy // attributes](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes). // Additionally, Istio exposes node metadata as attributes. // More information is provided in the [customization @@ -1555,9 +1555,9 @@ func (x *MetricsOverrides_TagOverride) GetValue() string { // LogSelector provides a coarse-grained ability to configure logging behavior // based on certain traffic metadata (such as traffic direction). LogSelector // applies to traffic metadata which is not represented in the attribute set -// currently supported by Filters. It allows control planes to limit the -// configuration sent to individual workloads. Finer-grained logging behavior -// can be further configured via `filter`. +// currently supported by [filters](https://istio.io/latest/docs/reference/config/telemetry/#AccessLogging-Filter). +// It allows control planes to limit the configuration sent to individual workloads. +// Finer-grained logging behavior can be further configured via `filter`. type AccessLogging_LogSelector struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache diff --git a/telemetry/v1alpha1/telemetry.pb.html b/telemetry/v1alpha1/telemetry.pb.html index 5a4b049b1e5..47d0c4ade41 100644 --- a/telemetry/v1alpha1/telemetry.pb.html +++ b/telemetry/v1alpha1/telemetry.pb.html @@ -21,7 +21,7 @@
  • Namespace-specific configuration
  • Root namespace configuration
  • -

    Examples:

    +

    Examples

    Policy to enable random sampling for 10% of traffic:

    apiVersion: telemetry.istio.io/v1alpha1
     kind: Telemetry
    @@ -33,7 +33,7 @@
       tracing:
       - randomSamplingPercentage: 10.00
     
    -

    Policy to disable trace reporting for the “foo” workload (note: tracing +

    Policy to disable trace reporting for the foo workload (note: tracing context will still be propagated):

    apiVersion: telemetry.istio.io/v1alpha1
     kind: Telemetry
    @@ -113,7 +113,7 @@
             request_host:
               value: "request.host"
     
    -

    Policy to remove the response_code dimension on some Prometheus metrics for +

    Policy to remove the response_code dimension on some Prometheus metrics for the bar.foo workload:

    apiVersion: telemetry.istio.io/v1alpha1
     kind: Telemetry
    @@ -208,13 +208,13 @@ 

    Telemetry

    targetRef PolicyTargetReference -

    Optional. The targetRef specifies the gateway the policy should be +

    Optional. The targetRef specifies the gateway the policy should be applied to. The targeted resource specified will determine which workloads the telemetry policy applies to. The targeted resource -must be a k8s gateway. The resource must be in the same namespace as +must be a Kubernetes gateway. The resource must be in the same namespace as the Telemetry policy.

    If not set, the policy is applied as defined by the selector. -At most, only one of the selector or targetRef can be set for a given policy. +At most, only one of the selector or targetRef can be set for a given policy. Waypoint proxies will not respect selectors even if they match.

    @@ -238,7 +238,7 @@

    Telemetry

    metrics Metrics[] -

    Optional. Metrics configure the metrics behavior for all +

    Optional. Metrics configures the metrics behavior for all selected workloads.

    @@ -250,7 +250,7 @@

    Telemetry

    accessLogging AccessLogging[] -

    Optional. AccessLogging configures the access logging behavior for all +

    Optional. Access logging configures the access logging behavior for all selected workloads.

    @@ -372,7 +372,7 @@

    ProviderRef

    name string -

    Required. Name of Telemetry provider in MeshConfig.

    +

    Required. Name of Telemetry provider in MeshConfig.

    @@ -470,7 +470,7 @@

    MetricSelector

    metric IstioMetric (oneof) -

    One of the well-known Istio Standard Metrics.

    +

    One of the well-known Istio Standard Metrics.

    @@ -493,8 +493,8 @@

    MetricSelector

    mode WorkloadMode -

    Controls which mode of metrics generation is selected: CLIENT and/or -SERVER.

    +

    Controls which mode of metrics generation is selected: CLIENT, SERVER, +or CLIENT_AND_SERVER.

    @@ -523,8 +523,8 @@

    MetricsOverrides

    match MetricSelector -

    Match allows provides the scope of the override. It can be used to select -individual metrics, as well as the workload modes (server and/or client) +

    Match allows providing the scope of the override. It can be used to select +individual metrics, as well as the workload modes (server, client, or both) in which the metrics will be generated.

    If match is not specified, the overrides will apply to all metrics for both modes of operation (client and server).

    @@ -538,9 +538,9 @@

    MetricsOverrides

    disabled BoolValue -

    Optional. Must explicitly set this to “true” to turn off metrics reporting -for the listed metrics. If disabled has been set to “true” in a parent -configuration, it must explicitly be set to “false” to turn metrics +

    Optional. Must explicitly set this to true to turn off metrics reporting +for the listed metrics. If disabled has been set to true in a parent +configuration, it must explicitly be set to false to turn metrics reporting on in the workloads selected by the Telemetry resource.

    @@ -858,8 +858,8 @@

    MetricsOverrides.TagOverride

    Value is only considered if the operation is UPSERT. Values are CEL expressions over -attributes. Examples include: “string(destination.port)” and -“request.host”. Istio exposes all standard Envoy +attributes. Examples include: string(destination.port) and +request.host. Istio exposes all standard Envoy attributes. Additionally, Istio exposes node metadata as attributes. More information is provided in the customization @@ -878,9 +878,9 @@

    AccessLogging.LogSelector

    LogSelector provides a coarse-grained ability to configure logging behavior based on certain traffic metadata (such as traffic direction). LogSelector applies to traffic metadata which is not represented in the attribute set -currently supported by Filters. It allows control planes to limit the -configuration sent to individual workloads. Finer-grained logging behavior -can be further configured via filter.

    +currently supported by
    filters. +It allows control planes to limit the configuration sent to individual workloads. +Finer-grained logging behavior can be further configured via filter.

    @@ -1111,7 +1111,7 @@

    MetricsOverrides.TagOverride.Ope

    @@ -1129,10 +1129,10 @@

    MetricsOverrides.TagOverride.Ope

    WorkloadMode

    WorkloadMode allows selection of the role of the underlying workload in -network traffic. A workload is considered as acting as a SERVER if it is +network traffic. A workload is considered as acting as a SERVER if it is the destination of the traffic (that is, traffic direction, from the perspective of the workload is inbound). If the workload is the source of -the network traffic, it is considered to be in CLIENT mode (traffic is +the network traffic, it is considered to be in CLIENT mode (traffic is outbound from the workload).

    UPSERT

    Insert or Update the tag with the provided value expression. The -value field MUST be specified if UPSERT is used as the operation.

    +value field MUST be specified if UPSERT is used as the operation.

    diff --git a/telemetry/v1alpha1/telemetry.proto b/telemetry/v1alpha1/telemetry.proto index 99e965371a8..767af82e8f7 100644 --- a/telemetry/v1alpha1/telemetry.proto +++ b/telemetry/v1alpha1/telemetry.proto @@ -42,7 +42,7 @@ import "google/protobuf/wrappers.proto"; // 2. Namespace-specific configuration // 3. Root namespace configuration // -// Examples: +// ## Examples // // Policy to enable random sampling for 10% of traffic: // ```yaml @@ -57,7 +57,7 @@ import "google/protobuf/wrappers.proto"; // - randomSamplingPercentage: 10.00 // ``` // -// Policy to disable trace reporting for the "foo" workload (note: tracing +// Policy to disable trace reporting for the `foo` workload (note: tracing // context will still be propagated): // ```yaml // apiVersion: telemetry.istio.io/v1alpha1 @@ -147,7 +147,7 @@ import "google/protobuf/wrappers.proto"; // value: "request.host" // ``` // -// Policy to remove the response_code dimension on some Prometheus metrics for +// Policy to remove the `response_code` dimension on some Prometheus metrics for // the `bar.foo` workload: // ```yaml // apiVersion: telemetry.istio.io/v1alpha1 @@ -252,14 +252,14 @@ message Telemetry { // At most, only one of the selector or targetRef can be set for a given policy. istio.type.v1beta1.WorkloadSelector selector = 1; - // Optional. The targetRef specifies the gateway the policy should be + // Optional. The `targetRef` specifies the gateway the policy should be // applied to. The targeted resource specified will determine which // workloads the telemetry policy applies to. The targeted resource - // must be a k8s gateway. The resource must be in the same namespace as + // must be a Kubernetes gateway. The resource must be in the same namespace as // the Telemetry policy. // // If not set, the policy is applied as defined by the selector. - // At most, only one of the selector or targetRef can be set for a given policy. + // At most, only one of the selector or `targetRef` can be set for a given policy. // Waypoint proxies will not respect selectors even if they match. istio.type.v1beta1.PolicyTargetReference targetRef = 5; @@ -267,11 +267,11 @@ message Telemetry { // selected workloads. repeated Tracing tracing = 2; - // Optional. Metrics configure the metrics behavior for all + // Optional. Metrics configures the metrics behavior for all // selected workloads. repeated Metrics metrics = 3; - // Optional. AccessLogging configures the access logging behavior for all + // Optional. Access logging configures the access logging behavior for all // selected workloads. repeated AccessLogging access_logging = 4; } @@ -387,7 +387,7 @@ message Tracing { // Used to bind Telemetry configuration to specific providers for // targeted customization. message ProviderRef { - // Required. Name of Telemetry provider in MeshConfig. + // Required. Name of Telemetry provider in [MeshConfig](https://istio.io/latest/docs/reference/config/istio.mesh.v1alpha1/#MeshConfig-ExtensionProvider). // +kubebuilder:validation:MinLength=1 string name = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -424,10 +424,10 @@ message Metrics { } // WorkloadMode allows selection of the role of the underlying workload in -// network traffic. A workload is considered as acting as a SERVER if it is +// network traffic. A workload is considered as acting as a `SERVER` if it is // the destination of the traffic (that is, traffic direction, from the // perspective of the workload is *inbound*). If the workload is the source of -// the network traffic, it is considered to be in CLIENT mode (traffic is +// the network traffic, it is considered to be in `CLIENT` mode (traffic is // *outbound* from the workload). enum WorkloadMode { // Selects for scenarios when the workload is either the @@ -558,7 +558,7 @@ message MetricSelector { // Controls which metric(s) are selected by the selector. oneof metric_match { - // One of the well-known Istio Standard Metrics. + // One of the well-known [Istio Standard Metrics](https://istio.io/latest/docs/reference/config/metrics/). IstioMetric metric = 1; // Allows free-form specification of a metric. No validation of custom @@ -567,8 +567,8 @@ message MetricSelector { string custom_metric = 2; } - // Controls which mode of metrics generation is selected: CLIENT and/or - // SERVER. + // Controls which mode of metrics generation is selected: `CLIENT`, `SERVER`, + // or `CLIENT_AND_SERVER`. WorkloadMode mode = 3; } @@ -576,17 +576,17 @@ message MetricSelector { // metric or the set of all standard metrics. message MetricsOverrides { - // Match allows provides the scope of the override. It can be used to select - // individual metrics, as well as the workload modes (server and/or client) + // Match allows providing the scope of the override. It can be used to select + // individual metrics, as well as the workload modes (server, client, or both) // in which the metrics will be generated. // // If match is not specified, the overrides will apply to *all* metrics for // *both* modes of operation (client and server). MetricSelector match = 1; - // Optional. Must explicitly set this to "true" to turn off metrics reporting - // for the listed metrics. If disabled has been set to "true" in a parent - // configuration, it must explicitly be set to "false" to turn metrics + // Optional. Must explicitly set this to `true` to turn off metrics reporting + // for the listed metrics. If disabled has been set to `true` in a parent + // configuration, it must explicitly be set to `false` to turn metrics // reporting on in the workloads selected by the Telemetry resource. google.protobuf.BoolValue disabled = 2; @@ -598,7 +598,7 @@ message MetricsOverrides { message TagOverride { enum Operation { // Insert or Update the tag with the provided value expression. The - // `value` field MUST be specified if UPSERT is used as the operation. + // `value` field MUST be specified if `UPSERT` is used as the operation. UPSERT = 0; // Specifies that the tag should not be included in the metric when @@ -611,8 +611,8 @@ message MetricsOverrides { // Value is only considered if the operation is `UPSERT`. // Values are [CEL expressions](https://opensource.google/projects/cel) over - // attributes. Examples include: "string(destination.port)" and - // "request.host". Istio exposes all standard [Envoy + // attributes. Examples include: `string(destination.port)` and + // `request.host`. Istio exposes all standard [Envoy // attributes](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/advanced/attributes). // Additionally, Istio exposes node metadata as attributes. // More information is provided in the [customization @@ -637,9 +637,9 @@ message AccessLogging { // LogSelector provides a coarse-grained ability to configure logging behavior // based on certain traffic metadata (such as traffic direction). LogSelector // applies to traffic metadata which is not represented in the attribute set - // currently supported by Filters. It allows control planes to limit the - // configuration sent to individual workloads. Finer-grained logging behavior - // can be further configured via `filter`. + // currently supported by [filters](https://istio.io/latest/docs/reference/config/telemetry/#AccessLogging-Filter). + // It allows control planes to limit the configuration sent to individual workloads. + // Finer-grained logging behavior can be further configured via `filter`. message LogSelector { // This determines whether or not to apply the access logging configuration // based on the direction of traffic relative to the proxied workload.