Use kustomize to generate a single CRDs file

Author: lucacome

.goreleaser.yml

@@ -66,13 +66,9 @@ milestones:
 snapshot:
   name_template: "edge"
 
-before:
-  hooks:
-    - make crds-release-file
-
 release:
   extra_files:
-    - glob: ./build/out/crds.yaml
+    - glob: ./deploy/crds.yaml
     - glob: ./deploy/manifests/nginx-gateway.yaml
     - glob: ./deploy/manifests/nginx-plus-gateway.yaml
     - glob: ./deploy/manifests/nginx-gateway-experimental.yaml

.yamllint.yaml

@@ -6,6 +6,7 @@ yaml-files:
 ignore:
   - charts/nginx-gateway-fabric
   - config/crd/bases/
+  - deploy/crds.yaml
   - .github/workflows/
 
 rules:

Makefile

@@ -101,6 +101,8 @@ generate: ## Run go generate
 .PHONY: generate-crds
 generate-crds: ## Generate CRDs and Go types using kubebuilder
 	go run sigs.k8s.io/controller-tools/cmd/controller-gen crd object paths=./apis/... output:crd:artifacts:config=config/crd/bases
+	@kustomize version || (code=$$?; printf "\033[0;31mError\033[0m: there was a problem with kustomize, use 'brew install kustomize' to install it\n"; exit $$code)
+	kustomize build config/crd >deploy/crds.yaml
 
 .PHONY: generate-manifests
 generate-manifests: ## Generate manifests using Helm.
@@ -113,10 +115,6 @@ generate-manifests: ## Generate manifests using Helm.
 	helm template nginx-gateway $(CHART_DIR) $(HELM_TEMPLATE_COMMON_ARGS) --set service.annotations.'service\.beta\.kubernetes\.io\/aws-load-balancer-type'="nlb" -n nginx-gateway -s templates/service.yaml > $(strip $(MANIFEST_DIR))/service/loadbalancer-aws-nlb.yaml
 	helm template nginx-gateway $(CHART_DIR) $(HELM_TEMPLATE_COMMON_ARGS) --set service.type=NodePort --set service.externalTrafficPolicy="" -n nginx-gateway -s templates/service.yaml > $(strip $(MANIFEST_DIR))/service/nodeport.yaml
 
-.PHONY: crds-release-file
-crds-release-file: ## Generate combined crds file for releases
-	scripts/combine-crds.sh
-
 .PHONY: clean
 clean: ## Clean the build
 	-rm -r $(OUT_DIR)

config/crd/bases/kustomization.yaml

@@ -0,0 +1,5 @@
+resources:
+  - gateway.nginx.org_clientsettingspolicies.yaml
+  - gateway.nginx.org_nginxgateways.yaml
+  - gateway.nginx.org_nginxproxies.yaml
+  - gateway.nginx.org_observabilitypolicies.yaml

config/crd/kustomization.yaml

@@ -0,0 +1,2 @@
+resources:
+  - bases

conformance/Makefile

@@ -11,7 +11,6 @@ KIND_KUBE_CONFIG=$${HOME}/.kube/kind/config
 CONFORMANCE_TAG = latest
 CONFORMANCE_PREFIX = conformance-test-runner
 NGF_MANIFEST=../deploy/manifests/nginx-gateway.yaml
-CRDS=../deploy/manifests/crds/
 STATIC_MANIFEST=provisioner/static-deployment.yaml
 PROVISIONER_MANIFEST=provisioner/provisioner.yaml
 INSTALL_WEBHOOK ?= false
@@ -63,13 +62,13 @@ load-images-with-plus: ## Load NGF and NGINX Plus images on configured kind clus
 .PHONY: prepare-ngf-dependencies
 prepare-ngf-dependencies: update-ngf-manifest ## Install NGF dependencies on configured kind cluster
 	./scripts/install-gateway.sh $(GW_API_VERSION) $(INSTALL_WEBHOOK) $(ENABLE_EXPERIMENTAL)
-	kubectl apply -f $(CRDS)
+	kustomize build ../config/crd/bases | kubectl apply -f -
 	kubectl apply -f $(NGF_MANIFEST)
 
 .PHONY: prepare-ngf-dependencies-with-plus
 prepare-ngf-dependencies-with-plus: update-ngf-manifest-with-plus ## Install NGF dependencies with Plus on configured kind cluster
 	./scripts/install-gateway.sh $(GW_API_VERSION) $(INSTALL_WEBHOOK)
-	kubectl apply -f $(CRDS)
+	kustomize build ../config/crd/bases | kubectl apply -f -
 	kubectl apply -f $(NGF_MANIFEST)
 
 .PHONY: deploy-updated-provisioner

deploy/crds.yaml

@@ -154,7 +154,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
 
       ```shell
       make generate-manifests HELM_TEMPLATE_COMMON_ARGS="--set nginxGateway.image.repository=nginx-gateway-fabric --set nginxGateway.image.tag=$(whoami) --set nginxGateway.image.pullPolicy=Never --set nginx.image.repository=nginx-gateway-fabric/nginx --set nginx.image.tag=$(whoami) --set nginx.image.pullPolicy=Never"
-      kubectl apply -f deploy/manifests/crds
+      kubectl apply -f deploy/crds.yaml
       kubectl apply -f deploy/manifests/nginx-gateway.yaml
       kubectl apply -f deploy/manifests/service/nodeport.yaml
       ```
@@ -163,7 +163,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
 
       ```shell
       make generate-manifests HELM_TEMPLATE_COMMON_ARGS="--set nginxGateway.image.repository=nginx-gateway-fabric --set nginxGateway.image.tag=$(whoami) --set nginxGateway.image.pullPolicy=Never --set nginx.image.repository=nginx-gateway-fabric/nginx-plus --set nginx.image.tag=$(whoami) --set nginx.image.pullPolicy=Never --set nginx.plus=true"
-      kubectl apply -f deploy/manifests/crds
+      kubectl apply -f deploy/crds.yaml
       kubectl apply -f deploy/manifests/nginx-gateway.yaml
       kubectl apply -f deploy/manifests/service/nodeport.yaml
       ```
@@ -172,7 +172,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
 
       ```shell
       make generate-manifests HELM_TEMPLATE_COMMON_ARGS="--set nginxGateway.image.repository=nginx-gateway-fabric --set nginxGateway.image.tag=$(whoami) --set nginxGateway.image.pullPolicy=Never --set nginx.image.repository=nginx-gateway-fabric/nginx --set nginx.image.tag=$(whoami) --set nginx.image.pullPolicy=Never"
-      kubectl apply -f deploy/manifests/crds
+      kubectl apply -f deploy/crds.yaml
       kubectl apply -f deploy/manifests/nginx-gateway-experimental.yaml
       kubectl apply -f deploy/manifests/service/nodeport.yaml
       ```

deploy/manifests/crds

@@ -33,18 +33,13 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps.
 #### Stable release
 
    ```shell
-   kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/crds.yaml
+   kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.2.0/deploy/crds.yaml
    ```
 
 #### Edge version
 
    ```shell
-   git clone https://github.com/nginxinc/nginx-gateway-fabric.git
-   cd nginx-gateway-fabric
-   ```
-
-   ```shell
-   kubectl apply -f deploy/manifests/crds
+   kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/deploy/crds.yaml
    ```
 
 ### 3. Deploy NGINX Gateway Fabric
@@ -164,7 +159,7 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta
    - To upgrade the Custom Resource Definitions (CRDs), run:
 
       ```shell
-      kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/crds.yaml
+      kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.2.0/deploy/crds.yaml
       ```
 
 1. **Upgrade NGINX Gateway Fabric deployment:**
@@ -238,7 +233,7 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
      ```
 
      ```shell
-     kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/crds.yaml
+     kubectl delete -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.2.0/deploy/crds.yaml
      ```
 
 1. **Remove the Gateway API resources:**