MAJOR: add support for CRD v3

Keep support for CRD v1 that are migrated internally to v3

Author: hdurand0710

.gitlab-ci.yml

@@ -7,6 +7,7 @@ stages:
   - e2e_k8s_30
   - e2e_k8s_31
   - e2e_k8s_32
+  - e2e_crd_versions
 variables:
   KIND: v0.26.0
   DOCKER_HOST: tcp://docker:2375
@@ -202,8 +203,6 @@ docker-build:
     - echo "running make -f Makefile.ci ci-e2e-$TEST_PART tests" && make -f Makefile.ci ci-e2e-$TEST_PART
 .kind_deployment_schedules:
   extends: .kind_deployment
-  rules:
-   - if: $CI_PIPELINE_SOURCE == "schedule"
   allow_failure: true
 e2e_k8s_30:
   stage: e2e_k8s_30
@@ -213,6 +212,8 @@ e2e_k8s_30:
     KUBEADM_VER: v1beta3
     KUBECTL: v1.30.4
   extends: .kind_deployment_schedules
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULE_TYPE == 'weekly' &&  $SCHEDULE_DAY == 'monday'
 e2e_k8s_31:
   stage: e2e_k8s_31
   needs: ["docker-build"]
@@ -221,6 +222,8 @@ e2e_k8s_31:
     KUBEADM_VER: v1beta3
     KUBECTL: v1.31.0
   extends: .kind_deployment_schedules
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULE_TYPE == 'weekly' &&  $SCHEDULE_DAY == 'tuesday'
 e2e_k8s_32:
   stage: e2e_k8s_32
   needs: ["docker-build"]
@@ -229,3 +232,16 @@ e2e_k8s_32:
     KUBEADM_VER: v1beta3
     KUBECTL: v1.31.0
   extends: .kind_deployment
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULE_TYPE == 'weekly' &&  $SCHEDULE_DAY == 'wednesday'
+e2e_crd_v1:
+  stage: e2e_crd_versions
+  needs: ["docker-build"]
+  variables:
+    K8S_VERSION: v1.32.0
+    KUBEADM_VER: v1beta3
+    KUBECTL: v1.31.0
+    CRD_VERSION: v1
+  extends: .kind_deployment_schedules
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule" && $SCHEDULE_TYPE == 'weekly' &&  $SCHEDULE_DAY == 'thursday'

Makefile

@@ -15,6 +15,13 @@ e2e:
 	go test ./... --tags=e2e_parallel,e2e_https
 	go test ./... -p 1 --tags=e2e_sequential
 
+.PHONY: e2e_crd_v1
+e2e_crd_v1:
+	go clean -testcache
+	CRD_VERSION=v1 go test ./... --tags=e2e_parallel,e2e_https
+	CRD_VERSION=v1 go test ./... -p 1 --tags=e2e_sequential
+
+
 .PHONY: tidy
 tidy:
 	go mod tidy
@@ -79,7 +86,7 @@ build-pebble:
 ### Can be used for example to use `go replace` and build with a local library,
 .PHONY: build-dev
 build-dev:
-	GOOS=$(GOSS) GOARCH=$(GOARCH) CGO_ENABLED='0' go build .
+	GOOS=$(GOOS) GOARCH=$(GOARCH) CGO_ENABLED='0' go build .
 	docker build -t haproxytech/kubernetes-ingress --build-arg TARGETPLATFORM=$(TARGETPLATFORM) -f build/Dockerfile.dev .
 
 .PHONY: publish

crs/README.md

@@ -37,14 +37,14 @@ crs
 
 ### GoLang Type
 
-In this guide the API group is `ingress.v1.haproxy.org` (this group is used for any resource dealing with haproxy configuration) and the API version is `v1`.
+In this guide the API group is `ingress.v3.haproxy.org` (this group is used for any resource dealing with haproxy configuration) and the API version is `v3`.
 So to follow the */crs/api/<group>/<version>/* convention, the GoLang Type describing the `Global` CR should be in *crs/api/ingress/v1/global.go* with the following content:
 
 ```go
-package v1
+package v3
 
 import (
-  "github.com/haproxytech/client-native/v5/models"
+  "github.com/haproxytech/client-native/v6/models"
   metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -101,14 +101,14 @@ The tool we are using is [k8s.io/code-generator](https://github.com/kubernetes/c
 - lister-gen: generates lister methods which provide a read-only caching layer for GET and LIST requests.
 
 Before generating code, some global tags need to be set in the package of the versioned API group which should be in *crs/api/<group>/<version>/* directory.
-Usually this goes into the package's doc.go, so in this case it would be in *crs/api/ingress/v1/doc.go* with the following content:
+Usually this goes into the package's doc.go, so in this case it would be in *crs/api/ingress/v3/doc.go* with the following content:
 
 ```yml
-// Package v1 contains the core v1 API group
+// Package v3 contains the core v3 API group
 //
 // +k8s:deepcopy-gen=package
-// +groupName=ingress.v1.haproxy.org
-package v1
+// +groupName=ingress.v3.haproxy.org
+package v3
 ```
 
 In addition to including a number of global code generation tags, "doc.go" is used to describe the API group's purpose.

crs/api/core/v1alpha2/doc.go

@@ -13,15 +13,16 @@
 // limitations under the License.
 //
 
-package v1alpha2
+package v3
 
 import (
-	"github.com/haproxytech/client-native/v3/models"
+	"github.com/haproxytech/client-native/v6/models"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:metadata:annotations="haproxy.org/client-native=v6.0.7-0.20250113083507-df8f78bea9bb"
 
 // Backend is a specification for a Backend resource
 type Backend struct {
@@ -32,16 +33,13 @@ type Backend struct {
 
 // BackendSpec defines the desired state of Backend
 type BackendSpec struct {
-	Config *models.Backend `json:"config"`
+	models.Backend `json:",inline"`
 }
 
 // DeepCopyInto deepcopying  the receiver into out. in must be non-nil.
 func (in *BackendSpec) DeepCopyInto(out *BackendSpec) {
-	*out = *in
-	if in.Config != nil {
-		b, _ := in.Config.MarshalBinary()
-		_ = out.Config.UnmarshalBinary(b)
-	}
+	b, _ := in.MarshalBinary()
+	_ = out.Backend.UnmarshalBinary(b)
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

crs/api/core/v1alpha2/backend.go crs/api/ingress/v3/backend.gocrs/api/core/v1alpha2/backend.go renamed to crs/api/ingress/v3/backend.go

@@ -13,15 +13,16 @@
 // limitations under the License.
 //
 
-package v1alpha2
+package v3
 
 import (
-	"github.com/haproxytech/client-native/v3/models"
+	"github.com/haproxytech/client-native/v6/models"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:metadata:annotations="haproxy.org/client-native=v6.0.7-0.20250113083507-df8f78bea9bb"
 
 // Defaults is a specification for a Defaults resource
 type Defaults struct {
@@ -32,16 +33,13 @@ type Defaults struct {
 
 // DefaultsSpec defines the desired state of Defaults
 type DefaultsSpec struct {
-	Config *models.Defaults `json:"config"`
+	models.Defaults `json:",inline"`
 }
 
 // DeepCopyInto deepcopying  the receiver into out. in must be non-nil.
 func (in *DefaultsSpec) DeepCopyInto(out *DefaultsSpec) {
-	*out = *in
-	if in.Config != nil {
-		b, _ := in.Config.MarshalBinary()
-		_ = out.Config.UnmarshalBinary(b)
-	}
+	b, _ := in.MarshalBinary()
+	_ = out.Defaults.UnmarshalBinary(b)
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

crs/api/core/v1alpha2/defaults.go crs/api/ingress/v3/defaults.gocrs/api/core/v1alpha2/defaults.go renamed to crs/api/ingress/v3/defaults.go

@@ -0,0 +1,5 @@
+// Package v3 contains the core v3 API group
+//
+// +k8s:deepcopy-gen=package
+// +groupName=ingress.v3.haproxy.org
+package v3

crs/api/ingress/v3/doc.go

@@ -13,15 +13,20 @@
 // limitations under the License.
 //
 
-package v1alpha2
+package v3
 
 import (
-	"github.com/haproxytech/client-native/v3/models"
+	"github.com/haproxytech/client-native/v6/models"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:metadata:annotations="haproxy.org/client-native=v6.0.7-0.20250113083507-df8f78bea9bb"
+// +kubebuilder:validation:XValidation:rule="!has(self.spec.default_path)", message="spec.config.default_path is set by ingress controller internally"
+// +kubebuilder:validation:XValidation:rule="!has(self.spec.master__dash__worker)", message="spec.config.master-worker is set by ingress controller internally"
+// +kubebuilder:validation:XValidation:rule="!has(self.spec.pidfile)", message="spec.config.pidfile is set by ingress controller internally"
+// +kubebuilder:validation:XValidation:rule="!has(self.spec.localpeer)", message="spec.config.localpeer is set by ingress controller internally"
 
 // Global is a specification for a Global resource
 type Global struct {
@@ -33,24 +38,13 @@ type Global struct {
 
 // GlobalSpec defines the desired state of Global
 type GlobalSpec struct {
-	Config     *models.Global    `json:"config"`
-	LogTargets models.LogTargets `json:"log_targets"` //nolint:tagliatelle
+	models.Global `json:",inline"`
 }
 
 // DeepCopyInto deepcopying  the receiver into out. in must be non-nil.
 func (in *GlobalSpec) DeepCopyInto(out *GlobalSpec) {
-	if in.Config != nil {
-		b, _ := in.Config.MarshalBinary()
-		_ = out.Config.UnmarshalBinary(b)
-	}
-	if in.LogTargets != nil {
-		out.LogTargets = make([]*models.LogTarget, len(in.LogTargets))
-		for i, v := range in.LogTargets {
-			b, _ := v.MarshalBinary()
-			out.LogTargets[i] = &models.LogTarget{}
-			_ = out.LogTargets[i].UnmarshalBinary(b)
-		}
-	}
+	b, _ := in.MarshalBinary()
+	_ = out.Global.UnmarshalBinary(b)
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

crs/api/core/v1alpha2/global.go crs/api/ingress/v3/global.gocrs/api/core/v1alpha2/global.go renamed to crs/api/ingress/v3/global.go

@@ -0,0 +1,139 @@
+// Copyright 2024 HAProxy Technologies
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+package v3
+
+import (
+	"github.com/go-openapi/swag"
+	"github.com/haproxytech/client-native/v6/models"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:metadata:annotations="haproxy.org/client-native=v6.0.7-0.20250113083507-df8f78bea9bb"
+
+// TCP is a specification for a TCP resource
+type TCP struct {
+	Spec              TCPSpec `json:"spec"`
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+}
+
+type TCPService struct {
+	Name string `json:"name"`
+	// +kubebuilder:validation:Maximum=65535
+	// +kubebuilder:validation:Minimum=1
+	Port int `json:"port"`
+}
+
+type TCPModel struct {
+	// +kubebuilder:validation:Required
+	Name     string          `json:"name"`
+	Frontend models.Frontend `json:"frontend"`
+	// Service defines the name of the default service (default_backend)
+	Service TCPService `json:"service"`
+	// Services defines additional services for additional backends
+	Services TCPServices `json:"services,omitempty"`
+}
+
+type TCPServices []*TCPService
+
+// TCPSpec defines the desired state of a TCPService
+type TCPSpec []TCPModel
+
+// DeepCopyInto deepcopying  the receiver into out. in must be non-nil.
+func (a *TCPModel) DeepCopyInto(out *TCPModel) {
+	*out = *a
+
+	f, _ := a.Frontend.MarshalBinary()
+	out.Frontend = models.Frontend{}
+	_ = out.Frontend.UnmarshalBinary(f)
+
+	s, _ := a.Service.MarshalBinary()
+	out.Service = TCPService{}
+	_ = out.Service.UnmarshalBinary(s)
+
+	if a.Services != nil {
+		out.Services = make(TCPServices, len(a.Services))
+		a.Services.DeepCopyInto(&out.Services)
+	}
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// TCPList is a list of TCP resources
+type TCPList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+
+	Items []TCP `json:"items"`
+}
+
+// MarshalBinary interface implementation
+func (s *TCPService) MarshalBinary() ([]byte, error) {
+	if s == nil {
+		return nil, nil
+	}
+	return swag.WriteJSON(s)
+}
+
+// UnmarshalBinary interface implementation
+func (s *TCPService) UnmarshalBinary(b []byte) error {
+	var res TCPService
+	if err := swag.ReadJSON(b, &res); err != nil {
+		return err
+	}
+	*s = res
+	return nil
+}
+
+func (a TCPModel) Equal(b TCPModel, opt ...models.Options) bool {
+	if a.Name != b.Name {
+		return false
+	}
+	if !a.Frontend.Equal(b.Frontend, opt...) {
+		return false
+	}
+
+	if !a.Service.Equal(b.Service, opt...) {
+		return false
+	}
+
+	if (a.Services == nil && b.Services != nil) || (a.Services != nil && b.Services == nil) {
+		return false
+	}
+	if a.Services != nil && b.Services != nil {
+		if len(a.Services) != len(b.Services) {
+			return false
+		}
+		for i, value := range a.Services {
+			if (value == nil && b.Services[i] != nil) || (value != nil && b.Services[i] == nil) {
+				return false
+			}
+			if value != nil &&
+				b.Services[i] != nil &&
+				!value.Equal(*b.Services[i], opt...) {
+				return false
+			}
+		}
+	}
+
+	return true
+}
+
+func (s TCPService) Equal(b TCPService, opt ...models.Options) bool {
+	return s.Name == b.Name && s.Port == b.Port
+}