feat(helm): add edition global value (#125)

dexyk · web-flow · commit 47aa9e6191c9 · 2025-03-13T15:35:46.000+01:00
## 📝 Description Introduces a new global value to distinguish between CE and EE versions. Updates promotions to enable deployment and testing for both versions. For more details, see: renderedtext/project-tasks#2271 ## ✅ Checklist - [x] I have tested this change - [x] This change requires documentation update - *not at the moment—CE is installed by default.*
diff --git a/.semaphore/daily-builds.yml b/.semaphore/daily-builds.yml
@@ -3421,6 +3421,7 @@ promotions:
           options:
             - gke
             - single-vm
+          default_value: single-vm
   - name: Cloud Environment - E2E
     pipeline_file: env-e2e.yml
     deployment_target: provision-test-env
@@ -3443,3 +3444,11 @@ promotions:
           options:
             - gke
             - single-vm
+          default_value: single-vm
+        - name: SEMAPHORE_EDITION
+          required: true
+          options:
+            - ce
+            - ee
+          default_value: ce
+          description: "The edition of Semaphore to install - Community (ce) or Enterprise (ee)."
diff --git a/.semaphore/env-create.yml b/.semaphore/env-create.yml
@@ -1,5 +1,5 @@
 version: v1.0
-name: Cloud environment - ${{parameters.CLOUD_TEST_ENV_PREFIX}} - ${{parameters.CLOUD_TEST_ENVIRONMENT_TYPE}}
+name: Cloud environment - ${{parameters.CLOUD_TEST_ENV_PREFIX}} - ${{parameters.CLOUD_TEST_ENVIRONMENT_TYPE}} - ${{parameters.SEMAPHORE_EDITION}}
 agent:
   machine:
     type: f1-standard-2
@@ -10,6 +10,8 @@ global_job_config:
       value: "test.sonprem.com"
     - name: ROLE_ARN
       value: "arn:aws:iam::451765615567:role/sem-install-dns-update-role"
+    - name: SEMAPHORE_EDITION
+      value: ${{parameters.SEMAPHORE_EDITION}}
   prologue:
     commands:
       - export DOMAIN="${CLOUD_TEST_ENV_PREFIX}.${BASE_DOMAIN}"
@@ -105,3 +107,6 @@ promotions:
           options:
             - gke
             - single-vm
+        - name: SEMAPHORE_EDITION
+          required: true
+          default_value: ${{parameters.SEMAPHORE_EDITION}}
diff --git a/.semaphore/env-e2e.yml b/.semaphore/env-e2e.yml
@@ -1,5 +1,5 @@
 version: v1.0
-name: E2E Tests - ${{parameters.CLOUD_TEST_ENV_PREFIX}} - ${{parameters.CLOUD_TEST_ENVIRONMENT_TYPE}}
+name: E2E Tests - ${{parameters.CLOUD_TEST_ENV_PREFIX}} - ${{parameters.CLOUD_TEST_ENVIRONMENT_TYPE}} - ${{parameters.SEMAPHORE_EDITION}}
 agent:
   machine:
     type: f1-standard-2
@@ -8,6 +8,9 @@ global_job_config:
   secrets:
     - name: e2e-test-github-app-${{parameters.CLOUD_TEST_ENV_PREFIX}}
     - name: e2e-test-gitlab-app-${{parameters.CLOUD_TEST_ENV_PREFIX}}
+  env_vars:
+    - name: SEMAPHORE_EDITION
+      value: ${{parameters.SEMAPHORE_EDITION}}
   prologue:
     commands:
       - checkout && cd e2e
diff --git a/.semaphore/generate-helm-chart.yml b/.semaphore/generate-helm-chart.yml
@@ -112,3 +112,11 @@ promotions:
           options:
             - gke
             - single-vm
+        - name: SEMAPHORE_EDITION
+          required: true
+          options:
+            - ce
+            - ee
+          default_value: ce
+          description: "The edition of Semaphore to install - Community (ce) or Enterprise (ee)."
+
diff --git a/.semaphore/semaphore.yml b/.semaphore/semaphore.yml
@@ -3745,6 +3745,7 @@ promotions:
           options:
             - gke
             - single-vm
+          default_value: single-vm
   - name: Cloud Environment - E2E
     pipeline_file: env-e2e.yml
     deployment_target: provision-test-env
@@ -3767,3 +3768,12 @@ promotions:
           options:
             - gke
             - single-vm
+          default_value: single-vm
+        - name: SEMAPHORE_EDITION
+          required: true
+          options:
+            - ce
+            - ee
+          default_value: ce
+          description: "The edition of Semaphore to install - Community (ce) or Enterprise (ee)."
+
diff --git a/ee/gofer/helm/templates/dpl.yaml b/ee/gofer/helm/templates/dpl.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -160,3 +161,4 @@ spec:
 {{ toYaml .Values.statsd.resources | indent 13 }}
 {{- end }}
 {{- end }}
+{{- end }}
diff --git a/ee/pre_flight_checks/helm/templates/deployment.yml b/ee/pre_flight_checks/helm/templates/deployment.yml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -100,3 +101,4 @@ spec:
 {{ toYaml .Values.statsd.resources | indent 13 }}
 {{- end }}
 {{- end }}
+{{- end }}
diff --git a/ee/pre_flight_checks/helm/templates/service.yml b/ee/pre_flight_checks/helm/templates/service.yml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -10,3 +11,4 @@ spec:
     - name: grpc
       protocol: TCP
       port: 50051
+{{- end }}
diff --git a/ee/velocity/helm/templates/api.yaml b/ee/velocity/helm/templates/api.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: v1
 kind: Service
 metadata:
@@ -94,4 +95,5 @@ spec:
           resources:
 {{ toYaml .Values.statsd.resources | indent 13 }}
 {{- end }}
+{{- end }}
 {{- end }}
diff --git a/ee/velocity/helm/templates/emitter.yaml b/ee/velocity/helm/templates/emitter.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -83,4 +84,5 @@ spec:
             capabilities:
               drop:
                 - ALL
-{{- end }}
+{{- end }}
+{{- end }}
diff --git a/ee/velocity/helm/templates/metric-aggregator.yaml b/ee/velocity/helm/templates/metric-aggregator.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -82,3 +83,5 @@ spec:
               drop:
                 - ALL
 {{- end }}
+{{- end }}
+
diff --git a/ee/velocity/helm/templates/summary-worker.yaml b/ee/velocity/helm/templates/summary-worker.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -83,4 +84,5 @@ spec:
             capabilities:
               drop:
                 - ALL
-{{- end }}
+{{- end }}
+{{- end }}
diff --git a/ee/velocity/helm/templates/worker.yaml b/ee/velocity/helm/templates/worker.yaml
@@ -1,3 +1,4 @@
+{{- if eq .Values.global.edition "ee" }}
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -82,4 +83,5 @@ spec:
           resources:
 {{ toYaml .Values.statsd.resources | indent 13 }}
 {{- end }}
-{{- end }}
+{{- end }}
+{{- end }}
diff --git a/ephemeral_environment/Makefile b/ephemeral_environment/Makefile
@@ -24,6 +24,7 @@ terraform.destroy:
 
 helm.install:
 	$(eval $(call check_defined,CLOUD_TEST_ENVIRONMENT_TYPE))
+	$(eval $(call check_defined,SEMAPHORE_EDITION))
 	cd $(ROOT_PATH)/scripts && ./install.sh
 
 dns.update:
diff --git a/ephemeral_environment/scripts/install.sh b/ephemeral_environment/scripts/install.sh
@@ -22,6 +22,9 @@ echo "Using DOMAIN: $DOMAIN"
 
 # Base args
 
+# Set default edition to ce if not specified
+SEMAPHORE_EDITION=${SEMAPHORE_EDITION:-ce}
+
 args=(
   "--set"
   "global.rootUser.githubLogin=on-prem-tester"
@@ -39,6 +42,8 @@ args=(
   "global.domain.name=${DOMAIN}"
   "--set"
   "ingress.ssl.certName=${CERT_NAME}"
+  "--set"
+  "global.edition=${SEMAPHORE_EDITION}"
 )
 
 # Provider-specific base args
@@ -118,7 +123,7 @@ if [[ "$CLOUD_TEST_ENVIRONMENT_TYPE" == "single-vm" ]]; then
     "cert.fullchain.cer"
     "cert.key"
     "github-app-secret.yaml"
-    "bitbucket-app-secret.yaml" 
+    "bitbucket-app-secret.yaml"
     "gitlab-app-secret.yaml"
     "vm-install.sh"
   )
@@ -132,7 +137,7 @@ if [[ "$CLOUD_TEST_ENVIRONMENT_TYPE" == "single-vm" ]]; then
   #
   gcloud compute ssh \
     --ssh-key-file private-ssh-key test-${CLOUD_TEST_ENV_PREFIX} \
-    --command "bash ~/vm-install.sh ${IP} ${DOMAIN} ${package_name}"
+    --command "SEMAPHORE_EDITION=${SEMAPHORE_EDITION} bash ~/vm-install.sh ${IP} ${DOMAIN} ${package_name}"
 
 elif [[ "$CLOUD_TEST_ENVIRONMENT_TYPE" =~ ^(gke|eks)$ ]]; then
   if [[ "$CLOUD_TEST_ENVIRONMENT_TYPE" == "gke" ]]; then
diff --git a/ephemeral_environment/scripts/vm-install.sh b/ephemeral_environment/scripts/vm-install.sh
@@ -27,6 +27,9 @@ kubectl apply -f github-app-secret.yaml
 kubectl apply -f bitbucket-app-secret.yaml
 kubectl apply -f gitlab-app-secret.yaml
 
+# Set default edition to ce if not specified
+SEMAPHORE_EDITION=${SEMAPHORE_EDITION:-ce}
+
 args=(
   "--set"
   "global.domain.ip=${IP}"
@@ -52,6 +55,8 @@ args=(
   "global.telemetry.cron=* * * * *"
   "--set"
   "global.telemetry.endpoint=https://telemetry.sxmoon.com/ingest"
+  "--set"
+  "global.edition=${SEMAPHORE_EDITION}"
 )
 
 #
diff --git a/helm-chart/Chart.yaml.in b/helm-chart/Chart.yaml.in
@@ -27,8 +27,6 @@ dependencies:
   - name: gofer
     version: "@chartVersion@"
     repository: "file://../ee/gofer/helm"
-    tags:
-      - enterprise
   - name: secrethub
     version: "@chartVersion@"
     repository: "file://../secrethub/helm"
@@ -110,10 +108,6 @@ dependencies:
   - name: pre-flight-checks-hub
     version: "@chartVersion@"
     repository: "file://../ee/pre_flight_checks/helm"
-    tags:
-      - enterprise
   - name: velocity-hub
     version: "@chartVersion@"
     repository: "file://../ee/velocity/helm"
-    tags:
-      - enterprise
diff --git a/helm-chart/Dockerfile b/helm-chart/Dockerfile
@@ -0,0 +1,25 @@
+FROM alpine:3.19 AS base
+
+# Install required packages
+RUN apk add --no-cache \
+    bash \
+    git \
+    jq \
+    make \
+    yq \
+    curl \
+    openssl \
+    helm
+
+FROM base AS helm
+
+WORKDIR /workspace
+
+# Create directory structure
+RUN mkdir -p /workspace/helm-chart
+
+# Set the working directory to helm-chart
+WORKDIR /workspace/helm-chart
+
+# We'll mount the current directory here during runtime
+ENTRYPOINT ["/bin/bash"]
diff --git a/helm-chart/Makefile b/helm-chart/Makefile
@@ -14,3 +14,48 @@ helm.cleanup:
 
 helm.dep.build:
 	helm dependency build
+
+# Local testing
+
+# Docker image name for helm testing
+DOCKER_IMAGE := semaphore-helm-test
+
+# Build the Docker image for helm testing
+docker.build:
+	docker build -t $(DOCKER_IMAGE) .
+
+# Test CE version of helm chart
+helm.test.ce: docker.build
+	docker run --rm -v $(PWD)/..:/workspace \
+		-w /workspace/helm-chart \
+		$(DOCKER_IMAGE) -c "make helm.cleanup && \
+		./scripts/prepare-chart.sh v0.0.0 && \
+		helm dependency build && \
+		helm template . \
+			--set global.edition=ce \
+			--set global.domain.name=test.semaphore.local \
+			--set global.domain.ip=127.0.0.1 \
+			--set ingress.ssl.type=custom \
+			--set ingress.ssl.secretName=tls-test-secret"
+
+# Test EE version of helm chart
+helm.test.ee: docker.build
+	docker run --rm -v $(PWD)/..:/workspace \
+		-w /workspace/helm-chart \
+		$(DOCKER_IMAGE) -c "make helm.cleanup && \
+		./scripts/prepare-chart.sh v0.0.0 && \
+		helm dependency build && \
+		helm template . --debug \
+			--set global.edition=ee \
+			--set global.domain.name=test.semaphore.local \
+			--set global.domain.ip=127.0.0.1 \
+			--set ingress.ssl.type=custom \
+			--set ingress.ssl.secretName=tls-test-secret"
+
+# Test both CE and EE versions
+helm.test.all: helm.test.ce helm.test.ee
+
+helm.shell: docker.build
+	docker run -it --rm -v $(PWD)/..:/workspace \
+		-w /workspace/helm-chart \
+		$(DOCKER_IMAGE) -c "bash"
diff --git a/helm-chart/scripts/prepare-chart.sh b/helm-chart/scripts/prepare-chart.sh
@@ -105,7 +105,7 @@ for application in "${applications[@]}"; do
   # If this is an application used as a sidecar,
   # there's no need to generate any chart for it.
   #
-  if printf '%s\0' "${sidecars[@]}" | grep -Fxqz -- "${application}"; then
+  if printf '%s\n' "${sidecars[@]}" | grep -Fxq -- "${application}"; then
     echo ">>> ${application} is used as a sidecar - skipping chart generation for it..."
     continue
   fi
diff --git a/helm-chart/values.yaml.in b/helm-chart/values.yaml.in
@@ -1,4 +1,7 @@
 global:
+  # Edition of Semaphore to install (ce or ee)
+  edition: "ce"
+
   domain:
     ip: ""
     name: ""
@@ -141,9 +144,6 @@ global:
   gitlabApp:
     secretName: ""
 
-tags:
-  enterprise: false
-
 toolbox:
   version: "v1.22.5"
 
