Add helm chart

eset · Nov 27, 2024 · 634c9c1 · 634c9c1
1 parent 187a254
commit 634c9c1
Show file tree

Hide file tree

Showing 14 changed files with 588 additions and 0 deletions.
diff --git a/charts/grpc-rest-proxy/.helmignore b/charts/grpc-rest-proxy/.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/
diff --git a/charts/grpc-rest-proxy/Chart.yaml b/charts/grpc-rest-proxy/Chart.yaml
@@ -0,0 +1,24 @@
+apiVersion: v2
+name: grpc-rest-proxy
+description: A Helm chart for Kubernetes
+
+# 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: "1.16.0"
diff --git a/charts/grpc-rest-proxy/README.md b/charts/grpc-rest-proxy/README.md
@@ -0,0 +1,103 @@
+# Helm chart for grpc-rest-propxy
+
+- It is recommended to run grpc-rest-proxy as sidecar proxy (see [../../README.md] for more info).
+- Helm chart can be used to run grpc-rest-proxy as standalone Kubernetes depoloyment.
+
+## Example usage
+
+```bash
+helm upgrade \
+    --install \
+    --namespace ${GRPC_REST_PROXY_NAMESPACE} \
+    --set grpcRestProxy.grpcTargetAddr=${GRPC_REST_PROXY_TARGET_GRPC_SERVER_ADDR} \
+    --image.repository=${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/grpc-rest-proxy \
+    --image.tag=latest \
+    grpc-rest-proxy ./charts/grpc-rest-proxy
+```
+
+### Example usage with example-grpc-server
+
+#### 1. Prepare app containers
+
+Build and push containers for grpc-rest-proxy and example-grpc-server
+
+```bash
+docker build -f cmd/examples/grpcserver/Dockerfile -t ${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/example-grpc-server:latest .
+docker build -f Dockerfile -t ${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/grpc-rest-proxy:latest .
+
+docker push ${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/example-grpc-server:latest
+docker push ${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/grpc-rest-proxy:latest
+```
+
+#### 2. Deploy example-grpc-server as standalone Kubernetes deployment
+
+Update `spec.template.spec.containers[0].image` with existing container repository
+
+```bash
+kubectl apply -f - <<EOF
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: example-grpc-server
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: example-grpc-server
+  namespace: example-grpc-server
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: example-grpc-server
+  template:
+    metadata:
+      labels:
+        app: example-grpc-server
+    spec:
+      containers:
+      - name: example-grpc-server
+        image: ${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/example-grpc-server:latest
+        ports:
+        - containerPort: 50051
+        command: ["/app/example-grpc-server"]
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: example-grpc-server
+  namespace: example-grpc-server
+spec:
+  selector:
+    app: example-grpc-server
+  ports:
+  - protocol: TCP
+    port: 50051
+    targetPort: 50051
+  type: ClusterIP
+EOF
+```
+
+Example grpc server should be running on addr example-grpc-server:50051
+
+#### 3. Deploy grpc-rest-proxy as standalone Kubernetes deployment
+
+```bash
+helm upgrade \
+    --install \
+    --namespace example-grpc-server \
+    --set grpcRestProxy.grpcTargetAddr=example-grpc-server:50051 \
+    --set image.repository=${GRPC_REST_PROXY_CONTAINER_REPOSITORY}/grpc-rest-proxy \
+    --set image.tag=latest \
+    grpc-rest-proxy ./charts/grpc-rest-proxy
+```
+
+#### 4. Send HTTP request to example-grpc-server through grpc-rest-proxy
+
+```bash
+POD_NAME=$(kubectl get pods --namespace example-grpc-server -l "app.kubernetes.io/name=grpc-rest-proxy,app.kubernetes.io/instance=grpc-rest-proxy" -o jsonpath="{.items[0].metadata.name}")
+CONTAINER_PORT=$(kubectl get pod --namespace example-grpc-server $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+kubectl --namespace example-grpc-server port-forward $POD_NAME 8080:$CONTAINER_PORT
+
+curl http://127.0.0.1:8080/api/users/John
+```
diff --git a/charts/grpc-rest-proxy/templates/NOTES.txt b/charts/grpc-rest-proxy/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 "grpc-rest-proxy.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 "grpc-rest-proxy.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "grpc-rest-proxy.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 "grpc-rest-proxy.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:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}
diff --git a/charts/grpc-rest-proxy/templates/_helpers.tpl b/charts/grpc-rest-proxy/templates/_helpers.tpl
@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "grpc-rest-proxy.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 "grpc-rest-proxy.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 "grpc-rest-proxy.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "grpc-rest-proxy.labels" -}}
+helm.sh/chart: {{ include "grpc-rest-proxy.chart" . }}
+{{ include "grpc-rest-proxy.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "grpc-rest-proxy.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "grpc-rest-proxy.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "grpc-rest-proxy.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "grpc-rest-proxy.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
diff --git a/charts/grpc-rest-proxy/templates/deployment.yaml b/charts/grpc-rest-proxy/templates/deployment.yaml
@@ -0,0 +1,75 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "grpc-rest-proxy.fullname" . }}
+  labels:
+    {{- include "grpc-rest-proxy.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "grpc-rest-proxy.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "grpc-rest-proxy.labels" . | nindent 8 }}
+        {{- with .Values.podLabels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "grpc-rest-proxy.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          command: ["/app/grpc-rest-proxy"]
+          args:
+            - "--gateways.grpc.client.targetAddr={{ .Values.grpcRestProxy.grpcTargetAddr }}"
+            - "--transport.http.server.addr=0.0.0.0:{{ .Values.service.port }}"
+            {{- with .Values.grpcRestProxy.extraArgs }}
+            {{- toYaml . | nindent 12 }}
+            {{- end }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.service.port }}
+              protocol: TCP
+          livenessProbe:
+            {{- toYaml .Values.livenessProbe | nindent 12 }}
+          readinessProbe:
+            {{- toYaml .Values.readinessProbe | nindent 12 }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          {{- with .Values.volumeMounts }}
+          volumeMounts:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+      {{- with .Values.volumes }}
+      volumes:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
diff --git a/charts/grpc-rest-proxy/templates/hpa.yaml b/charts/grpc-rest-proxy/templates/hpa.yaml
@@ -0,0 +1,32 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "grpc-rest-proxy.fullname" . }}
+  labels:
+    {{- include "grpc-rest-proxy.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "grpc-rest-proxy.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 }}
diff --git a/charts/grpc-rest-proxy/templates/ingress.yaml b/charts/grpc-rest-proxy/templates/ingress.yaml
@@ -0,0 +1,43 @@
+{{- if .Values.ingress.enabled -}}
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: {{ include "grpc-rest-proxy.fullname" . }}
+  labels:
+    {{- include "grpc-rest-proxy.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- with .Values.ingress.className }}
+  ingressClassName: {{ . }}
+  {{- 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 }}
+            {{- with .pathType }}
+            pathType: {{ . }}
+            {{- end }}
+            backend:
+              service:
+                name: {{ include "grpc-rest-proxy.fullname" $ }}
+                port:
+                  number: {{ $.Values.service.port }}
+          {{- end }}
+    {{- end }}
+{{- end }}