From 38f03488845daf7801416762e7b860249c18bc72 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Tue, 16 Apr 2024 17:45:45 +0200 Subject: [PATCH] Add Helm Chart Signed-off-by: Knut Ahlers --- .git_changerelease.yaml | 7 ++ .github/workflows/test-and-build.yml | 40 ++++++- .gitignore | 3 +- Makefile | 3 + charts/latestver/.helmignore | 23 ++++ charts/latestver/Chart.yaml | 6 + charts/latestver/templates/NOTES.txt | 22 ++++ charts/latestver/templates/_helpers.tpl | 62 ++++++++++ charts/latestver/templates/deployment.yaml | 77 ++++++++++++ charts/latestver/templates/hpa.yaml | 32 +++++ charts/latestver/templates/ingress.yaml | 61 ++++++++++ charts/latestver/templates/service.yaml | 15 +++ .../latestver/templates/serviceaccount.yaml | 13 +++ charts/latestver/values.yaml | 110 ++++++++++++++++++ ci/patch-chart-version.sh | 16 +++ 15 files changed, 488 insertions(+), 2 deletions(-) create mode 100644 .git_changerelease.yaml create mode 100644 charts/latestver/.helmignore create mode 100644 charts/latestver/Chart.yaml create mode 100644 charts/latestver/templates/NOTES.txt create mode 100644 charts/latestver/templates/_helpers.tpl create mode 100644 charts/latestver/templates/deployment.yaml create mode 100644 charts/latestver/templates/hpa.yaml create mode 100644 charts/latestver/templates/ingress.yaml create mode 100644 charts/latestver/templates/service.yaml create mode 100644 charts/latestver/templates/serviceaccount.yaml create mode 100644 charts/latestver/values.yaml create mode 100755 ci/patch-chart-version.sh diff --git a/.git_changerelease.yaml b/.git_changerelease.yaml new file mode 100644 index 0000000..c6f01d5 --- /dev/null +++ b/.git_changerelease.yaml @@ -0,0 +1,7 @@ +--- + +release_commit_message: "Release: Go-LatestVer {{.Version}}" +pre_commit_commands: + - bash ci/patch-chart-version.sh + +... diff --git a/.github/workflows/test-and-build.yml b/.github/workflows/test-and-build.yml index 6944079..918d1ec 100644 --- a/.github/workflows/test-and-build.yml +++ b/.github/workflows/test-and-build.yml @@ -33,7 +33,45 @@ jobs: - name: Lint and test code run: | - make go_test + make go_test helm_lint + + helm-publish: + if: ${{ startsWith(github.ref, 'refs/tags/v') }} + + needs: + - test-and-build + + defaults: + run: + shell: bash + + container: + image: luzifer/gh-arch-env + env: + CGO_ENABLED: 0 + GOPATH: /go + + runs-on: ubuntu-latest + + permissions: + packages: write + + steps: + - uses: actions/checkout@v4 + with: + show-progress: false + + - name: Log into registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Package Helm Chart + run: | + helm package charts/latestver + helm push latestver-*.tgz oci://ghcr.io/luzifer docker-publish: if: ${{ startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master' }} diff --git a/.gitignore b/.gitignore index d730a15..217d9de 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ config.yaml .env frontend/app.css frontend/app.js -go-latestver +/go-latestver latestver.db node_modules +/latestver-*.tgz diff --git a/Makefile b/Makefile index 478488c..f1f37da 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,9 @@ go_test: go test -cover -v ./... golangci-lint run +helm_lint: + helm lint charts/latestver + # --- Documentation gendoc: .venv diff --git a/charts/latestver/.helmignore b/charts/latestver/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/latestver/.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/latestver/Chart.yaml b/charts/latestver/Chart.yaml new file mode 100644 index 0000000..e15dcdd --- /dev/null +++ b/charts/latestver/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +name: latestver +description: Hosting go-latestver on Kubernetes +type: application +version: 0.1.0 +appVersion: v0.9.0 diff --git a/charts/latestver/templates/NOTES.txt b/charts/latestver/templates/NOTES.txt new file mode 100644 index 0000000..5afc690 --- /dev/null +++ b/charts/latestver/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 "go-latestver.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 the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "go-latestver.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "go-latestver.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 "go-latestver.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/latestver/templates/_helpers.tpl b/charts/latestver/templates/_helpers.tpl new file mode 100644 index 0000000..6131715 --- /dev/null +++ b/charts/latestver/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "go-latestver.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 "go-latestver.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 "go-latestver.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "go-latestver.labels" -}} +helm.sh/chart: {{ include "go-latestver.chart" . }} +{{ include "go-latestver.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "go-latestver.selectorLabels" -}} +app.kubernetes.io/name: {{ include "go-latestver.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "go-latestver.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "go-latestver.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/latestver/templates/deployment.yaml b/charts/latestver/templates/deployment.yaml new file mode 100644 index 0000000..4069b50 --- /dev/null +++ b/charts/latestver/templates/deployment.yaml @@ -0,0 +1,77 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "go-latestver.fullname" . }} + labels: + {{- include "go-latestver.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "go-latestver.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "go-latestver.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "go-latestver.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + env: + - name: CONFIG + value: /config/config.yaml + 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 }} + volumeMounts: + - name: config + mountPath: /config + readOnly: true + {{- with .Values.volumeMounts }} + {{- toYaml . | nindent 12 }} + {{- end }} + volumes: + - name: config + configMap: + name: {{ include "go-latestver.fullname" . }} + {{- with .Values.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/latestver/templates/hpa.yaml b/charts/latestver/templates/hpa.yaml new file mode 100644 index 0000000..fd87d6b --- /dev/null +++ b/charts/latestver/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "go-latestver.fullname" . }} + labels: + {{- include "go-latestver.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "go-latestver.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/latestver/templates/ingress.yaml b/charts/latestver/templates/ingress.yaml new file mode 100644 index 0000000..7358c4f --- /dev/null +++ b/charts/latestver/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "go-latestver.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 "go-latestver.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 }} diff --git a/charts/latestver/templates/service.yaml b/charts/latestver/templates/service.yaml new file mode 100644 index 0000000..9ad24b1 --- /dev/null +++ b/charts/latestver/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "go-latestver.fullname" . }} + labels: + {{- include "go-latestver.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "go-latestver.selectorLabels" . | nindent 4 }} diff --git a/charts/latestver/templates/serviceaccount.yaml b/charts/latestver/templates/serviceaccount.yaml new file mode 100644 index 0000000..4d4cc26 --- /dev/null +++ b/charts/latestver/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "go-latestver.serviceAccountName" . }} + labels: + {{- include "go-latestver.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/latestver/values.yaml b/charts/latestver/values.yaml new file mode 100644 index 0000000..4478f9c --- /dev/null +++ b/charts/latestver/values.yaml @@ -0,0 +1,110 @@ +# Default values for go-latestver. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: ghcr.io/luzifer/go-latestver + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +config: + catalog: [] + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: + capabilities: + drop: + - ALL + readOnlyRootFilesystem: true + runAsNonRoot: true + runAsUser: 1000 + +service: + type: ClusterIP + port: 3000 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} diff --git a/ci/patch-chart-version.sh b/ci/patch-chart-version.sh new file mode 100755 index 0000000..6db077b --- /dev/null +++ b/ci/patch-chart-version.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +set -euo pipefail + +chart_yaml=charts/latestver/Chart.yaml + +# Patch latest App-Version into Chart +yq -iP ".appVersion = \"$(git describe --tags --abbrev=0)\"" ${chart_yaml} + +# Validate there has been a change before patching the chart version +git diff --exit-code -- ${chart_yaml} >/dev/null && exit 0 || true + +# There were changes, we need to patch the chart version +chart_ver=$(yq '.version' ${chart_yaml}) +yq -iP ".version = \"$(semver -i minor ${chart_ver})\"" ${chart_yaml} + +git add ${chart_yaml}