From 009f96806bfc3976108e9a5622bda226e4bd3b30 Mon Sep 17 00:00:00 2001 From: Shriram Rajagopalan Date: Tue, 19 Mar 2019 11:04:07 -0400 Subject: [PATCH] last minute doc fixes Signed-off-by: Shriram Rajagopalan --- networking/v1alpha3/envoy_filter.pb.go | 19 ++++++++++--------- networking/v1alpha3/envoy_filter.pb.html | 21 +++++++++++---------- networking/v1alpha3/envoy_filter.proto | 19 ++++++++++--------- networking/v1alpha3/sidecar.pb.go | 3 +-- networking/v1alpha3/sidecar.pb.html | 3 +-- networking/v1alpha3/sidecar.proto | 3 +-- networking/v1alpha3/virtual_service.pb.go | 6 +++--- networking/v1alpha3/virtual_service.pb.html | 6 +++--- networking/v1alpha3/virtual_service.proto | 6 +++--- 9 files changed, 43 insertions(+), 43 deletions(-) diff --git a/networking/v1alpha3/envoy_filter.pb.go b/networking/v1alpha3/envoy_filter.pb.go index bbe92a378f3..f35e7da8ea4 100644 --- a/networking/v1alpha3/envoy_filter.pb.go +++ b/networking/v1alpha3/envoy_filter.pb.go @@ -17,7 +17,7 @@ // with each other. // // The following example for Kubernetes enables Envoy's Lua filter for all -// inbound calls arriving at service port 8080 of the reviews service pod with +// inbound HTTP calls arriving at service port 8080 of the reviews service pod with // labels "app: reviews". // // ```yaml @@ -32,6 +32,7 @@ // - listenerMatch: // portNumber: 8080 // listenerType: SIDECAR_INBOUND # will match with the inbound listener for reviews:8080 +// listenerProtocol: HTTP // filterName: envoy.lua // filterType: HTTP // filterConfig: @@ -200,9 +201,6 @@ type EnvoyFilter struct { // example, the scope includes pods running in all reachable // namespaces. Omitting the selector applies the filter to all proxies in // the mesh. - // NOTE: There can be only one EnvoyFilter bound to a specific workload. - // The behavior is undefined if multiple EnvoyFilter configurations are - // specified for the same workload. WorkloadLabels map[string]string `protobuf:"bytes,1,rep,name=workload_labels,json=workloadLabels,proto3" json:"workload_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // REQUIRED: Envoy network filters/http filters to be added to matching // listeners. When adding network filters to http connections, care @@ -278,11 +276,11 @@ type EnvoyFilter_ListenerMatch struct { // Inbound vs outbound sidecar listener or gateway listener. If not specified, // matches all listeners. ListenerType EnvoyFilter_ListenerMatch_ListenerType `protobuf:"varint,3,opt,name=listener_type,json=listenerType,proto3,enum=istio.networking.v1alpha3.EnvoyFilter_ListenerMatch_ListenerType" json:"listener_type,omitempty"` - // Selects a class of listeners for the same protocol. If not - // specified, applies to listeners on all protocols. Use the protocol + // Selects a class of listeners for the same protocol. Use the protocol // selection to select all HTTP listeners (includes HTTP2/gRPC/HTTPS // where Envoy terminates TLS) or all TCP listeners (includes HTTPS - // passthrough using SNI). + // passthrough using SNI). When adding a HTTP filter, the listenerProtocol + // should be set to HTTP. ListenerProtocol EnvoyFilter_ListenerMatch_ListenerProtocol `protobuf:"varint,4,opt,name=listener_protocol,json=listenerProtocol,proto3,enum=istio.networking.v1alpha3.EnvoyFilter_ListenerMatch_ListenerProtocol" json:"listener_protocol,omitempty"` // One or more IP addresses to which the listener is bound. If // specified, should match at least one address in the list. @@ -421,8 +419,11 @@ func (m *EnvoyFilter_InsertPosition) GetRelativeTo() string { // Envoy filters to be added to a network or http filter chain. type EnvoyFilter_Filter struct { - // Filter will be added to the listener only if the match conditions are true. - // If not specified, the filters will be applied to all listeners. + // Filter will be added to the listener only if the match + // conditions are true. If not specified, the filters will be + // applied to all listeners where possible, potentially resulting + // in invalid configurations. It is recommended to specify the + // listener match criteria for all filter insertions. ListenerMatch *EnvoyFilter_ListenerMatch `protobuf:"bytes,1,opt,name=listener_match,json=listenerMatch,proto3" json:"listener_match,omitempty"` // Insert position in the filter chain. Defaults to FIRST InsertPosition *EnvoyFilter_InsertPosition `protobuf:"bytes,2,opt,name=insert_position,json=insertPosition,proto3" json:"insert_position,omitempty"` diff --git a/networking/v1alpha3/envoy_filter.pb.html b/networking/v1alpha3/envoy_filter.pb.html index 3144a0d15d2..2b4a7e7345d 100644 --- a/networking/v1alpha3/envoy_filter.pb.html +++ b/networking/v1alpha3/envoy_filter.pb.html @@ -22,7 +22,7 @@ with each other.

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

apiVersion: networking.istio.io/v1alpha3
@@ -36,6 +36,7 @@
   - listenerMatch:
       portNumber: 8080
       listenerType: SIDECAR_INBOUND # will match with the inbound listener for reviews:8080
+      listenerProtocol: HTTP
     filterName: envoy.lua
     filterType: HTTP
     filterConfig:
@@ -63,10 +64,7 @@ 
EnvoyFilter

 scope of label search is platform dependent. On Kubernetes, for
 example, the scope includes pods running in all reachable
 namespaces. Omitting the selector applies the filter to all proxies in
-the mesh.
-NOTE: There can be only one EnvoyFilter bound to a specific workload.
-The behavior is undefined if multiple EnvoyFilter configurations are
-specified for the same workload.

+the mesh.

 
 
 
@@ -101,8 +99,11 @@ 
EnvoyFilter.Filter

 listenerMatch
 EnvoyFilter.ListenerMatch
 
-
Filter will be added to the listener only if the match conditions are true.
-If not specified, the filters will be applied to all listeners.

+
Filter will be added to the listener only if the match
+conditions are true.  If not specified, the filters will be
+applied to all listeners where possible, potentially resulting
+in invalid configurations. It is recommended to specify the
+listener match criteria for all filter insertions.

 
 
 
@@ -303,11 +304,11 @@ 
EnvoyFilter.ListenerMatch

 listenerProtocol
 EnvoyFilter.ListenerMatch.ListenerProtocol
 
-
Selects a class of listeners for the same protocol. If not
-specified, applies to listeners on all protocols. Use the protocol
+
Selects a class of listeners for the same protocol. Use the protocol
 selection to select all HTTP listeners (includes HTTP2/gRPC/HTTPS
 where Envoy terminates TLS) or all TCP listeners (includes HTTPS
-passthrough using SNI).

+passthrough using SNI). When adding a HTTP filter, the listenerProtocol
+should be set to HTTP.

 
 
 
diff --git a/networking/v1alpha3/envoy_filter.proto b/networking/v1alpha3/envoy_filter.proto
index 6f271d1f0a9..acc76ce364a 100644
--- a/networking/v1alpha3/envoy_filter.proto
+++ b/networking/v1alpha3/envoy_filter.proto
@@ -36,7 +36,7 @@ import "google/protobuf/struct.proto";
 // with each other.
 //
 // The following example for Kubernetes enables Envoy's Lua filter for all
-// inbound calls arriving at service port 8080 of the reviews service pod with
+// inbound HTTP calls arriving at service port 8080 of the reviews service pod with
 // labels "app: reviews".
 //
 // ```yaml
@@ -51,6 +51,7 @@ import "google/protobuf/struct.proto";
 //   - listenerMatch:
 //       portNumber: 8080
 //       listenerType: SIDECAR_INBOUND # will match with the inbound listener for reviews:8080
+//       listenerProtocol: HTTP
 //     filterName: envoy.lua
 //     filterType: HTTP
 //     filterConfig:
@@ -68,9 +69,6 @@ message EnvoyFilter {
   // example, the scope includes pods running in all reachable
   // namespaces. Omitting the selector applies the filter to all proxies in
   // the mesh.
-  // NOTE: There can be only one EnvoyFilter bound to a specific workload.
-  // The behavior is undefined if multiple EnvoyFilter configurations are
-  // specified for the same workload.
   map workload_labels = 1;
 
   // Select a listener to add the filter to based on the match conditions.
@@ -116,11 +114,11 @@ message EnvoyFilter {
       TCP = 2;
     };
 
-    // Selects a class of listeners for the same protocol. If not
-    // specified, applies to listeners on all protocols. Use the protocol
+    // Selects a class of listeners for the same protocol. Use the protocol
     // selection to select all HTTP listeners (includes HTTP2/gRPC/HTTPS
     // where Envoy terminates TLS) or all TCP listeners (includes HTTPS
-    // passthrough using SNI).
+    // passthrough using SNI). When adding a HTTP filter, the listenerProtocol
+    // should be set to HTTP.
     ListenerProtocol listener_protocol = 4;
 
     // One or more IP addresses to which the listener is bound. If
@@ -155,8 +153,11 @@ message EnvoyFilter {
 
   // Envoy filters to be added to a network or http filter chain.
   message Filter {
-    // Filter will be added to the listener only if the match conditions are true.
-    // If not specified, the filters will be applied to all listeners.
+    // Filter will be added to the listener only if the match
+    // conditions are true.  If not specified, the filters will be
+    // applied to all listeners where possible, potentially resulting
+    // in invalid configurations. It is recommended to specify the
+    // listener match criteria for all filter insertions.
     ListenerMatch listener_match = 1;
 
     // Insert position in the filter chain. Defaults to FIRST
diff --git a/networking/v1alpha3/sidecar.pb.go b/networking/v1alpha3/sidecar.pb.go
index dfc84815f84..8253f56fe1e 100644
--- a/networking/v1alpha3/sidecar.pb.go
+++ b/networking/v1alpha3/sidecar.pb.go
@@ -239,8 +239,7 @@ func (CaptureMode) EnumDescriptor() ([]byte, []int) {
 type Sidecar struct {
 	// Criteria used to select the specific set of pods/VMs on which this
 	// sidecar configuration should be applied. If omitted, the sidecar
-	// configuration will be applied to all workloads in the same config
-	// namespace.
+	// configuration will be applied to all workloads in the same namespace.
 	WorkloadSelector *WorkloadSelector `protobuf:"bytes,1,opt,name=workload_selector,json=workloadSelector,proto3" json:"workload_selector,omitempty"`
 	// Ingress specifies the configuration of the sidecar for processing
 	// inbound traffic to the attached workload. If omitted, Istio will
diff --git a/networking/v1alpha3/sidecar.pb.html b/networking/v1alpha3/sidecar.pb.html
index a4a209a5bfb..229a3860c68 100644
--- a/networking/v1alpha3/sidecar.pb.html
+++ b/networking/v1alpha3/sidecar.pb.html
@@ -380,8 +380,7 @@ 
Sidecar

 
 
Criteria used to select the specific set of pods/VMs on which this
 sidecar configuration should be applied. If omitted, the sidecar
-configuration will be applied to all workloads in the same config
-namespace.

+configuration will be applied to all workloads in the same namespace.

 
 
 
diff --git a/networking/v1alpha3/sidecar.proto b/networking/v1alpha3/sidecar.proto
index 3e05e714a23..85d8b26fa0d 100644
--- a/networking/v1alpha3/sidecar.proto
+++ b/networking/v1alpha3/sidecar.proto
@@ -204,8 +204,7 @@ option go_package = "istio.io/api/networking/v1alpha3";
 message Sidecar {
   // Criteria used to select the specific set of pods/VMs on which this
   // sidecar configuration should be applied. If omitted, the sidecar
-  // configuration will be applied to all workloads in the same config
-  // namespace.
+  // configuration will be applied to all workloads in the same namespace.
   WorkloadSelector workload_selector = 1;
 
   // Ingress specifies the configuration of the sidecar for processing
diff --git a/networking/v1alpha3/virtual_service.pb.go b/networking/v1alpha3/virtual_service.pb.go
index e6e308c54c4..e39c6392512 100644
--- a/networking/v1alpha3/virtual_service.pb.go
+++ b/networking/v1alpha3/virtual_service.pb.go
@@ -1641,9 +1641,9 @@ func (m *TLSMatchAttributes) GetGateways() []string {
 //   - match:
 //     - uri:
 //         exact: /v1/getProductRatings
-//   redirect:
-//     uri: /v1/bookRatings
-//     authority: newratings.default.svc.cluster.local
+//     redirect:
+//       uri: /v1/bookRatings
+//       authority: newratings.default.svc.cluster.local
 //   ...
 // ```
 type HTTPRedirect struct {
diff --git a/networking/v1alpha3/virtual_service.pb.html b/networking/v1alpha3/virtual_service.pb.html
index ab9cb8215c5..aa61515fe10 100644
--- a/networking/v1alpha3/virtual_service.pb.html
+++ b/networking/v1alpha3/virtual_service.pb.html
@@ -734,9 +734,9 @@ 
HTTPRedirect

   - match:
     - uri:
         exact: /v1/getProductRatings
-  redirect:
-    uri: /v1/bookRatings
-    authority: newratings.default.svc.cluster.local
+    redirect:
+      uri: /v1/bookRatings
+      authority: newratings.default.svc.cluster.local
   ...
diff --git a/networking/v1alpha3/virtual_service.proto b/networking/v1alpha3/virtual_service.proto index 29562447e49..bae9cce4fa9 100644 --- a/networking/v1alpha3/virtual_service.proto +++ b/networking/v1alpha3/virtual_service.proto @@ -814,9 +814,9 @@ message TLSMatchAttributes { // - match: // - uri: // exact: /v1/getProductRatings -// redirect: -// uri: /v1/bookRatings -// authority: newratings.default.svc.cluster.local +// redirect: +// uri: /v1/bookRatings +// authority: newratings.default.svc.cluster.local // ... // ``` message HTTPRedirect {