Use Helm release to name resources

Makefile

@@ -363,7 +363,7 @@ install-scale-chart: install-chart-prerequisite build/toolchain/bin/helm$(EXE_EX
 install-ci-chart: install-chart-prerequisite build/toolchain/bin/helm$(EXE_EXTENSION) install/helm/open-match/secrets/
 	$(HELM) upgrade $(OPEN_MATCH_HELM_NAME) $(HELM_UPGRADE_FLAGS) --atomic install/helm/open-match $(HELM_IMAGE_FLAGS) \
 		--set query.replicas=1,frontend.replicas=1,backend.replicas=1 \
-		--set evaluator.hostName=test \
+		--set evaluator.hostName=open-match-test \
 		--set evaluator.grpcPort=50509 \
 		--set evaluator.httpPort=51509 \
 		--set open-match-core.registrationInterval=200ms \
@@ -389,9 +389,12 @@ install/yaml/: TAG = $(BASE_VERSION)
 endif
 install/yaml/: update-chart-deps install/yaml/install.yaml install/yaml/01-open-match-core.yaml install/yaml/02-open-match-demo.yaml install/yaml/03-prometheus-chart.yaml install/yaml/04-grafana-chart.yaml install/yaml/05-jaeger-chart.yaml install/yaml/06-open-match-override-configmap.yaml install/yaml/07-open-match-default-evaluator.yaml
 
+# We have to hard-code the Jaeger endpoints as we are excluding Jaeger, so Helm cannot determine the endpoints from the Jaeger subchart
 install/yaml/01-open-match-core.yaml: build/toolchain/bin/helm$(EXE_EXTENSION)
 	mkdir -p install/yaml/
 	$(HELM) template $(OPEN_MATCH_HELM_NAME) $(HELM_TEMPLATE_FLAGS) $(HELM_IMAGE_FLAGS) \
+		--set-string global.telemetry.jaeger.agentEndpoint="$(OPEN_MATCH_HELM_NAME)-jaeger-agent:6831" \
+		--set-string global.telemetry.jaeger.collectorEndpoint="http://$(OPEN_MATCH_HELM_NAME)-jaeger-collector:14268/api/traces" \
 		install/helm/open-match > install/yaml/01-open-match-core.yaml
 
 install/yaml/02-open-match-demo.yaml: build/toolchain/bin/helm$(EXE_EXTENSION)
@@ -409,13 +412,15 @@ install/yaml/03-prometheus-chart.yaml: build/toolchain/bin/helm$(EXE_EXTENSION)
 		--set global.telemetry.prometheus.enabled=true \
 		install/helm/open-match > install/yaml/03-prometheus-chart.yaml
 
+# We have to hard-code the Prometheus Server URL as we are excluding Prometheus, so Helm cannot determine the URL from the Prometheus subchart
 install/yaml/04-grafana-chart.yaml: build/toolchain/bin/helm$(EXE_EXTENSION)
 	mkdir -p install/yaml/
 	$(HELM) template $(OPEN_MATCH_HELM_NAME) $(HELM_TEMPLATE_FLAGS) $(HELM_IMAGE_FLAGS) \
 		--set open-match-core.enabled=false \
 		--set open-match-core.redis.enabled=false \
 		--set open-match-telemetry.enabled=true \
 		--set global.telemetry.grafana.enabled=true \
+		--set-string global.telemetry.grafana.prometheusServer="http://$(OPEN_MATCH_HELM_NAME)-prometheus-server.$(OPEN_MATCH_KUBERNETES_NAMESPACE).svc.cluster.local:80/" \
 		install/helm/open-match > install/yaml/04-grafana-chart.yaml
 
 install/yaml/05-jaeger-chart.yaml: build/toolchain/bin/helm$(EXE_EXTENSION)
@@ -462,7 +467,7 @@ set-redis-password:
 		read REDIS_PASSWORD; \
 		stty echo; \
 		printf "\n"; \
-		$(KUBECTL) create secret generic om-redis -n $(OPEN_MATCH_KUBERNETES_NAMESPACE) --from-literal=redis-password=$$REDIS_PASSWORD --dry-run -o yaml | $(KUBECTL) replace -f - --force
+		$(KUBECTL) create secret generic open-match-redis -n $(OPEN_MATCH_KUBERNETES_NAMESPACE) --from-literal=redis-password=$$REDIS_PASSWORD --dry-run -o yaml | $(KUBECTL) replace -f - --force
 
 install-toolchain: install-kubernetes-tools install-protoc-tools install-openmatch-tools
 install-kubernetes-tools: build/toolchain/bin/kubectl$(EXE_EXTENSION) build/toolchain/bin/helm$(EXE_EXTENSION) build/toolchain/bin/minikube$(EXE_EXTENSION) build/toolchain/bin/terraform$(EXE_EXTENSION)

docs/development.md

@@ -111,8 +111,8 @@ While iterating on the project, you may need to:
 ## Accessing logs
 To look at Open Match core services' logs, run:
 ```bash
-# Replace om-frontend with the service name that you would like to access
-kubectl logs -n open-match svc/om-frontend
+# Replace open-match-frontend with the service name that you would like to access
+kubectl logs -n open-match svc/open-match-frontend
 ```
 
 ## API References

examples/demo/components/clients/clients.go

@@ -81,7 +81,7 @@ func runScenario(ctx context.Context, name string, update updater.SetFunc) {
 	update(s)
 
 	// See https://open-match.dev/site/docs/guides/api/
-	conn, err := grpc.Dial("om-frontend.open-match.svc.cluster.local:50504", grpc.WithInsecure())
+	conn, err := grpc.Dial("open-match-frontend.open-match.svc.cluster.local:50504", grpc.WithInsecure())
 	if err != nil {
 		panic(err)
 	}

examples/demo/components/director/director.go

@@ -68,7 +68,7 @@ func run(ds *components.DemoShared) {
 	ds.Update(s)
 
 	// See https://open-match.dev/site/docs/guides/api/
-	conn, err := grpc.Dial("om-backend.open-match.svc.cluster.local:50505", grpc.WithInsecure())
+	conn, err := grpc.Dial("open-match-backend.open-match.svc.cluster.local:50505", grpc.WithInsecure())
 	if err != nil {
 		panic(err)
 	}

examples/functions/golang/soloduel/main.go

@@ -24,8 +24,8 @@ import (
 )
 
 const (
-	queryServiceAddr = "om-query.open-match.svc.cluster.local:50503" // Address of the QueryService endpoint.
-	serverPort       = 50502                                         // The port for hosting the Match Function.
+	queryServiceAddr = "open-match-query.open-match.svc.cluster.local:50503" // Address of the QueryService endpoint.
+	serverPort       = 50502                                                 // The port for hosting the Match Function.
 )
 
 func main() {

examples/scale/mmf/mmf.go

@@ -39,7 +39,7 @@ var (
 func Run() {
 	activeScenario := scenarios.ActiveScenario
 
-	conn, err := grpc.Dial("om-query.open-match.svc.cluster.local:50503", utilTesting.NewGRPCDialOptions(logger)...)
+	conn, err := grpc.Dial("open-match-query.open-match.svc.cluster.local:50503", utilTesting.NewGRPCDialOptions(logger)...)
 	if err != nil {
 		logger.Fatalf("Failed to connect to Open Match, got %v", err)
 	}

examples/scale/scenarios/scenarios.go

@@ -28,7 +28,7 @@ import (
 )
 
 var (
-	queryServiceAddress = "om-query.open-match.svc.cluster.local:50503" // Address of the QueryService Endpoint.
+	queryServiceAddress = "open-match-query.open-match.svc.cluster.local:50503" // Address of the QueryService Endpoint.
 
 	logger = logrus.WithFields(logrus.Fields{
 		"app": "scale",

install/helm/open-match/subcharts/open-match-customize/templates/_helpers.tpl

@@ -0,0 +1,20 @@
+{*
+ Copyright 2019 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ 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.
+*}
+
+{{/* vim: set filetype=mustache: */}}
+{{- define "openmatchcustomize.function.hostName" -}}
+{{- .Values.function.hostName | default (printf "%s-function" (include "openmatch.fullname" . ) ) -}}
+{{- end -}}

install/helm/open-match/subcharts/open-match-customize/templates/evaluator.yaml

@@ -18,7 +18,7 @@
 kind: Service
 apiVersion: v1
 metadata:
-  name: {{ .Values.evaluator.hostName }}
+  name: {{ include "openmatch.evaluator.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -46,20 +46,20 @@ spec:
 apiVersion: autoscaling/v1
 kind: HorizontalPodAutoscaler
 metadata:
-  name: {{ .Values.evaluator.hostName }}
+  name: {{ include "openmatch.evaluator.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
-    name: {{ .Values.evaluator.hostName }}
+    name: {{ include "openmatch.evaluator.hostName" . }}
   {{- include "openmatch.HorizontalPodAutoscaler.spec.common" . | nindent 2 }}
 ---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ .Values.evaluator.hostName }}
+  name: {{ include "openmatch.evaluator.hostName" . }}
   namespace: {{ .Release.Namespace }}
   labels:
     app: {{ template "openmatch.name" . }}
@@ -83,11 +83,11 @@ spec:
         release: {{ .Release.Name }}
     spec:
       volumes:
-        {{- include "openmatch.volumes.configs" (dict "configs" .Values.evaluatorConfigs) | nindent 8}}
+        {{- include "openmatch.volumes.configs" (. | merge (dict "configs" .Values.evaluatorConfigs)) | nindent 8}}
         {{- include "openmatch.volumes.tls" . | nindent 8}}
-      serviceAccountName: {{ .Values.global.kubernetes.serviceAccount }}
+      serviceAccountName: {{ include "openmatch.serviceAccount.name" . }}
       containers:
-      - name: {{ .Values.evaluator.hostName }}
+      - name: {{ include "openmatch.evaluator.hostName" . }}
         volumeMounts:
           {{- include "openmatch.volumemounts.configs" (dict "configs" .Values.evaluatorConfigs) | nindent 10 }}
           {{- include "openmatch.volumemounts.tls" . | nindent 10 }}

install/helm/open-match/subcharts/open-match-customize/templates/matchfunctions.yaml

@@ -18,7 +18,7 @@
 kind: Service
 apiVersion: v1
 metadata:
-  name: {{ .Values.function.hostName }}
+  name: {{ include "openmatchcustomize.function.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -46,20 +46,20 @@ spec:
 apiVersion: autoscaling/v1
 kind: HorizontalPodAutoscaler
 metadata:
-  name: {{ .Values.function.hostName }}
+  name: {{ include "openmatchcustomize.function.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
     kind: Deployment
-    name: {{ .Values.function.hostName }}
+    name: {{ include "openmatchcustomize.function.hostName" . }}
   {{- include "openmatch.HorizontalPodAutoscaler.spec.common" . | nindent 2 }}
 ---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ .Values.function.hostName }}
+  name: {{ include "openmatchcustomize.function.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -84,11 +84,11 @@ spec:
         release: {{ .Release.Name }}
     spec:
       volumes:
-        {{- include "openmatch.volumes.configs" (dict "configs" .Values.mmfConfigs) | nindent 8}}
+        {{- include "openmatch.volumes.configs" (. | merge (dict "configs" .Values.mmfConfigs)) | nindent 8}}
         {{- include "openmatch.volumes.tls" . | nindent 8}}
-      serviceAccountName: {{ .Values.global.kubernetes.serviceAccount }}
+      serviceAccountName: {{ include "openmatch.serviceAccount.name" . }}
       containers:
-      - name: {{ .Values.function.hostName }}
+      - name: {{ include "openmatchcustomize.function.hostName" . }}
         volumeMounts:
           {{- include "openmatch.volumemounts.configs" (dict "configs" .Values.mmfConfigs) | nindent 10 }}
           {{- include "openmatch.volumemounts.tls" . | nindent 10 }}

install/helm/open-match/subcharts/open-match-customize/values.yaml

@@ -35,11 +35,13 @@ evaluatorConfigs:
   default:
     volumeName: om-config-volume-default
     mountPath: /app/config/default
-    configName: om-configmap-default
+    # This will be parsed through the `tpl` function.
+    configName: '{{ include "openmatch.configmap.default" . }}'
   customize:
     volumeName: om-config-volume-override
     mountPath: /app/config/override
-    configName: om-configmap-override
+    # This will be parsed through the `tpl` function.
+    configName: '{{ include "openmatch.configmap.override" . }}'
 
 mmfConfigs:
   # We use harness to implement the MMFs. MMF itself only requires one configmap but harness expects two,
@@ -48,8 +50,10 @@ mmfConfigs:
   default:
     volumeName: om-config-volume-default
     mountPath: /app/config/default
-    configName: om-configmap-default
+    # This will be parsed through the `tpl` function.
+    configName: '{{ include "openmatch.configmap.default" . }}'
   customize:
     volumeName: om-config-volume-override
     mountPath: /app/config/override
-    configName: om-configmap-override
+    # This will be parsed through the `tpl` function.
+    configName: '{{ include "openmatch.configmap.override" . }}'

install/helm/open-match/subcharts/open-match-scale/templates/_helpers.tpl

@@ -0,0 +1,42 @@
+{*
+ Copyright 2019 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ 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.
+*}
+
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "openmatchscale.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{- define "openmatchscale.scaleBackend.hostName" -}}
+{{- .Values.scaleBackend.hostName | default (printf "%s-backend" (include "openmatchscale.fullname" . ) ) -}}
+{{- end -}}
+
+{{- define "openmatchscale.scaleFrontend.hostName" -}}
+{{- .Values.scaleFrontend.hostName | default (printf "%s-frontend" (include "openmatchscale.fullname" . ) ) -}}
+{{- end -}}

install/helm/open-match/subcharts/open-match-scale/templates/scale-backend.yaml

@@ -15,7 +15,7 @@
 kind: Service
 apiVersion: v1
 metadata:
-  name: {{ .Values.scaleBackend.hostName }}
+  name: {{ include "openmatchscale.scaleBackend.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -34,7 +34,7 @@ spec:
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: {{ .Values.scaleBackend.hostName }}
+  name: {{ include "openmatchscale.scaleBackend.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -59,11 +59,11 @@ spec:
         release: {{ .Release.Name }}
     spec:
       volumes:
-        {{- include "openmatch.volumes.configs" (dict "configs" .Values.configs) | nindent 8}}
+        {{- include "openmatch.volumes.configs" (. | merge (dict "configs" .Values.configs)) | nindent 8}}
         {{- include "openmatch.volumes.tls" . | nindent 8}}
-      serviceAccountName: {{ .Values.global.kubernetes.serviceAccount }}
+      serviceAccountName: {{ include "openmatch.serviceAccount.name" . }}
       containers:
-      - name: {{ .Values.scaleBackend.hostName }}
+      - name: {{ include "openmatchscale.scaleBackend.hostName" . }}
         volumeMounts:
           {{- include "openmatch.volumemounts.configs" (dict "configs" .Values.configs) | nindent 10 }}
           {{- include "openmatch.volumemounts.tls" . | nindent 10 }}

install/helm/open-match/subcharts/open-match-scale/templates/scale-frontend.yaml

@@ -15,7 +15,7 @@
 kind: Service
 apiVersion: v1
 metadata:
-  name: {{ .Values.scaleFrontend.hostName }}
+  name: {{ include "openmatchscale.scaleFrontend.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -34,7 +34,7 @@ spec:
 apiVersion: extensions/v1beta1
 kind: Deployment
 metadata:
-  name: {{ .Values.scaleFrontend.hostName }}
+  name: {{ include "openmatchscale.scaleFrontend.hostName" . }}
   namespace: {{ .Release.Namespace }}
   annotations: {{- include "openmatch.chartmeta" . | nindent 4 }}
   labels:
@@ -59,11 +59,11 @@ spec:
         release: {{ .Release.Name }}
     spec:
       volumes:
-        {{- include "openmatch.volumes.configs" (dict "configs" .Values.configs) | nindent 8}}
+        {{- include "openmatch.volumes.configs" (. | merge (dict "configs" .Values.configs)) | nindent 8}}
         {{- include "openmatch.volumes.tls" . | nindent 8}}
-      serviceAccountName: {{ .Values.global.kubernetes.serviceAccount }}
+      serviceAccountName: {{ include "openmatch.serviceAccount.name" . }}
       containers:
-      - name: {{ .Values.scaleFrontend.hostName }}
+      - name: {{ include "openmatchscale.scaleFrontend.hostName" . }}
         volumeMounts:
           {{- include "openmatch.volumemounts.configs" (dict "configs" .Values.configs) | nindent 10 }}
           {{- include "openmatch.volumemounts.tls" . | nindent 10 }}

install/helm/open-match/subcharts/open-match-scale/templates/scale-grafana-dashboard.yaml

@@ -16,7 +16,7 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: open-match-scale-dashboard
+  name: {{ include "openmatchscale.fullname" . }}-dashboard
   namespace: {{ .Release.Namespace }}
   labels:
      grafana_dashboard: "1"