Skip to content

Commit 2b5bf4c

Browse files
authored
Adds Service Type to PolicyTargetReference API Docs (#3199)
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>
1 parent 4252b0d commit 2b5bf4c

24 files changed

+99
-78
lines changed

extensions/v1alpha1/wasm.pb.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

extensions/v1alpha1/wasm.pb.html

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

extensions/v1alpha1/wasm.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,12 +250,13 @@ message WasmPlugin {
250250
// $hide_from_docs
251251
istio.type.v1beta1.PolicyTargetReference targetRef = 15;
252252

253-
// Optional. The targetRef specifies the gateway the policy should be
254-
// applied to. The targeted resource specified will determine which
255-
// workloads the policy applies to.
253+
// Optional. The targetRefs specifies a list of resources the policy should be
254+
// applied to. The targeted resources specified will determine which workloads
255+
// the policy applies to.
256256
//
257257
// Currently, the following resource attachment types are supported:
258258
// * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
259+
// * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
259260
//
260261
// If not set, the policy is applied as defined by the selector.
261262
// At most one of the selector and targetRefs can be set.

networking/v1alpha3/envoy_filter.pb.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/envoy_filter.pb.html

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

networking/v1alpha3/envoy_filter.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -849,12 +849,13 @@ message EnvoyFilter {
849849
// workloads in any namespace.
850850
WorkloadSelector workload_selector = 3;
851851

852-
// Optional. The targetRef specifies the gateway the policy should be
853-
// applied to. The targeted resource specified will determine which
854-
// workloads the policy applies to.
852+
// Optional. The targetRefs specifies a list of resources the policy should be
853+
// applied to. The targeted resources specified will determine which workloads
854+
// the policy applies to.
855855
//
856856
// Currently, the following resource attachment types are supported:
857857
// * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
858+
// * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
858859
//
859860
// If not set, the policy is applied as defined by the selector.
860861
// At most one of the selector and targetRefs can be set.

security/v1/authorization_policy.pb.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

security/v1/authorization_policy.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,12 +272,13 @@ message AuthorizationPolicy {
272272
// $hide_from_docs
273273
istio.type.v1beta1.PolicyTargetReference targetRef = 5;
274274

275-
// Optional. The targetRef specifies the gateway the policy should be
276-
// applied to. The targeted resource specified will determine which
277-
// workloads the policy applies to.
275+
// Optional. The targetRefs specifies a list of resources the policy should be
276+
// applied to. The targeted resources specified will determine which workloads
277+
// the policy applies to.
278278
//
279279
// Currently, the following resource attachment types are supported:
280280
// * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
281+
// * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
281282
//
282283
// If not set, the policy is applied as defined by the selector.
283284
// At most one of the selector and targetRefs can be set.

security/v1/request_authentication.pb.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

security/v1/request_authentication.proto

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,12 +250,13 @@ message RequestAuthentication {
250250
// $hide_from_docs
251251
istio.type.v1beta1.PolicyTargetReference targetRef = 3;
252252

253-
// Optional. The targetRef specifies the gateway the policy should be
254-
// applied to. The targeted resource specified will determine which
255-
// workloads the policy applies to.
253+
// Optional. The targetRefs specifies a list of resources the policy should be
254+
// applied to. The targeted resources specified will determine which workloads
255+
// the policy applies to.
256256
//
257257
// Currently, the following resource attachment types are supported:
258258
// * `kind: Gateway` with `group: gateway.networking.k8s.io` in the same namespace.
259+
// * `kind: Service` with `""` in the same namespace. This type is only supported for waypoints.
259260
//
260261
// If not set, the policy is applied as defined by the selector.
261262
// At most one of the selector and targetRefs can be set.

0 commit comments

Comments
 (0)