Adds Service Type to PolicyTargetReference API Docs (#3203)

Previously, only a Gateway resource was defined as a supported attachment type. This PR updates the API docs to include a Service as a supported type and also fixes an incorrect link to Gateway API documentation. Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io> Co-authored-by: Daneyon Hansen <daneyon.hansen@solo.io>
istio · May 16, 2024 · 8eb1f4b · 8eb1f4b
1 parent 628d098
commit 8eb1f4b
Show file tree

Hide file tree

Showing 24 changed files with 99 additions and 78 deletions.
diff --git a/extensions/v1alpha1/wasm.pb.go b/extensions/v1alpha1/wasm.pb.go
diff --git a/extensions/v1alpha1/wasm.pb.html b/extensions/v1alpha1/wasm.pb.html
diff --git a/extensions/v1alpha1/wasm.proto b/extensions/v1alpha1/wasm.proto
@@ -249,12 +249,13 @@ message WasmPlugin {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 15;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/networking/v1alpha3/envoy_filter.pb.go b/networking/v1alpha3/envoy_filter.pb.go
diff --git a/networking/v1alpha3/envoy_filter.pb.html b/networking/v1alpha3/envoy_filter.pb.html
diff --git a/networking/v1alpha3/envoy_filter.proto b/networking/v1alpha3/envoy_filter.proto
@@ -848,12 +848,13 @@ message EnvoyFilter {
   // workloads in any namespace.
   WorkloadSelector workload_selector = 3;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/security/v1/authorization_policy.pb.go b/security/v1/authorization_policy.pb.go
diff --git a/security/v1/authorization_policy.proto b/security/v1/authorization_policy.proto
@@ -288,12 +288,13 @@ message AuthorizationPolicy {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 5;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/security/v1/request_authentication.pb.go b/security/v1/request_authentication.pb.go
diff --git a/security/v1/request_authentication.proto b/security/v1/request_authentication.proto
@@ -259,12 +259,13 @@ message RequestAuthentication {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 3;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/security/v1beta1/authorization_policy.pb.go b/security/v1beta1/authorization_policy.pb.go
diff --git a/security/v1beta1/authorization_policy.pb.html b/security/v1beta1/authorization_policy.pb.html
diff --git a/security/v1beta1/authorization_policy.proto b/security/v1beta1/authorization_policy.proto
@@ -287,12 +287,13 @@ message AuthorizationPolicy {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 5;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/security/v1beta1/request_authentication.pb.go b/security/v1beta1/request_authentication.pb.go
diff --git a/security/v1beta1/request_authentication.pb.html b/security/v1beta1/request_authentication.pb.html
diff --git a/security/v1beta1/request_authentication.proto b/security/v1beta1/request_authentication.proto
@@ -259,12 +259,13 @@ message RequestAuthentication {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 3;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/telemetry/v1/telemetry.pb.go b/telemetry/v1/telemetry.pb.go
diff --git a/telemetry/v1/telemetry.proto b/telemetry/v1/telemetry.proto
@@ -274,12 +274,13 @@ message Telemetry {
   // $hide_from_docs
   istio.type.v1beta1.PolicyTargetReference targetRef = 5;
 
-  // Optional. The targetRef specifies the gateway the policy should be
-  // applied to. The targeted resource specified will determine which
-  // workloads the policy applies to.
+  // Optional. The targetRefs specifies a list of resources the policy should be
+  // applied to. The targeted resources specified will determine which workloads
+  // the policy applies to.
   //
   // Currently, the following resource attachment types are supported:
   // * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
+  // * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
   //
   // If not set, the policy is applied as defined by the selector.
   // At most one of the selector and targetRefs can be set.

diff --git a/telemetry/v1alpha1/telemetry.pb.go b/telemetry/v1alpha1/telemetry.pb.go
diff --git a/telemetry/v1alpha1/telemetry.pb.html b/telemetry/v1alpha1/telemetry.pb.html