update documentation and tests

envoyproxy · Dec 16, 2024 · 19c1337 · 19c1337
1 parent bc0dadd
commit 19c1337
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 10 deletions.
diff --git a/api/v1alpha1/api.go b/api/v1alpha1/api.go
@@ -107,9 +107,11 @@ type LLMBackendSpec struct {
 	// +kubebuilder:validation:Required
 	BackendRef egv1a1.BackendRef `json:"backendRef"`
 
-	// LLMSecurityPolicyName list the LLMSecurityPolicy that this backend will depend on
+	// SecurityPolicyName list the LLMSecurityPolicy that this backend will depend on.
 	//
-	LLMSecurityPolicyName *string `json:"llmSecurityPolicyName,omitempty"`
+	// A SecurityPolicy specifies authentication, JWT, and API Key.
+	//
+	SecurityPolicyName *string `json:"securityPolicyName,omitempty"`
 }
 
 // LLMAPISchema defines the API schema of either LLMRoute (the input) or LLMBackend (the output).
@@ -158,7 +160,7 @@ const (
 
 // +kubebuilder:object:root=true
 
-// LLMSecurityPolicy specifies the provider specific configuration.
+// LLMSecurityPolicy specifies the provider specific configuration like authorization, JWT, and API Key.
 type LLMSecurityPolicy struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/manifests/charts/ai-gateway-helm/crds/aigateway.envoyproxy.io_llmbackends.yaml b/manifests/charts/ai-gateway-helm/crds/aigateway.envoyproxy.io_llmbackends.yaml
@@ -131,10 +131,6 @@ spec:
                 - message: Must have port for Service reference
                   rule: '(size(self.group) == 0 && self.kind == ''Service'') ? has(self.port)
                     : true'
-              llmSecurityPolicyName:
-                description: LLMSecurityPolicyName list the LLMSecurityPolicy that
-                  this backend will depend on
-                type: string
               outputSchema:
                 description: |-
                   APISchema specifies the API schema of the output format of requests from
@@ -156,6 +152,12 @@ spec:
                 required:
                 - schema
                 type: object
+              securityPolicyName:
+                description: |-
+                  SecurityPolicyName list the LLMSecurityPolicy that this backend will depend on.
+
+                  A SecurityPolicy specifies authentication, JWT, and API Key.
+                type: string
             required:
             - backendRef
             - outputSchema

diff --git a/manifests/charts/ai-gateway-helm/crds/aigateway.envoyproxy.io_llmsecuritypolicies.yaml b/manifests/charts/ai-gateway-helm/crds/aigateway.envoyproxy.io_llmsecuritypolicies.yaml
@@ -17,7 +17,8 @@ spec:
   - name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: LLMSecurityPolicy specifies the provider specific configuration.
+        description: LLMSecurityPolicy specifies the provider specific configuration
+          like authorization, JWT, and API Key.
         properties:
           apiVersion:
             description: |-