Merge pull request #1254 from aryan9600/verify-crds

Add target and script to keep crds in sync

.github/workflows/build.yaml

@@ -35,6 +35,8 @@ jobs:
           go install golang.org/x/tools/cmd/goimports
       - name: Run linters
         run: make test-fmt test-codegen
+      - name: Verify CRDs
+        run: make verify-crd
       - name: Run tests
         run: go test -race -coverprofile=coverage.txt -covermode=atomic $(go list ./pkg/...)
       - name: Check if working tree is dirty

Makefile

@@ -33,6 +33,9 @@ crd:
 	cat artifacts/flagger/crd.yaml > charts/flagger/crds/crd.yaml
 	cat artifacts/flagger/crd.yaml > kustomize/base/flagger/crd.yaml
 
+verify-crd:
+	./hack/verify-crd.sh
+
 version-set:
 	@next="$(TAG)" && \
 	current="$(VERSION)" && \

artifacts/flagger/crd.yaml

@@ -1040,20 +1040,20 @@ spec:
                     - Failed
                     - Terminating
                     - Terminated
+                failedChecks:
+                  description: Failed check count of the current canary analysis
+                  type: number
+                canaryWeight:
+                  description: Traffic weight routed to canary
+                  type: number
+                iterations:
+                  description: Iteration count of the current canary analysis
+                  type: number
                 trackedConfigs:
                   description: TrackedConfig of this canary
                   additionalProperties:
                     type: string
                   type: object
-                canaryWeight:
-                  description: Traffic weight routed to canary
-                  type: number
-                failedChecks:
-                  description: Failed check count of the current canary analysis
-                  type: number
-                iterations:
-                  description: Iteration count of the current canary analysis
-                  type: number
                 lastAppliedSpec:
                   description: LastAppliedSpec of this canary
                   type: string

charts/flagger/crds/crd.yaml

@@ -163,6 +163,9 @@ spec:
                     portName:
                       description: Container port name
                       type: string
+                    appProtocol:
+                      description: Application protocol of the port
+                      type: string
                     targetPort:
                       description: Container target port name
                       x-kubernetes-int-or-string: true
@@ -1037,20 +1040,20 @@ spec:
                     - Failed
                     - Terminating
                     - Terminated
+                failedChecks:
+                  description: Failed check count of the current canary analysis
+                  type: number
+                canaryWeight:
+                  description: Traffic weight routed to canary
+                  type: number
+                iterations:
+                  description: Iteration count of the current canary analysis
+                  type: number
                 trackedConfigs:
                   description: TrackedConfig of this canary
                   additionalProperties:
                     type: string
                   type: object
-                canaryWeight:
-                  description: Traffic weight routed to canary
-                  type: number
-                failedChecks:
-                  description: Failed check count of the current canary analysis
-                  type: number
-                iterations:
-                  description: Iteration count of the current canary analysis
-                  type: number
                 lastAppliedSpec:
                   description: LastAppliedSpec of this canary
                   type: string

hack/verify-crd.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+
+d=$(diff ${REPO_ROOT}/artifacts/flagger/crd.yaml ${REPO_ROOT}/charts/flagger/crds/crd.yaml)
+if [[ "$d" != "" ]]; then
+    echo "⨯ ${REPO_ROOT}/artifacts/flagger/crd.yaml and ${REPO_ROOT}/charts/flagger/crds/crd.yaml don't match"
+    echo "$d"
+    exit 1
+fi
+
+d=$(diff ${REPO_ROOT}/artifacts/flagger/crd.yaml ${REPO_ROOT}/kustomize/base/flagger/crd.yaml)
+if [[ "$d" != "" ]]; then
+    echo "⨯ ${REPO_ROOT}/artifacts/flagger/crd.yaml and ${REPO_ROOT}/kustomize/base/flagger/crd.yaml don't match"
+    echo "$d"
+    exit 1
+fi
+
+echo "✔ CRDs verified"

kustomize/base/flagger/crd.yaml

@@ -163,6 +163,9 @@ spec:
                     portName:
                       description: Container port name
                       type: string
+                    appProtocol:
+                      description: Application protocol of the port
+                      type: string
                     targetPort:
                       description: Container target port name
                       x-kubernetes-int-or-string: true
@@ -1037,26 +1040,26 @@ spec:
                     - Failed
                     - Terminating
                     - Terminated
+                failedChecks:
+                  description: Failed check count of the current canary analysis
+                  type: number
+                canaryWeight:
+                  description: Traffic weight routed to canary
+                  type: number
+                iterations:
+                  description: Iteration count of the current canary analysis
+                  type: number
                 trackedConfigs:
                   description: TrackedConfig of this canary
                   additionalProperties:
                     type: string
                   type: object
-                canaryWeight:
-                  description: Traffic weight routed to canary
-                  type: number
-                failedChecks:
-                  description: Failed check count of the current canary analysis
-                  type: number
-                iterations:
-                  description: Iteration count of the current canary analysis
-                  type: number
-                lastPromotedSpec:
-                  description: LastPromotedSpec of this canary
-                  type: string
                 lastAppliedSpec:
                   description: LastAppliedSpec of this canary
                   type: string
+                lastPromotedSpec:
+                  description: LastPromotedSpec of this canary
+                  type: string
                 lastTransitionTime:
                   description: LastTransitionTime of this canary
                   format: date-time