Merge pull request #120 from dasmeta/DMVP-5655-sentry-relay-helm-chart

feat(DMVP-5655): new sentry-relay helm chart

README.md

@@ -0,0 +1,8 @@
+# The Dasmeta kubernetes helm charts
+
+## To be able to install the charts please add dasmeta repo as follows:
+```sh
+helm repo add dasmeta https://dasmeta.github.io/helm
+```
+
+### The available charts and the docs how to configure them can be found in [./charts](./charts) folder

charts/sentry-relay/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/sentry-relay/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: sentry-relay
+description: A Helm chart for Kubernetes to create sentry relay with proxy, managed or static mode
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "0.1.0"

charts/sentry-relay/README.md

@@ -0,0 +1,58 @@
+## This helm chart allows to create sentry relay app in kubernetes cluster https://docs.sentry.io/product/relay/
+
+### Here are values.yaml file structures for creation relay with sentry cloud by supported proxy, managed or static modes by using minimum configs
+### NOTE: 
+ - By default it creates relay on proxy mode with DaemonSet workload
+ - In case you created sentry cloud on europe region the upstream value is in form https://<ORGANIZATION-ID>.ingest.de.sentry.io
+ - It should be possible to use this chart also for non sentry cloud setups, but this is not tested yet
+
+
+### "proxy" mode (simplest mode without additional configs)
+```yaml
+# file values-proxy-mode.yaml
+upstream: https://<ORGANIZATION-ID>.ingest.sentry.io
+```
+
+### "managed" mode (https://docs.sentry.io/product/relay/getting-started/#creating-credentials)
+```yaml
+# file values-managed-mode.yaml
+mode: managed
+upstream: https://<ORGANIZATION-ID>.ingest.sentry.io
+credentials:
+  secretKey: "<SECRET-KEY>"
+  publicKey: "<PUBLIC-KEY>"
+  id: "<ID>"
+```
+
+### "static" mode (https://docs.sentry.io/product/relay/projects/)
+```yaml
+# file values-static-mode.yaml
+mode: static
+upstream: https://<ORGANIZATION-ID>.ingest.sentry.io
+projects:
+  "<PROJECT-ID>":
+    slug: "<PROJECT-SLUG>"
+    disabled: false
+    publicKeys:
+      - publicKey: "<PROJECT-PUBLIC-KEY>"
+        isEnabled: true
+    config:
+      allowedDomains: ["*"]
+      features: # this options can vary on different setups, please check
+        - organizations:session-replay
+        - organizations:session-replay-recording-scrubbing
+        - organizations:session-replay-combined-envelope-items
+        - organizations:session-replay-video-disabled
+        - organizations:device-class-synthesis
+        - organizations:custom-metrics
+        - organizations:profiling
+        - organizations:standalone-span-ingestion
+        - projects:relay-otel-endpoint
+        - projects:discard-transaction
+        - organizations:continuous-profiling
+        - projects:span-metrics-extraction
+        - projects:span-metrics-extraction-addons
+        - organizations:indexed-spans-extraction
+        - organizations:performance-queries-mongodb-extraction
+```
+

charts/sentry-relay/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "sentry-relay.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "sentry-relay.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "sentry-relay.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "sentry-relay.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:3000 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 3000:$CONTAINER_PORT
+{{- end }}

charts/sentry-relay/templates/_helpers.tpl

@@ -0,0 +1,86 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "sentry-relay.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+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 "sentry-relay.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 }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "sentry-relay.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "sentry-relay.labels" -}}
+helm.sh/chart: {{ include "sentry-relay.chart" . }}
+{{ include "sentry-relay.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "sentry-relay.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "sentry-relay.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "sentry-relay.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "sentry-relay.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+the content of sentry relay /work/.relay/config.yaml config file
+*/}}
+{{- define "sentry-relay.config.yaml" -}}
+  relay:
+    mode: {{ .Values.mode }}
+    upstream: {{ .Values.upstream }}
+    host: 0.0.0.0
+    port: {{ .Values.service.port }}
+
+    logging:
+      level: {{ .Values.loggingLevel }}
+      format: json
+{{- end }}
+
+{{/*
+the content of sentry relay /work/.relay/credentials.json managed mode credentials file
+*/}}
+{{- define "sentry-relay.managed.credentials.json" -}}
+secret_key: {{ .Values.credentials.secretKey }}
+public_key: {{ .Values.credentials.publicKey }}
+id: {{ .Values.credentials.id }}
+{{- end }}

charts/sentry-relay/templates/configmap.yaml

@@ -0,0 +1,18 @@
+kind: ConfigMap
+apiVersion: v1
+metadata:
+  name: {{ include "sentry-relay.fullname" . }}-configs
+data: 
+  config.yml: {{- toYaml ( include "sentry-relay.config.yaml" . ) | nindent 2 }}
+
+  {{- if eq .Values.mode "managed" }}
+  credentials.json: |-
+{{- toJson ( fromYaml ( include "sentry-relay.managed.credentials.json" . )) | nindent 4 }}
+  {{- end }}
+
+  {{- if eq .Values.mode "static" }}
+  {{- range $key, $value := .Values.projects }}
+  "projects-{{- $key }}.json": |-
+{{- toJson $value | nindent 4 }}
+  {{- end }}
+  {{- end }}

charts/sentry-relay/templates/hpa.yaml

@@ -0,0 +1,32 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "sentry-relay.fullname" . }}
+  labels:
+    {{- include "sentry-relay.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "sentry-relay.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    {{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: cpu
+        target:
+          type: Utilization
+          averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+    {{- end }}
+    {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    - type: Resource
+      resource:
+        name: memory
+        target:
+          type: Utilization
+          averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
+    {{- end }}
+{{- end }}

charts/sentry-relay/templates/ingress.yaml

@@ -0,0 +1,61 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "sentry-relay.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "sentry-relay.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

charts/sentry-relay/templates/service.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "sentry-relay.fullname" . }}
+  labels:
+    {{- include "sentry-relay.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "sentry-relay.selectorLabels" . | nindent 4 }}

charts/sentry-relay/templates/serviceaccount.yaml

@@ -0,0 +1,13 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "sentry-relay.serviceAccountName" . }}
+  labels:
+    {{- include "sentry-relay.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+automountServiceAccountToken: {{ .Values.serviceAccount.automount }}
+{{- end }}

charts/sentry-relay/templates/tests/test-connection.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "{{ include "sentry-relay.fullname" . }}-test-connection"
+  labels:
+    {{- include "sentry-relay.labels" . | nindent 4 }}
+  annotations:
+    "helm.sh/hook": test
+spec:
+  containers:
+    - name: wget
+      image: busybox
+      command: ['wget']
+      args: ['{{ include "sentry-relay.fullname" . }}:{{ .Values.service.port }}']
+  restartPolicy: Never