From 95b5141aadc12798dd23de8f1742309fce509325 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Wed, 3 Jul 2024 18:39:19 -0400 Subject: [PATCH] Fix ObservabilityPolicy TargetRefs documentation Problem: - The documentation for the targetRefs field of ObservabilityPolicy doesn't include GRPCRoute as supported kind. Solution: - Fix that. --- apis/v1alpha1/observabilitypolicy_types.go | 2 +- config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml | 2 +- deploy/crds.yaml | 2 +- site/content/reference/api.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/apis/v1alpha1/observabilitypolicy_types.go b/apis/v1alpha1/observabilitypolicy_types.go index cf34a69da..6e95d28cc 100644 --- a/apis/v1alpha1/observabilitypolicy_types.go +++ b/apis/v1alpha1/observabilitypolicy_types.go @@ -45,7 +45,7 @@ type ObservabilityPolicySpec struct { // TargetRefs identifies the API object(s) to apply the policy to. // Objects must be in the same namespace as the policy. - // Support: HTTPRoute + // Support: HTTPRoute, GRPCRoute. // // +kubebuilder:validation:MaxItems=16 // +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 --git a/config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml b/config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml index cf83c4174..74de2c640 100644 --- a/config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml +++ b/config/crd/bases/gateway.nginx.org_observabilitypolicies.yaml @@ -54,7 +54,7 @@ spec: description: |- TargetRefs identifies the API object(s) to apply the policy to. Objects must be in the same namespace as the policy. - Support: HTTPRoute + Support: HTTPRoute, GRPCRoute. items: description: |- LocalPolicyTargetReference identifies an API object to apply a direct or diff --git a/deploy/crds.yaml b/deploy/crds.yaml index 0da03a830..51ae8b34b 100644 --- a/deploy/crds.yaml +++ b/deploy/crds.yaml @@ -836,7 +836,7 @@ spec: description: |- TargetRefs identifies the API object(s) to apply the policy to. Objects must be in the same namespace as the policy. - Support: HTTPRoute + Support: HTTPRoute, GRPCRoute. items: description: |- LocalPolicyTargetReference identifies an API object to apply a direct or diff --git a/site/content/reference/api.md b/site/content/reference/api.md index af5cbfaf3..fef67d181 100644 --- a/site/content/reference/api.md +++ b/site/content/reference/api.md @@ -416,7 +416,7 @@ Tracing

TargetRefs identifies the API object(s) to apply the policy to. Objects must be in the same namespace as the policy. -Support: HTTPRoute

+Support: HTTPRoute, GRPCRoute.

@@ -949,7 +949,7 @@ Tracing

TargetRefs identifies the API object(s) to apply the policy to. Objects must be in the same namespace as the policy. -Support: HTTPRoute

+Support: HTTPRoute, GRPCRoute.