chore: cleanup unused templates (#3707)

* chore: add checks to cleanup unused templates Signed-off-by: Dominik Rosiek <[email protected]> * chore: remove unused templates Signed-off-by: Dominik Rosiek <[email protected]> * chore: add comment to script Signed-off-by: Dominik Rosiek <[email protected]> --------- Signed-off-by: Dominik Rosiek <[email protected]>
SumoLogic · May 16, 2024 · a687ab1 · a687ab1
1 parent 6cb8dd5
commit a687ab1
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 80 deletions.
diff --git a/.github/workflows/pull_requests.yml b/.github/workflows/pull_requests.yml
@@ -201,3 +201,11 @@ jobs:
  - name: Failure
  if: ${{ always() && !(needs.run-integration-tests.result == 'success' || needs.run-integration-tests.result == 'skipped') }}
  run: exit 1
+
+ unused-templates:
+ name: Check for unused templates
+ runs-on: ubuntu-22.04
+ steps:
+ - uses: actions/checkout@v4
+ - name: Check for unused templates
+ run: make check-unused-templates
diff --git a/Makefile b/Makefile
@@ -182,3 +182,7 @@ vhalt:
 .PHONY: vdestroy
 vdestroy:
  vagrant destroy -f
+
+.PHONY: check-unused-templates
+check-unused-templates:
+ ./ci/check_unused_templates.sh
diff --git a/ci/check_unused_templates.sh b/ci/check_unused_templates.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# This scripts checks for unused helm template definitions
+TEMPLATES=$(cat deploy/helm/sumologic/templates/_helpers/*.tpl | grep define | grep -oP '".*?"' || true)
+RETURN=0
+for template in ${TEMPLATES}; do
+ if ! grep -P "(template|include) ${template}" deploy/helm/sumologic -R > /dev/null; then
+ echo "${template}";
+ RETURN=1
+ fi
+done
+
+exit "${RETURN}"
diff --git a/deploy/helm/sumologic/templates/_helpers/_common.tpl b/deploy/helm/sumologic/templates/_helpers/_common.tpl
@@ -1,10 +1,3 @@
-{{/*
-Expand the name of the chart.
-*/}}
-{{- define "sumologic.name" -}}
-{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
-{{- end -}}
-
 {{/*
 Create a default fully qualified app name.
 We truncate at 22 chars because some Kubernetes name fields are limited to 63 characters (by the DNS naming spec).

diff --git a/deploy/helm/sumologic/templates/_helpers/_logs.tpl b/deploy/helm/sumologic/templates/_helpers/_logs.tpl
@@ -42,11 +42,6 @@ Example Usage:
 {{ $enabled }}
 {{- end -}}
 
-{{- define "logs.collector.otelcloudwatch.enabled" -}}
-{{- $enabled := and (eq (include "logs.enabled" .) "true") (eq .Values.sumologic.logs.collector.otelcloudwatch.enabled true) -}}
-{{ $enabled }}
-{{- end -}}
-
 {{- define "logs.collector.otellogswindows.enabled" -}}
 {{- $enabled := and (eq (include "logs.enabled" .) "true") (eq .Values.sumologic.logs.collector.otellogswindows.enabled true) -}}
 {{ $enabled }}
@@ -156,10 +151,6 @@ Return the exporters for kubelet log pipeline.
 {{- template "sumologic.metadata.name.logs.collector" . }}
 {{- end -}}
 
-{{- define "sumologic.metadata.name.logs.collector.windows.serviceaccount" -}}
-{{- template "sumologic.metadata.name.logs.collector.windows" . }}
-{{- end -}}
-
 {{- define "sumologic.metadata.name.logs.collector.cloudwatch.serviceaccount" -}}
 {{- template "sumologic.metadata.name.logs.collector" . }}
 {{- end -}}
@@ -180,10 +171,6 @@ Return the exporters for kubelet log pipeline.
 {{- template "sumologic.metadata.name.logs.collector" . }}
 {{- end -}}
 
-{{- define "sumologic.metadata.name.logs.collector.windows.service" -}}
-{{- template "sumologic.metadata.name.logs.collector.windows" . }}
-{{- end -}}
-
 {{- define "sumologic.labels.app.logs.collector" -}}
 {{- template "sumologic.fullname" . }}-otelcol-logs-collector
 {{- end -}}
@@ -318,11 +305,6 @@ sumologic.com/app: otelcol-logs-collector
 sumologic.com/component: logs
 {{- end -}}
 
-{{- define "sumologic.labels.logs.collector.windows" -}}
-sumologic.com/app: otelcol-logs-windows-collector
-sumologic.com/component: logs
-{{- end -}}
-
 {{- define "sumologic.labels.scrape.logs" -}}
 {{ template "sumologic.label.scrape" . }}
 {{ template "sumologic.labels.logs" . }}
@@ -333,11 +315,6 @@ sumologic.com/component: logs
 {{ template "sumologic.labels.logs.collector" . }}
 {{- end -}}
 
-{{- define "sumologic.labels.scrape.logs.collector.windows" -}}
-{{ template "sumologic.label.scrape" . }}
-{{ template "sumologic.labels.logs.collector.windows" . }}
-{{- end -}}
-
 {{- define "sumologic.metadata.name.pvcCleaner.logs" -}}
 {{- template "sumologic.metadata.name.pvcCleaner" . }}-logs
 {{- end -}}
@@ -384,14 +361,6 @@ Return the otelcol log collector image
 {{- end -}}
 {{- end -}}
 
-{{- define "sumologic.logs.collector.windows.tolerations" -}}
-{{- if .Values.otellogswindows.daemonset.tolerations -}}
-{{- toYaml .Values.otellogswindows.daemonset.tolerations -}}
-{{- else -}}
-{{- template "kubernetes.defaultTolerations" . -}}
-{{- end -}}
-{{- end -}}
-
 {{/*
 Check if autoscaling for metadata logs is enabled.
 

diff --git a/deploy/helm/sumologic/templates/_helpers/_metrics.tpl b/deploy/helm/sumologic/templates/_helpers/_metrics.tpl
@@ -231,11 +231,6 @@ sumologic.com/app: otelcol-metrics
 sumologic.com/component: metrics
 {{- end -}}
 
-{{- define "sumologic.labels.metrics.remoteWriteProxy" -}}
-sumologic.com/app: metrics-remote-write-proxy
-sumologic.com/component: metrics
-{{- end -}}
-
 {{- define "sumologic.label.scrape" -}}
 sumologic.com/scrape: "true"
 {{- end -}}
@@ -265,11 +260,6 @@ sumologic.com/component: metrics
 sumologic.com/app: otelcol
 {{- end -}}
 
-{{- define "sumologic.labels.app.metrics.collector.pod" -}}
-{{ template "sumologic.labels.app.metrics.collector" . }}
-{{ template "sumologic.labels.component.metrics" . }}
-{{- end -}}
-
 {{- define "sumologic.labels.metrics.clusterrole" -}}
 {{- template "sumologic.labels.component.metrics" . }}
 {{- end -}}

diff --git a/deploy/helm/sumologic/templates/_helpers/_setup.tpl b/deploy/helm/sumologic/templates/_helpers/_setup.tpl
@@ -48,18 +48,6 @@ Example usage:
 SUMO_ENDPOINT_{{ replace "-" "_" . | upper }}
 {{- end -}}
 
-{{/*
-Generate endpoint variable string for given string
-
-Example usage:
-
-{{ include "terraform.sources.endpoint" "logs" }}
-
-*/}}
-{{- define "terraform.sources.endpoint_name" -}}
-{{ printf "endpoint-%s" . }}
-{{- end -}}
-
 {{/*
 Generate line for local Terraform section
  * `terraform.sources.local = value`

diff --git a/deploy/helm/sumologic/templates/_helpers/_sumologic_mock.tpl b/deploy/helm/sumologic/templates/_helpers/_sumologic_mock.tpl
@@ -21,10 +21,6 @@
 {{ template "sumologic.labels.app.sumologic-mock" . }}
 {{- end -}}
 
-{{- define "sumologic.metadata.name.sumologic-mock" -}}
-{{- template "sumologic.fullname" . }}-mock
-{{- end -}}
-
 {{- define "sumologic-mock.deployment.nodeSelector" -}}
 {{- template "nodeSelector" (dict "Values" .Values "nodeSelector" .Values.debug.sumologicMock.deployment.nodeSelector)}}
 {{- end -}}

diff --git a/deploy/helm/sumologic/templates/_helpers/_traces.tpl b/deploy/helm/sumologic/templates/_helpers/_traces.tpl
@@ -18,10 +18,6 @@
 {{- template "sumologic.labels.app.tracessampler.service" . }}-headless
 {{- end -}}
 
-{{- define "sumologic.labels.app.tracessampler.service-metrics" -}}
-{{- template "sumologic.labels.app.tracessampler.service" . }}-instr-metrics
-{{- end -}}
-
 {{- define "sumologic.labels.app.tracessampler.configmap" -}}
 {{- template "sumologic.labels.app.tracessampler" . }}
 {{- end -}}
@@ -50,10 +46,6 @@
 {{- template "sumologic.labels.app.otelcolinstrumentation" . }}
 {{- end -}}
 
-{{- define "sumologic.labels.app.otelcolinstrumentation.statefulset" -}}
-{{- template "sumologic.labels.app.otelcolinstrumentation" . }}
-{{- end -}}
-
 {{- define "sumologic.labels.app.otelcolinstrumentation.component" -}}
 {{- template "sumologic.labels.app.otelcolinstrumentation" . }}-component
 {{- end -}}
@@ -78,10 +70,6 @@
 {{- template "sumologic.labels.app.tracesgateway" . }}
 {{- end -}}
 
-{{- define "sumologic.labels.app.tracesgateway.deployment" -}}
-{{- template "sumologic.labels.app.tracesgateway" . }}
-{{- end -}}
-
 {{- define "sumologic.labels.app.tracesgateway.component" -}}
 {{- template "sumologic.labels.app.tracesgateway" . }}-component
 {{- end -}}
@@ -221,10 +209,6 @@ Example Usage:
 {{- printf "%s.%s" ( include "sumologic.metadata.name.tracessampler.service-headless" . ) ( include "sumologic.namespace" . ) }}
 {{- end -}}
 
-{{- define "opentelemetry-operator.controller.manager.metrics.service.url" -}}
-http://{{ .Release.Name }}-opentelemetry-operator.{{ template "sumologic.namespace" . }}:8080/metrics
-{{- end -}}
-
 {{/*
 Return otlp or none for Instrumentation resource exporters configuration.