Skip to content

Commit a5507f7

Browse files
authored
Fix ObservabilityPolicy TargetRefs documentation (#2202)
Problem: - The documentation for the targetRefs field of ObservabilityPolicy doesn't include GRPCRoute as supported kind. Solution: - Fix that.
1 parent 7bc0b6e commit a5507f7

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

Diff for: apis/v1alpha1/observabilitypolicy_types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type ObservabilityPolicySpec struct {
4545

4646
// TargetRefs identifies the API object(s) to apply the policy to.
4747
// Objects must be in the same namespace as the policy.
48-
// Support: HTTPRoute
48+
// Support: HTTPRoute, GRPCRoute.
4949
//
5050
// +kubebuilder:validation:MaxItems=16
5151
// +kubebuilder:validation:XValidation:message="TargetRef Kind must be: HTTPRoute or GRPCRoute",rule="(self.exists(t, t.kind=='HTTPRoute') || self.exists(t, t.kind=='GRPCRoute'))"

Diff for: config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ spec:
5454
description: |-
5555
TargetRefs identifies the API object(s) to apply the policy to.
5656
Objects must be in the same namespace as the policy.
57-
Support: HTTPRoute
57+
Support: HTTPRoute, GRPCRoute.
5858
items:
5959
description: |-
6060
LocalPolicyTargetReference identifies an API object to apply a direct or

Diff for: deploy/crds.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -836,7 +836,7 @@ spec:
836836
description: |-
837837
TargetRefs identifies the API object(s) to apply the policy to.
838838
Objects must be in the same namespace as the policy.
839-
Support: HTTPRoute
839+
Support: HTTPRoute, GRPCRoute.
840840
items:
841841
description: |-
842842
LocalPolicyTargetReference identifies an API object to apply a direct or

Diff for: site/content/reference/api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ Tracing
416416
<td>
417417
<p>TargetRefs identifies the API object(s) to apply the policy to.
418418
Objects must be in the same namespace as the policy.
419-
Support: HTTPRoute</p>
419+
Support: HTTPRoute, GRPCRoute.</p>
420420
</td>
421421
</tr>
422422
</table>
@@ -949,7 +949,7 @@ Tracing
949949
<td>
950950
<p>TargetRefs identifies the API object(s) to apply the policy to.
951951
Objects must be in the same namespace as the policy.
952-
Support: HTTPRoute</p>
952+
Support: HTTPRoute, GRPCRoute.</p>
953953
</td>
954954
</tr>
955955
</tbody>

0 commit comments

Comments
 (0)