chore(release): support release crds and deploy files (#6197)

Author: liubog2008

.github/workflows/release-v2.yaml

@@ -0,0 +1,23 @@
+name: release-v2
+
+run-name: Release ${{ github.ref_name }}
+
+on:
+  push:
+    tags:
+      - "v2.*.*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: make release ${{ github.ref_name }}
+        run: V_RELEASE=${{ github.ref_name }} make release
+      - name: release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            _output/manifests/tidb-operator.crds.yaml
+            _output/manifests/tidb-operator.yaml
+

Makefile

@@ -29,7 +29,7 @@ KIND_VERSION ?= v0.24.0
 # TODO: use kubectl in _output
 KUBECTL = kubectl -n tidb-admin --context kind-tidb-operator
 
-ALL_CMD = operator prestop-checker testing-workload backup-manager
+ALL_CMD = tidb-operator prestop-checker testing-workload backup-manager
 .PHONY: build
 build: $(addprefix build/,$(ALL_CMD))
 build/%:
@@ -46,9 +46,9 @@ push/%:
 	$(ROOT)/hack/image.sh $* --push
 
 .PHONY: deploy
-deploy: crd
-	$(KUBECTL) apply --server-side=true -f $(ROOT)/manifests/crd
-	$(KUBECTL) apply --server-side=true -f $(ROOT)/manifests/deploy
+deploy: release
+	$(KUBECTL) apply --server-side=true -f $(OUTPUT_DIR)/manifests/tidb-operator.crds.yaml
+	$(KUBECTL) apply --server-side=true -f $(OUTPUT_DIR)/manifests/tidb-operator.yaml
 
 .PHONY: codegen
 codegen: bin/deepcopy-gen bin/register-gen bin/overlay-gen
@@ -86,9 +86,9 @@ runtimegen: bin/runtime-gen
 		--go-header-file=$(BOILERPLATE_FILE) \
 		github.com/pingcap/tidb-operator/api/v2/core/v1alpha1
 
-.PHONY: yamlgen
-yamlgen: crd
-	$(ROOT)/hack/yaml.sh
+.PHONY: release
+release: bin/helm crd
+	$(ROOT)/hack/release.sh
 
 .PHONY: doc
 doc: bin/mdtoc
@@ -114,7 +114,7 @@ gengo: bin/mockgen
 license: bin/license-eye
 	$(LICENSE_EYE) -c .github/licenserc.yaml header fix
 
-ALL_GEN = tidy codegen crd gengo overlaygen runtimegen yamlgen doc
+ALL_GEN = tidy codegen crd gengo overlaygen runtimegen doc
 .PHONY: generate
 generate: $(ALL_GEN) license
 
@@ -146,15 +146,15 @@ unit:
 check: lint unit verify
 
 .PHONY: e2e/prepare
-e2e/prepare: bin/kind crd
+e2e/prepare: bin/kind release
 	$(ROOT)/hack/e2e.sh --prepare
 
 .PHONY: e2e/run
 e2e/run:
 	$(ROOT)/hack/e2e.sh run $(GINKGO_OPTS)
 
 .PHONY: e2e
-e2e: bin/kind crd
+e2e: bin/kind release
 	$(ROOT)/hack/e2e.sh --prepare run $(GINKGO_OPTS)
 
 .PHONY: e2e/reinstall-operator
@@ -228,3 +228,8 @@ bin/ginkgo:
 MDTOC = $(BIN_DIR)/mdtoc
 bin/mdtoc:
 	$(ROOT)/hack/download.sh go_install $(MDTOC) sigs.k8s.io/mdtoc v1.1.0
+
+.PHONY: bin/helm
+HELM = $(BIN_DIR)/helm
+bin/helm:
+	$(ROOT)/hack/download.sh go_install $(HELM) helm.sh/helm/v3/cmd/helm v3.17.3 "version --template='{{.Version}}' | xargs printf '%s.3'"

charts/tidb-operator/Chart.yaml

@@ -1,8 +1,6 @@
-apiVersion: v1
+apiVersion: v2
 description: tidb-operator Helm chart for Kubernetes
 name: tidb-operator
-version: v2-canary
-appVersion: v2-canary
 home: https://github.com/pingcap/tidb-operator
 sources:
   - https://github.com/pingcap/tidb-operator
@@ -20,3 +18,9 @@ maintainers:
     email: [email protected]
   - name: fgksgf
     email: [email protected]
+
+kubeVersion: ">=1.30.0"
+
+# will be set when package
+version: v0.0.0
+appVersion: v0.0.0

charts/tidb-operator/templates/deployment.yaml

@@ -9,10 +9,8 @@ metadata:
   namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: tidb-operator
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 spec:
   replicas: {{ .Values.operator.replicas }}
   selector:
@@ -44,7 +42,7 @@ spec:
     {{- end }}
       containers:
       - command:
-        - /operator
+        - /tidb-operator
         args:
           - --backup-manager-image={{ .Values.backupManager.image }}
         {{- if .Values.operator.extraArgs }}

charts/tidb-operator/templates/rbac.yaml

@@ -10,42 +10,41 @@ metadata:
   namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: tidb-operator
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   name: {{ .Release.Name }}:tidb-operator
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: tidb-operator
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 rules:
   - nonResourceURLs: ["/metrics"]
     verbs: ["get"]
   - apiGroups: [""]
-    resources: ["configmaps", "events", "persistentvolumeclaims", "pods", "services"]
-    verbs: ["*"]
+    resources: ["configmaps", "persistentvolumeclaims", "pods", "services"]
+    verbs: ["get", "list", "watch", "create", "delete", "update", "patch"]
+  - apiGroups: [""]
+    resources: ["events"]
+    verbs: ["create"]
   - apiGroups: [""]
     resources: ["nodes", "persistentvolumes", "secrets"]
     verbs: ["get", "list", "watch"]
   - apiGroups: ["apps"]
     resources: ["controllerrevisions"]
-    verbs: ["*"]
+    verbs: ["get", "list", "watch", "create", "delete", "update", "patch"]
   - apiGroups: ["batch"]
     resources: ["jobs"]
-    verbs: ["*"]
+    verbs: ["get", "list", "watch", "create", "delete", "update", "patch"]
   - apiGroups: ["storage.k8s.io"]
     resources: ["storageclasses", "volumeattributesclasses"]
     verbs: ["get", "list", "watch"]
   - apiGroups: ["coordination.k8s.io"]
     resources: ["leases"]
-    verbs: ["*"]
+    verbs: ["get", "list", "watch", "create", "delete", "update", "patch"]
   - apiGroups: ["core.pingcap.com"]
     resources: ["*"]
     verbs: ["*"]
@@ -59,10 +58,8 @@ metadata:
   name: {{ .Release.Name }}:tidb-operator
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: tidb-operator
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole

charts/tidb-operator/templates/webhook.yaml

@@ -10,10 +10,8 @@ metadata:
   name: "delete-pod.policy.pingcap.com"
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: webhook
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 spec:
   failurePolicy: Fail
   matchConstraints:
@@ -32,10 +30,8 @@ metadata:
   name: "delete-pod.policy.pingcap.com"
   labels:
     app.kubernetes.io/name: {{ template "chart.name" . }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
     app.kubernetes.io/instance: {{ .Release.Name }}
     app.kubernetes.io/component: webhook
-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+"  "_" }}
 spec:
   policyName: "delete-pod.policy.pingcap.com"
   validationActions: [Deny]

cmd/operator/main.go renamed to cmd/tidb-operator/main.go

@@ -1,4 +1,3 @@
-#!/usr/bin/env bash
 # Copyright 2024 PingCAP, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,27 +11,3 @@
 # 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.
-
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-ROOT=$(cd $(dirname "${BASH_SOURCE[0]}")/..; pwd -P)
-source $ROOT/hack/lib/vars.sh
-
-OPERATOR=$ROOT/manifests/tidb-operator.yaml
-CRDS=$ROOT/manifests/tidb-operator.crds.yaml
-
-echo -n > $CRDS
-echo -n > $OPERATOR
-for f in $ROOT/manifests/crd/*.yaml; do
-    echo "append $f"
-    cat $f >> $CRDS
-    cat $f >> $OPERATOR
-done
-
-for f in $ROOT/manifests/deploy/*.yaml; do
-    echo "append $f"
-    cat $f >> $OPERATOR
-done

hack/yaml.sh renamed to hack/boilerplate/boilerplate.yaml.txt

@@ -46,7 +46,7 @@ function build::all() {
         shift
     done
     if [[ ${#targets[@]} -eq 0 ]]; then
-        targets=("operator" "prestop-checker" "testing-workload" "backup-manager")
+        targets=("tidb-operator" "prestop-checker" "testing-workload" "backup-manager")
     fi
 
     local platforms

hack/lib/build.sh

@@ -66,7 +66,7 @@ function e2e::install_crds() {
 
 function e2e::install_operator() {
     echo "installing operator..."
-    $KUBECTL -n $V_DEPLOY_NAMESPACE apply --server-side=true -f $ROOT/manifests/deploy
+    $KUBECTL -n $V_DEPLOY_NAMESPACE apply --server-side=true -f $OUTPUT_DIR/manifests/tidb-operator.yaml
 
     echo "waiting for operator to be ready..."
     $KUBECTL -n $V_DEPLOY_NAMESPACE wait --for=condition=Available --timeout=5m deployment/tidb-operator
@@ -80,7 +80,7 @@ function e2e::uninstall_operator() {
     fi
 
     echo "uninstalling operator..."
-    $KUBECTL -n $V_DEPLOY_NAMESPACE delete -f $ROOT/manifests/deploy
+    $KUBECTL -n $V_DEPLOY_NAMESPACE delete -f $OUTPUT_DIR/manifests/tidb-operator.yaml
 
     echo "waiting for operator to be deleted..."
     $KUBECTL -n $V_DEPLOY_NAMESPACE wait --for=delete --timeout=5m deployment/tidb-operator
@@ -123,7 +123,7 @@ function e2e::prepare() {
     e2e::install_crds
 
     # build the operator image and load it into the kind cluster
-    image::build prestop-checker operator testing-workload backup-manager --push
+    image::build prestop-checker tidb-operator testing-workload backup-manager --push
     e2e::uninstall_operator
     e2e::install_operator