Rename clusterId -> clusterName

Author: Harrison Katz

Makefile

@@ -147,7 +147,7 @@ deploy: _deploy-check-env-vars docker-build manifests kustomize _helm_setup ## D
 	helm upgrade $(HELM_RELEASE_NAME) $(HELM_CHART_DIR) --install \
 		--namespace $(KUBE_NAMESPACE) \
 		--create-namespace \
-		--set clusterId=$(KUBE_CLUSTER_NAME) \
+		--set clusterName=$(KUBE_CLUSTER_NAME) \
 		--set image.repository=$(IMG) \
 		--set image.tag="latest" \
 		--set podAnnotations."k8s\.ngrok\.com/test"="\{\"env\": \"local\"\}" \
@@ -164,7 +164,7 @@ deploy_gateway: _deploy-check-env-vars docker-build manifests kustomize _helm_se
 	helm upgrade $(HELM_RELEASE_NAME) $(HELM_CHART_DIR) --install \
 		--namespace $(KUBE_NAMESPACE) \
 		--create-namespace \
-		--set clusterId=$(KUBE_CLUSTER_NAME) \
+		--set clusterName=$(KUBE_CLUSTER_NAME) \
 		--set image.repository=$(IMG) \
 		--set image.tag="latest" \
 		--set podAnnotations."k8s\.ngrok\.com/test"="\{\"env\": \"local\"\}" \
@@ -182,7 +182,7 @@ deploy_with_bindings: _deploy-check-env-vars docker-build manifests kustomize _h
 	helm upgrade $(HELM_RELEASE_NAME) $(HELM_CHART_DIR) --install \
 		--namespace $(KUBE_NAMESPACE) \
 		--create-namespace \
-		--set clusterId=$(KUBE_CLUSTER_NAME) \
+		--set clusterName=$(KUBE_CLUSTER_NAME) \
 		--set image.repository=$(IMG) \
 		--set image.tag="latest" \
 		--set podAnnotations."k8s\.ngrok\.com/test"="\{\"env\": \"local\"\}" \

cmd/api/main.go

@@ -92,7 +92,7 @@ func main() {
 
 type managerOpts struct {
 	// flags
-	clusterId             string
+	clusterName           string
 	releaseName           string
 	metricsAddr           string
 	electionID            string
@@ -145,7 +145,7 @@ func cmd() *cobra.Command {
 		},
 	}
 
-	c.Flags().StringVar(&opts.clusterId, "cluster-id", "", "Cluster ID where the ngrok-operator is installed")
+	c.Flags().StringVar(&opts.clusterName, "cluster-name", "", "Cluster Name where the ngrok-operator is installed")
 	c.Flags().StringVar(&opts.releaseName, "release-name", "ngrok-operator", "Helm Release name for the deployed operator")
 	c.Flags().StringVar(&opts.metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to")
 	c.Flags().StringVar(&opts.probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
@@ -173,7 +173,7 @@ func cmd() *cobra.Command {
 	c.Flags().StringVar(&opts.bindings.serviceLabels, "bindings-service-labels", "", "Service Labels to propagate to the target service")
 	c.Flags().StringVar(&opts.bindings.ingressEndpoint, "bindings-ingress-endpoint", "", "The endpoint the bindings forwarder connects to")
 
-	_ = c.MarkFlagRequired("cluster-id")
+	_ = c.MarkFlagRequired("cluster-name")
 	_ = c.MarkFlagRequired("release-name")
 
 	opts.zapOpts = &zap.Options{}
@@ -659,7 +659,7 @@ func createKubernetesOperator(ctx context.Context, client client.Client, opts ma
 	_, err := controllerutil.CreateOrUpdate(ctx, client, k8sOperator, func() error {
 		k8sOperator.Spec = ngrokv1alpha1.KubernetesOperatorSpec{
 			Deployment: &ngrokv1alpha1.KubernetesOperatorDeployment{
-				Cluster:   opts.clusterId,
+				Cluster:   opts.clusterName,
 				Name:      opts.releaseName,
 				Namespace: opts.namespace,
 				Version:   version.GetVersion(),

helm/ngrok-operator/CHANGELOG.md

@@ -143,7 +143,7 @@ The `ngrok-operator` helm chart now includes a `schema.json` file that can be us
 
 ### Added
 
-- Required `.Values.clusterId` for the ngrok-operator to register with the ngrok API
+- Required `.Values.clusterName` for the ngrok-operator to register with the ngrok API
 
 ### Changed
 

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

@@ -60,9 +60,9 @@ spec:
         args:
         - --release-name={{ .Release.Name }}
         {{- if .Values.oneClickDemoMode }}
-        - --cluster-id=one-click-demo-mode
+        - --cluster-name=one-click-demo-mode
         {{- else }}
-        - --cluster-id={{ .Values.clusterId | required "Missing required .Values.clusterId!"}}
+        - --cluster-name={{ .Values.clusterName | required "Missing required .Values.clusterName!"}}
         {{- end }}
         {{- include "ngrok-operator.manager.cliFeatureFlags" . | nindent 8 }}
         {{- if .Values.oneClickDemoMode }}

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

@@ -1,6 +1,6 @@
 suite: test controller-deployment
 set:
-  clusterId: "test-cluster"
+  clusterName: "test-cluster"
 templates:
 - controller-deployment.yaml
 # The following included templates are needed due to the way helm unittest works.
@@ -246,22 +246,22 @@ tests:
   - contains:
       path: spec.template.spec.containers[0].args
       content: --one-click-demo-mode
-- it: Should pass cluster-id
+- it: Should pass cluster-name
   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: --cluster-id=test-cluster
-- it: Should pass cluster-id as demo mode when enabled
+      content: --cluster-name=test-cluster
+- it: Should pass cluster-name as demo mode when enabled
   template: controller-deployment.yaml
   documentIndex: 0 # Document 0 is the deployment since its the first template
   set:
     oneClickDemoMode: true
   asserts:
   - contains:
       path: spec.template.spec.containers[0].args
-      content: --cluster-id=one-click-demo-mode
+      content: --cluster-name=one-click-demo-mode
 - it: Should pass log format argument if set
   set:
     log:

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

@@ -3,14 +3,14 @@
 ##
 ## @param nameOverride String to partially override generated resource names
 ## @param fullnameOverride String to fully override generated resource names
-## @param clusterId String to identify the kubernetes cluster in the ngrok dashboard (must be unique per Helm release per cluster)
+## @param clusterName String to identify the kubernetes cluster in the ngrok dashboard (must be unique per Helm release per cluster)
 ## @param description ngrok-operator description that will appear in the ngrok dashboard
 ## @param commonLabels Labels to add to all deployed objects
 ## @param commonAnnotations Annotations to add to all deployed objects
 ## @param oneClickDemoMode If true, then the operator will startup without required fields or API registration, become Ready, but not actually be running
 nameOverride: ""
 fullnameOverride: ""
-clusterId: ""
+clusterName: ""
 description: "The official ngrok Kubernetes Operator."
 commonLabels: {}
 commonAnnotations: {}

helm/ngrok-operator/values.yaml

@@ -136,7 +136,7 @@ func (r *KubernetesOperatorReconciler) create(ctx context.Context, ko *ngrokv1al
 		EnabledFeatures: calculateFeaturesEnabled(ko),
 		Region:          ko.Spec.Region,
 		Deployment: ngrok.KubernetesOperatorDeployment{
-			// TODO(hkatz) clusterId
+			// TODO(hkatz) clusterName
 			// Cluster: ko.Spec.Deployment.Cluster,
 			Name:      ko.Spec.Deployment.Name,
 			Namespace: ko.Spec.Deployment.Namespace,
@@ -326,7 +326,7 @@ func ngrokK8sopMatchesKubernetesOperator(k8sop *ngrok.KubernetesOperator, ko *ng
 		return false
 	}
 
-	// TODO(hkatz) clusterId
+	// TODO(hkatz) clusterName
 	// if item.Deployment.Cluster != ko.Spec.Deployment.Cluster {
 	// 	continue
 	// }