feat(devenv): set k8sop description to codespace name (#708)

Signed-off-by: Jonathan Stacks <[email protected]>

Author: jonstacks

helm/ngrok-operator/templates/agent/deployment.yaml

@@ -77,7 +77,7 @@ spec:
         - agent-manager
         {{- include "ngrok-operator.manager.cliFeatureFlags" . | nindent 8 }}
         {{- if .Values.description }}
-        - --description={{ .Values.description | quote }}
+        - {{ printf "--description=%s" .Values.description | quote }}
         {{- end }}
         {{- if .Values.region }}
         - --region={{ .Values.region }}

helm/ngrok-operator/templates/bindings-forwarder/deployment.yaml

@@ -77,7 +77,7 @@ spec:
         - bindings-forwarder-manager
         - --release-name={{ .Release.Name }}
         {{- if .Values.description }}
-        - --description={{ .Values.description | quote }}
+        - {{ printf "--description=%s" .Values.description | quote }}
         {{- end }}
         - --zap-log-level={{ .Values.log.level }}
         - --zap-stacktrace-level={{ .Values.log.stacktraceLevel }}

helm/ngrok-operator/templates/controller-deployment.yaml

@@ -99,7 +99,7 @@ spec:
         - --bindings-ingress-endpoint={{ .Values.bindings.ingressEndpoint }}
         {{- end }}
         {{- if .Values.description }}
-        - --description={{ .Values.description | quote }}
+        - {{ printf "--description=%s" .Values.description | quote }}
         {{- end }}
         {{- if .Values.region }}
         - --region={{ .Values.region}}

helm/ngrok-operator/tests/__snapshot__/controller-deployment_test.yaml.snap

@@ -163,7 +163,16 @@ tests:
   asserts:
   - contains:
       path: spec.template.spec.containers[0].args
-      content: --description="test description"
+      content: --description=test description
+- it: Should pass description when description has special characters
+  set:
+    description: 'lets-go: with spaces'
+  template: controller-deployment.yaml
+  documentIndex: 0 # Document 0 is the deployment since its the first template
+  asserts:
+  - contains:
+      path: spec.template.spec.containers[0].args
+      content: '--description=lets-go: with spaces'
 - it: Should support deprecated metaData to the deployment
   set:
     metaData:

helm/ngrok-operator/tests/agent/__snapshot__/deployment_test.yaml.snap

@@ -1,5 +1,9 @@
 ##@ Deploying
 
+ifneq ($(CODESPACE_NAME),)
+HELM_DESCRIPTION_FLAG = --set-string description="codespace: $(CODESPACE_NAME)"
+endif
+
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./cmd/api/main.go
@@ -19,7 +23,8 @@ deploy: _deploy-check-env-vars docker-build manifests _helm_setup kind-load-imag
 		--set log.format=console \
 		--set-string log.level="8" \
 		--set log.stacktraceLevel=panic \
-		--set metaData.env=local,metaData.from=makefile
+		--set metaData.env=local,metaData.from=makefile \
+		$(HELM_DESCRIPTION_FLAG)
 
 .PHONY: deploy_gateway
 deploy_gateway: _deploy-check-env-vars docker-build manifests _helm_setup kind-load-image ## Deploy controller to the K8s cluster specified in ~/.kube/config.
@@ -36,7 +41,8 @@ deploy_gateway: _deploy-check-env-vars docker-build manifests _helm_setup kind-l
 		--set-string log.level="8" \
 		--set log.stacktraceLevel=panic \
 		--set metaData.env=local,metaData.from=makefile \
-		--set useExperimentalGatewayApi=true
+		--set useExperimentalGatewayApi=true \
+		$(HELM_DESCRIPTION_FLAG)
 
 .PHONY: deploy_with_bindings
 deploy_with_bindings: _deploy-check-env-vars docker-build manifests _helm_setup kind-load-image ## Deploy controller to the K8s cluster specified in ~/.kube/config.
@@ -53,7 +59,8 @@ deploy_with_bindings: _deploy-check-env-vars docker-build manifests _helm_setup
 		--set log.level=debug \
 		--set log.stacktraceLevel=panic \
 		--set metaData.env=local,metaData.from=makefile \
-		--set bindings.enabled=true
+		--set bindings.enabled=true \
+		$(HELM_DESCRIPTION_FLAG)
 
 .PHONY: deploy_for_e2e
 deploy_for_e2e: _deploy-check-env-vars docker-build manifests _helm_setup kind-load-image ## Deploy controller to the K8s cluster specified in ~/.kube.config.