From 48e4347e70e324664de4e653be2f2aadb0a83b0e Mon Sep 17 00:00:00 2001 From: Scott Ganyo Date: Thu, 7 Mar 2019 13:36:31 -0800 Subject: [PATCH 1/2] fix EnvoyFilter docs --- networking/v1alpha3/envoy_filter.proto | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/networking/v1alpha3/envoy_filter.proto b/networking/v1alpha3/envoy_filter.proto index acc76ce364..a0aab1b727 100644 --- a/networking/v1alpha3/envoy_filter.proto +++ b/networking/v1alpha3/envoy_filter.proto @@ -35,6 +35,9 @@ import "google/protobuf/struct.proto"; // 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". @@ -63,7 +66,7 @@ package istio.networking.v1alpha3; option go_package = "istio.io/api/networking/v1alpha3"; message EnvoyFilter { - // 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 From 229ce006be8885f6810aadb76df28f95c00dc6cb Mon Sep 17 00:00:00 2001 From: Scott Ganyo Date: Tue, 19 Mar 2019 10:31:31 -0700 Subject: [PATCH 2/2] make docs for proto --- networking/v1alpha3/envoy_filter.pb.go | 5 ++++- networking/v1alpha3/envoy_filter.pb.html | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/networking/v1alpha3/envoy_filter.pb.go b/networking/v1alpha3/envoy_filter.pb.go index f35e7da8ea..5f7a23157f 100644 --- a/networking/v1alpha3/envoy_filter.pb.go +++ b/networking/v1alpha3/envoy_filter.pb.go @@ -16,6 +16,9 @@ // 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". @@ -195,7 +198,7 @@ func (EnvoyFilter_Filter_FilterType) EnumDescriptor() ([]byte, []int) { } type EnvoyFilter struct { - // 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/networking/v1alpha3/envoy_filter.pb.html b/networking/v1alpha3/envoy_filter.pb.html index 2b4a7e7345..d2be82dc02 100644 --- a/networking/v1alpha3/envoy_filter.pb.html +++ b/networking/v1alpha3/envoy_filter.pb.html @@ -21,6 +21,9 @@ 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”.

@@ -59,7 +62,7 @@

EnvoyFilter

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