Merge branch 'main' of ssh://github.com/envoyproxy/ai-gateway

Author: siddharth1036

.github/codecov.yml

@@ -14,12 +14,7 @@ coverage:
 ignore:
   - "cmd"
   - "examples"
-  - "**/*.pb.go"
   - "**/zz_generated.*.go"
-  - "tests/internal/envtest.go"
-  - "tests/internal/e2elib/**/*"
-  - "tests/internal/testenvironment/**/*"
-  - "tests/internal/testopeninference/openai_proxy.go"
-  - "tests/internal/testmcp/**/*"
-  - "internal/testing/**/*"
+  - "internal/testing"
+  - "tests/internal"
   - "internal/controller/controller.go"

.github/workflows/build_and_test.yaml

@@ -160,6 +160,7 @@ jobs:
           TEST_AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_BEDROCK_USER_AWS_SECRET_ACCESS_KEY }}
           TEST_OPENAI_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_OPENAI_API_KEY }}
           TEST_GEMINI_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_GEMINI_API_KEY }}
+          TEST_COHERE_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_COHERE_API_KEY }}
           TEST_GROQ_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_GROQ_API_KEY }}
           TEST_GROK_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_GROK_API_KEY }}
           TEST_SAMBANOVA_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_SAMBANOVA_API_KEY }}
@@ -183,6 +184,8 @@ jobs:
         include:
           - name: latest
             envoy_gateway_version: v0.0.0-latest
+          - name: v1.6.0-rc.1
+            envoy_gateway_version: v1.6.0-rc.1
           - name: v1.5.0
             envoy_gateway_version: v1.5.0
     steps:
@@ -207,6 +210,7 @@ jobs:
           TEST_OPENAI_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_OPENAI_API_KEY }}
           TEST_ANTHROPIC_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_ANTHROPIC_API_KEY }}
           TEST_GEMINI_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_GEMINI_API_KEY }}
+          TEST_COHERE_API_KEY: ${{ secrets.ENVOY_AI_GATEWAY_COHERE_API_KEY }}
         run: make test-e2e
 
   test_e2e_upgrade:
@@ -242,7 +246,7 @@ jobs:
       - run: make test-e2e-upgrade
         env:
           # We only need to test the upgrade from the latest stable version of EG.
-          EG_VERSION: v1.5.0
+          EG_VERSION: v1.6.0-rc.1
           K8S_VERSION: ${{ matrix.k8s-version }}
 
   test_e2e_inference_extension:
@@ -270,6 +274,8 @@ jobs:
           key: e2e-test-${{ hashFiles('**/go.mod', '**/go.sum', '**/Makefile') }}
       - uses: docker/setup-buildx-action@v3
       - run: make test-e2e-inference-extension
+        env:
+          EG_VERSION: v1.6.0-rc.1
 
   test_e2e_namespaced:
     needs: changes
@@ -299,7 +305,7 @@ jobs:
         env:
           # We only need to test with the latest stable version of EG, since these e2e tests
           # do not depend on the EG version.
-          EG_VERSION: v1.5.0
+          EG_VERSION: v1.6.0-rc.1
 
   test_e2e_aigw:
     needs: changes

.testcoverage.yml

@@ -16,13 +16,10 @@ exclude:
     - cmd/
     # Generated code should not be tested.
     - zz_generated.deepcopy.go
+    # Generated Kubernetes client code.
+    - api/v1alpha1/client/
     # They are test-only libraries.
-    - tests/internal/envtest.go
-    - tests/internal/gotool.go
-    - tests/internal/e2elib/
-    - tests/internal/testenvironment/
-    - tests/internal/testmcp/
-    - tests/internal/testopeninference/openai_proxy.go
+    - tests/internal/
     - internal/testing/
     # TODO: Remove this exclusion.
     - internal/controller/controller.go

Makefile

@@ -46,7 +46,7 @@ help:
 # This runs all necessary steps to prepare for a commit.
 .PHONY: precommit
 precommit: ## Run all necessary steps to prepare for a commit.
-precommit: tidy spellcheck apigen apidoc format lint editorconfig helm-test
+precommit: tidy spellcheck apigen codegen apidoc format lint editorconfig helm-test
 
 .PHONY: lint
 lint: ## This runs the linter on the codebase.
@@ -116,6 +116,36 @@ apidoc: ## Generate API documentation for the API defined in the api directory.
 		--output-path site/docs/api/api.mdx \
 		--renderer=markdown
 
+# This generates typed client, listers, and informers for the API.
+.PHONY: codegen
+codegen: ## Generate typed client, listers, and informers for the API.
+	@echo "codegen => generating kubernetes clients..."
+	@echo "codegen => generating clientset..."
+	@$(GO_TOOL) client-gen \
+		--clientset-name="versioned" \
+		--input-base="" \
+		--input="github.com/envoyproxy/ai-gateway/api/v1alpha1" \
+		--go-header-file=/dev/null \
+		--output-dir="./api/v1alpha1/client/clientset" \
+		--output-pkg="github.com/envoyproxy/ai-gateway/api/v1alpha1/client/clientset" \
+		--plural-exceptions="BackendSecurityPolicy:BackendSecurityPolicies"
+	@echo "codegen => generating listers..."
+	@$(GO_TOOL) lister-gen \
+		--go-header-file=/dev/null \
+		--output-dir="./api/v1alpha1/client/listers" \
+		--output-pkg="github.com/envoyproxy/ai-gateway/api/v1alpha1/client/listers" \
+		--plural-exceptions="BackendSecurityPolicy:BackendSecurityPolicies" \
+		"github.com/envoyproxy/ai-gateway/api/v1alpha1"
+	@echo "codegen => generating informers..."
+	@$(GO_TOOL) informer-gen \
+		--go-header-file=/dev/null \
+		--versioned-clientset-package="github.com/envoyproxy/ai-gateway/api/v1alpha1/client/clientset/versioned" \
+		--listers-package="github.com/envoyproxy/ai-gateway/api/v1alpha1/client/listers" \
+		--output-dir="./api/v1alpha1/client/informers" \
+		--output-pkg="github.com/envoyproxy/ai-gateway/api/v1alpha1/client/informers" \
+		--plural-exceptions="BackendSecurityPolicy:BackendSecurityPolicies" \
+		"github.com/envoyproxy/ai-gateway/api/v1alpha1"
+	@echo "codegen => complete"
 
 ##@ Testing
 

RELEASES.md

@@ -2,12 +2,15 @@
 
 ## Release Cycles
 
-Since Envoy AI Gateway depends on the Envoy Gateway and Envoy Proxy, we will follow the release cycle of the Envoy Gateway.
-
+Since Envoy AI Gateway depends on the Envoy Gateway and Envoy Proxy, we will normally follow the release cycle of the Envoy Gateway.
 In other words, we aim to cut the release of the Envoy AI Gateway a few days or a week after the new version of the Envoy Gateway is released. Therefore, the release cycle of the Envoy AI Gateway will be approximately every 2-3 months.
 
-We increment the major version number when we have a major architectural change or a major feature addition.
+However, given the rapidly changing nature of the AI ecosystem, we aim to release frequently, as soon as features are available.
+The main branch of Envoy AI Gateway is tested against both the latest stable version of Envoy Gateway and its main branch, allowing us to confidently release the Envoy AI Gateway at any time if needed.
 
+## Versioning
+
+We increment the major version number when we have a major architectural change or a major feature addition.
 Especially when we have a first stable control plane API, we will cut the major v1.0.0 release. Until then, we will use the version number v0.3.x, v0.4.y, etc. See the [support policy](#Support-Policy) for more details.
 
 The patch version will be incremented when we have a bug fix or a security fix. The end of life for the version will be 2 releases after the release of the version. For example, if we release the version v0.1.0, the end of life for the version will be when we release the version v0.3.0.
@@ -28,11 +31,12 @@ First of all, there are four areas of compatibility that we are concerned with:
 
 ### Public Go package
 
-Since we do not envision this repository ends up as a transitive dependency, i.e. only used as a direct dependency such as in a custom control plane, etc., we assume that any consumer of the project should have the full control over the source code depending on the project. This allows us to declare deprecation and introduce the breaking changes in the version after the next one since they can migrate the code at their discretion. For example, any public API that is marked as deprecated in the version N will be removed in the version N+2. We document how users should migrate to the new API will be documented in the release notes if applicable, but we do not guarantee that the migration path will be provided.
+We do not guarantee any compatibility at Go level except for the api package as described below.
+Any other public Go package is solely intended for the internal use, e.g. for testing purpose.
 
-### Custom Resource Definitions
+### Custom Resource Definitions (CRDs) / `api` package
 
-The Custom Resource Definitions (CRDs) are defined in api/${version}/\*.go files. The CRDs are versioned as v1alpha1, v1alpha2, etc.
+The Custom Resource Definitions (CRDs) are defined in `api/${version}/*.go` files. The CRDs are versioned as v1alpha1, v1alpha2, etc.
 
 **For alpha versions**, we simply employ the same deprecation policy as the Go package. In other words, the APIs will be marked as deprecated in the version N and will be removed in the version N+2 but without any guarantee of migration path.
 

api/v1alpha1/ai_gateway_route.go

@@ -29,6 +29,8 @@ import (
 // Gateway to patch the generated resources. For example, you can configure the retry fallback behavior by attaching
 // BackendTrafficPolicy API of Envoy Gateway to the generated HTTPRoute.
 //
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[-1:].type`
@@ -43,6 +45,7 @@ type AIGatewayRoute struct {
 
 // AIGatewayRouteList contains a list of AIGatewayRoute.
 //
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 type AIGatewayRouteList struct {
 	metav1.TypeMeta `json:",inline"`

api/v1alpha1/ai_service_backend.go

@@ -19,6 +19,8 @@ import (
 // HTTPRouteSpec defined in the AIGatewayRoute), the ai-gateway will generate the necessary configuration to do
 // the backend specific logic in the final HTTPRoute.
 //
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[-1:].type`
@@ -33,6 +35,7 @@ type AIServiceBackend struct {
 
 // AIServiceBackendList contains a list of AIServiceBackends.
 //
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 type AIServiceBackendList struct {
 	metav1.TypeMeta `json:",inline"`

api/v1alpha1/backendsecurity_policy.go

@@ -27,6 +27,8 @@ const (
 // BackendSecurityPolicy specifies configuration for authentication and authorization rules on the traffic
 // exiting the gateway to the backend.
 //
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[-1:].type`
@@ -99,6 +101,7 @@ type BackendSecurityPolicySpec struct {
 
 // BackendSecurityPolicyList contains a list of BackendSecurityPolicy
 //
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 type BackendSecurityPolicyList struct {
 	metav1.TypeMeta `json:",inline"`