Merge branch 'master' into doc/fix-doc-description-error

Author: AlinsRan

.github/workflows/golangci-lint.yml

@@ -60,7 +60,7 @@ jobs:
           make generate-crd-docs
       - name: Check CRD Docs Diff
         run: |
-          if ! git diff --exit-code -- docs/crd/api.md; then
-            echo "docs/crd/api.md has changed. Please run 'make generate-crd-docs' and commit the updated file."
+          if ! git diff --exit-code -- docs/en/latest/api-reference.md; then
+            echo "docs/en/latest/api-reference.md has changed. Please run 'make generate-crd-docs' and commit the updated file."
             exit 1
           fi

.github/workflows/lint-checker.yml

@@ -96,8 +96,7 @@ jobs:
           markdownlint '**/*.md' \
             --ignore node_modules \
             --ignore CHANGELOG.md \
-            --ignore docs/crd/api.md \
-            --ignore docs/gateway-api.md
+            --ignore docs/en/latest/api-reference.md
   markdown-link-check:
     needs: changes
     if: |

CHANGELOG.md

@@ -85,11 +85,9 @@ If you encounter any problems while using the implementation, please [submit an
 * Ashing Zheng
 
 ### Changes
-<details><summary>14 commits</summary>
+<details><summary>12 commits</summary>
 <p>
 
-  * [`2f35524`](https://github.com/apache/apisix-ingress-controller/commit/2f35524b72b3f9e181e50479ce0576c5d9bae45d) add Makefile
-  * [`10eada5`](https://github.com/apache/apisix-ingress-controller/commit/10eada507db3515e1e19bca1152ef19fae47b7eb) chore: v2.0.0-rc1 release
   * [`c1533c9`](https://github.com/apache/apisix-ingress-controller/commit/c1533c9ddf4b1ed6db999d1535370824b8c150e1) fix: the sync_period of the provider should not be 0s (#2438)
   * [`0db882d`](https://github.com/apache/apisix-ingress-controller/commit/0db882d66d5b9dfb7dc9dd9d2045d4709b1c6ed2) chore: remove useless example files in dockerfile (#2434)
   * [`11ecb35`](https://github.com/apache/apisix-ingress-controller/commit/11ecb353d074b7392046d08e52bc824a3eeb6ee7) fix: set default provider type (#2436)

Makefile

@@ -36,8 +36,9 @@ TEST_DIR ?= ./test/e2e/apisix/
 # CRD Reference Documentation
 CRD_REF_DOCS_VERSION ?= v0.1.0
 CRD_REF_DOCS ?= $(LOCALBIN)/crd-ref-docs
-CRD_DOCS_CONFIG ?= docs/crd/config.yaml
-CRD_DOCS_OUTPUT ?= docs/crd/api.md
+CRD_DOCS_CONFIG ?= docs/assets/crd/config.yaml
+CRD_DOCS_OUTPUT ?= docs/en/latest/api-reference.md
+CRD_DOCS_TEMPLATE ?= docs/assets/template
 
 # go 
 VERSYM="github.com/apache/apisix-ingress-controller/internal/version._buildVersion"
@@ -361,7 +362,7 @@ generate-crd-docs: manifests ## Generate CRD reference documentation in a single
 		--source-path=./api \
 		--config=$(CRD_DOCS_CONFIG) \
 		--renderer=markdown \
-		--templates-dir=./docs/template \
+		--templates-dir=$(CRD_DOCS_TEMPLATE) \
 		--output-path=$(CRD_DOCS_OUTPUT) \
 		--max-depth=100
 	@echo "CRD reference documentation generated at $(CRD_DOCS_OUTPUT)"
@@ -374,7 +375,7 @@ generate-crd-docs-grouped: manifests ## Generate CRD reference documentation gro
 		--source-path=./api \
 		--config=$(CRD_DOCS_CONFIG) \
 		--renderer=markdown \
-		--templates-dir=./docs/template \
+		--templates-dir=$(CRD_DOCS_TEMPLATE) \
 		--output-path=docs/crd/groups \
 		--output-mode=group
 	@echo "CRD reference documentation generated in docs/crd/groups directory"

api/v1alpha1/gatewayproxy_types.go

@@ -22,9 +22,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // GatewayProxySpec defines the desired state of GatewayProxy.
 type GatewayProxySpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
@@ -116,9 +113,10 @@ type ControlPlaneAuth struct {
 }
 
 // ControlPlaneProvider defines the configuration for control plane provider.
+// +kubebuilder:validation:XValidation:rule="has(self.endpoints) != has(self.service)"
 type ControlPlaneProvider struct {
 	// Endpoints specifies the list of control plane endpoints.
-	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Optional
 	// +kubebuilder:validation:MinItems=1
 	Endpoints []string `json:"endpoints"`
 

config/crd/bases/apisix.apache.org_gatewayproxies.yaml

@@ -137,8 +137,9 @@ spec:
                         type: boolean
                     required:
                     - auth
-                    - endpoints
                     type: object
+                    x-kubernetes-validations:
+                    - rule: has(self.endpoints) != has(self.service)
                   type:
                     description: Type specifies the type of provider. Can only be
                       `ControlPlane`.