changed token variable

Reviewed-on: #9

.frigate

@@ -0,0 +1,19 @@
+{% extends "markdown.jinja2" %}
+
+
+
+{% block title -%}
+# {{ name | upper }}
+
+
+to use, add this to your Charts.yaml
+```
+dependencies:
+  - name: lib
+    repository: oci://repo.rre.nu/helm
+    version: <chart version>
+```
+
+
+
+{%- endblock %}

.gitea/workflows/buildPush.yaml

@@ -0,0 +1,43 @@
+name: Package and publish helm chart
+
+on:
+  push:
+    # Pattern matched against refs/tags
+    tags:
+      - '**'           # Push events to every tag including hierarchical tags like v1.0/beta
+jobs:
+  package-helm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        name: Check out code
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v4.2.0
+        with:
+          version: v3.14.4
+
+      - name: Get package name
+        id: chart_name
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq .name Chart.yaml
+
+      - name: Get package version
+        id: chart_version
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq .version Chart.yaml
+
+      - name: build helm package
+        shell: bash
+        env:
+          PACKAGE_TOKEN: ${{ secrets.PACKAGE_TOKEN }}
+          CHART_NAME: ${{ steps.chart_name.outputs.result }}
+          CHART_VERSION: ${{ steps.chart_version.outputs.result }}
+        run: |
+          REPO_PATH=$(git rev-parse --show-toplevel)
+          mkdir /tmp/build
+          cd /tmp/build
+          helm package $REPO_PATH
+          curl -H "Authorization: token $PACKAGE_TOKEN" -X POST --upload-file ${CHART_NAME}-${CHART_VERSION}.tgz https://git.rre.nu/api/packages/jonas/helm/api/charts

.gitea/workflows/lint.yaml

@@ -19,7 +19,7 @@ jobs:
         with:
           version: v3.14.4
 
-      - name: List all changed files
+      - name: Lint the helm package
         env:
           ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |

.gitignore

@@ -5,6 +5,7 @@ bin/*
 .project
 /.bin
 /_test/secrets/*.json
+*.tgz
 
 # OSX leaves these everywhere on SMB shares
 ._*

.helmignore

@@ -21,3 +21,4 @@
 .idea/
 *.tmproj
 .vscode/
+*.tgz

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+    exclude: ^README.md$
+  - id: check-yaml
+  - id: check-added-large-files
+- repo: https://github.com/rapidsai/frigate/
+  rev: v0.4.0
+  hooks:
+     - id: frigate
+       args:
+       - --output=README.rst
+       - --format=rst
+       - --no-credits
+       - --no-deps

CHANGES.md

@@ -0,0 +1,6 @@
+# next
+- added env.TZ to default to Europe/Stockholm
+- added deployment type
+
+# v1.0.0
+- first version

Chart.yaml

@@ -3,7 +3,7 @@ apiVersion: v2
 name: lib
 description: Common functions for my helm charts at home
 type: library
-version: 1.0.0
+version: 1.0.3
 kubeVersion: ">=1.27.0"
 home: git.rre.nu
 sources:

Makefile

@@ -1,5 +1,10 @@
 NEW_VERSION:=$(shell yq '.version |= (split(".") | .[-1] |= ((. tag = "!!int") + 1) | join("."))' Chart.yaml | yq '.version')
 
+
+pre-commit:
+	pip install pre-commit
+	pre-commit install
+
 branch:
 	@echo "New chart version is: $(NEW_VERSION)"
 	git checkout -b lib_$(NEW_VERSION)

README.md

@@ -0,0 +1,68 @@
+
+# LIB
+
+
+to use, add this to your Charts.yaml
+```
+dependencies:
+  - name: lib
+    repository: oci://repo.rre.nu/helm
+    version: <chart version>
+```
+Common functions for my helm charts at home
+
+
+## Configuration
+
+The following table lists the configurable parameters of the Lib chart and their default values.
+
+| Parameter                | Description             | Default        |
+| ------------------------ | ----------------------- | -------------- |
+| `namespace` | namespace to install to | `"default"` |
+| `controller.enabled` | should the main workload be included or not | `true` |
+| `controller.type` | valid options are deployment, statefulset, job | `"deployment"` |
+| `controller.replicas` | number of replicas | `1` |
+| `controller.lifecycle` | Define postStart and preStop handlers | `{}` |
+| `controller.command` | override the containers entrypoint | `null` |
+| `controller.args` | add argument to the override command | `[]` |
+| `image.repository` | container image name | `null` |
+| `image.pullPolicy` | kubernetes pull policy | `"IfNotPresent"` |
+| `image.tag` | Overrides the image tag whose default is the chart appVersion. | `""` |
+| `fullnameOverride` | override the name of the helm release | `""` |
+| `service.main.enabled` |  | `false` |
+| `service.main.type` |  | `"ClusterIP"` |
+| `service.main.annotations` |  | `{}` |
+| `service.main.labels` |  | `{}` |
+| `service.main.ports` |  | `null` |
+| `ingress.enabled` |  | `false` |
+| `ingress.service` | what service should the ingress target | `"main"` |
+| `ingress.servicePort` |  | `80` |
+| `ingress.className` |  | `""` |
+| `ingress.annotations` |  | `{}` |
+| `ingress.hosts` |  | `[{"host": "chart-example.local", "paths": [{"path": "/", "pathType": "ImplementationSpecific"}]}]` |
+| `ingress.tls` |  | `[]` |
+| `resources` |  | `{}` |
+| `autoscaling.enabled` |  | `false` |
+| `autoscaling.minReplicas` |  | `1` |
+| `autoscaling.maxReplicas` |  | `5` |
+| `autoscaling.targetCPUUtilizationPercentage` |  | `80` |
+| `secrets` | Secrets that needs to be created | `{}` |
+| `configs` | ConfigMaps that needs to be created | `{}` |
+| `envFrom` | mount environment variables from secrets or configMaps | `[]` |
+| `env.TZ` |  | `"Europe/Stockholm"` |
+| `volumes` |  | `[]` |
+| `volumeMounts` |  | `[]` |
+| `volumeClaimTemplates` | used for statefulset https://kubernetes.io/docs/concepts/workloads/controllers/statefulset | `[]` |
+| `serviceAccount.create` |  | `true` |
+| `serviceAccount.automount` |  | `true` |
+| `serviceAccount.annotations` |  | `{}` |
+| `serviceAccount.name` |  | `""` |
+| `livenessProbe` |  | `{}` |
+| `readinessProbe` |  | `{}` |
+| `nodeSelector` |  | `{}` |
+| `tolerations` |  | `[]` |
+| `affinity` |  | `{}` |
+
+
+
+

templates/_all.tpl

@@ -14,9 +14,9 @@ Main entrypoint for the common library chart. It will render all underlying temp
   {{ include "lib.configs" . | nindent 0 }}
   {{ if .Values.controller.enabled }}
     {{ if eq .Values.controller.type "statefulset" }}
-      {{- include "lib.statefulset" . | nindent 0}}
+      {{- include "lib.statefulset" . | nindent 0 }}
+    {{ else if eq .Values.controller.type "deployment" }}
+      {{- include "lib.deployment" . | nindent 0 }}
     {{- end -}}
   {{- end -}}
 {{- end -}}
-
-

templates/_configmaps.tpl

@@ -1,6 +1,6 @@
 {{- define "lib.configs" -}}
 {{- $fullName := include "lib.fullname" . -}}
-{{- $namespace := .Values.namespace -}}
+{{- $namespace := .Values.namespace | default "default" -}}
 {{- $commonLabels := include "lib.labels" . }}
 {{- range $name, $values := .Values.configs }}
 {{- if $values.enabled -}}
@@ -25,4 +25,4 @@ data:
 {{- end }}
 {{- end }}
 {{- end -}}
-{{- end -}}
+{{- end -}}

templates/_deployment.tpl

@@ -0,0 +1,54 @@
+{{- define "lib.deployment" -}}
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "lib.fullname" . }}
+  namespace: {{ .Values.namespace }}
+  labels:
+    {{- include "lib.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "lib.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "lib.labels" . | nindent 8 }}
+        {{- with .Values.controller.labels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "lib.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        {{- include "lib.parts.container" . | nindent 8 -}}
+      {{- 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 }}
+{{- end }}

templates/_helpers.tpl

@@ -61,8 +61,8 @@ Create the name of the service account to use
 {{- end }}
 {{- end }}
 
-{{/* 
+{{/*
-Merge the local chart values and the library chart defaults 
+Merge the local chart values and the library chart defaults
 */}}
 {{- define "lib.values.setup" -}}
   {{- if .Values.lib -}}
@@ -72,54 +72,3 @@ Merge the local chart values and the library chart defaults
     {{- $_ := set . "Values" (deepCopy $mergedValues) -}}
   {{- end -}}
 {{- end -}}
-
-{{/* 
-Get all environment variables and
-secrets that should be mounted as environment variables
-*/}}
-{{- define "lib.environmentVariables" -}}
-{{- $envIncluded := "false" -}}
-{{- $fullName := include "lib.fullname" . -}}
-{{- range $name, $settings := .Values.secrets -}}
-{{- if $settings.enabled -}}
-{{- if $settings.env -}}
-{{- $envIncluded := "true" -}}
-{{- range $key, $value := $settings.data }}
-- name: {{ $key }}
-  valueFrom:
-    secretKeyRef:
-      name: {{ $fullName }}-{{ $name }}
-      key: {{ $key }}
-{{- end -}}
-{{- range $key, $value := $settings.stringData }}
-- name: {{ $key }}
-  valueFrom:
-    secretKeyRef:
-      name: {{ $fullName }}-{{ $name }}
-      key: {{ $key }}
-{{- end -}}
-{{- end -}}
-{{- end -}}
-{{- end -}}
-{{- range $name, $settings := .Values.configs -}}
-{{- if $settings.enabled -}}
-{{- if $settings.env -}}
-{{- $envIncluded := "true" -}}
-{{- range $key, $value := $settings.data }}
-- name: {{ $key }}
-  valueFrom:
-    configMapKeyRef:
-      name: {{ $fullName }}-{{ $name }}
-      key: {{ $key }}
-{{- end -}}
-{{- end -}}
-{{- end -}}
-{{- end -}}
-{{- if $envIncluded = "true" -}}
-  {{- if .Values.env -}}
-    {{- toYaml .Values.env | nindent 0 -}}
-  {{- end -}}
-{{- else -}}
-  {{- toYaml .Values.env | nindent 0 -}}
-{{- end -}}
-{{- end -}}

templates/_ingress.tpl

@@ -7,6 +7,7 @@
   {{- $_ := 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 -}}
@@ -20,8 +21,7 @@ metadata:
   namespace: {{ .Values.namespace }}
   labels:
     {{- include "lib.labels" . | nindent 4 }}
-  {{- with .Values.ingressingresstservicePort }}
+  {{- with .Values.ingress.annotations }}
-  {{- $svcName := .Values.ingress.service -}}
   annotations:
     {{- toYaml . | nindent 4 }}
   {{- end }}
@@ -52,7 +52,7 @@ spec:
             backend:
               {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
               service:
-                name: {{ $fullName }}-${{ $svcName }}
+                name: {{ $fullName }}-{{ $svcName }}
                 port:
                   number: {{ $svcPort }}
               {{- else }}

templates/_secrets.tpl

@@ -1,6 +1,6 @@
 {{- define "lib.secrets" -}}
 {{- $fullName := include "lib.fullname" . -}}
-{{- $namespace := .Values.namespace -}}
+{{- $namespace := .Values.namespace | default "default" -}}
 {{- $commonLabels := include "lib.labels" . }}
 {{- range $name, $values := .Values.secrets }}
 {{- if $values.enabled -}}
@@ -30,4 +30,4 @@ stringData:
 {{- end }}
 {{- end }}
 {{- end -}}
-{{- end -}}
+{{- end -}}

templates/_service.tpl

@@ -14,16 +14,16 @@ metadata:
   labels:
     {{- $labels | nindent 4 }}
 spec:
-  type: {{ $values.type }}
+  type: {{ default "ClusterIP" $values.type }}
   ports:
   {{- range $k, $v := $values.ports }}
     - port: {{ $v.port }}
-      targetPort: {{ default $v.targetPort $v.port }}
+      targetPort: {{ default $v.port $v.targetPort }}
-      protocol: {{ $v.protocol }}
+      protocol: {{ default "TCP" $v.protocol }}
       name: {{ $k }}
   {{- end }}
   selector:
     {{- $selectorlabels | nindent 4 }}
 {{- end -}}
 {{- end -}}
-{{- end -}}
+{{- end -}}

templates/_serviceaccount.tpl

@@ -12,4 +12,4 @@ metadata:
     {{- toYaml . | nindent 4 }}
   {{- end }}
 automountServiceAccountToken: {{ .Values.serviceAccount.automount }}
-{{- end }}  
+{{- end }}

templates/_statefulset.tpl

@@ -35,34 +35,7 @@ spec:
       securityContext:
         {{- toYaml .Values.controller.podSecurityContext | nindent 8 }}
       containers:
-        - name: {{ .Chart.Name }}
+        {{- include "lib.parts.container" . | nindent 8 -}}
-          securityContext:
-            {{- toYaml .Values.controller.securityContext | nindent 12 }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
-          imagePullPolicy: {{ .Values.image.pullPolicy }}
-          ports:
-          {{- range $name, $values := .Values.service -}}
-          {{- if $values.enabled -}}
-          {{- range $k, $v := $values.ports }}
-            - name: {{ $k }}
-              containerPort: {{ $v.targetPort | default $v.port }}
-              protocol: {{ $v.protocol }}
-          {{- end -}}
-          {{- end -}}
-          {{- end }}
-          env:
-            {{- include "lib.environmentVariables" . | default "[]" | nindent 12 }}
-          livenessProbe:
-            {{- toYaml .Values.livenessProbe | nindent 12 }}
-          readinessProbe:
-            {{- toYaml .Values.readinessProbe | nindent 12 }}
-          resources:
-            {{- toYaml .Values.resources | nindent 12 }}
-          volumeMounts:
-            {{- range $i, $values := .Values.volumeClaimTemplates }}
-            - name: {{ $values.name }}
-              mountPath: {{ $values.mountPath }}
-            {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}

templates/parts/_containers.tpl

@@ -0,0 +1,53 @@
+{{- define "lib.parts.container" -}}
+{{/*
+create the environment varable list
+*/}}
+- name: {{ .Chart.Name }}
+  securityContext:
+    {{- toYaml .Values.securityContext | nindent 4 }}
+  image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+  imagePullPolicy: {{ .Values.image.pullPolicy }}
+  {{- with .Values.controller.command }}
+  command: {{ toYaml . | nindent 4}}
+  {{- end }}
+  {{- with .Values.controller.args }}
+  args: {{ toYaml . | nindent 4 }}
+  {{- end }}
+  {{- with .Values.controller.lifecycle }}
+  lifecycle:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  ports:
+  {{- range $name, $values := .Values.service -}}
+  {{- if $values.enabled -}}
+  {{- range $k, $v := $values.ports }}
+    - name: {{ $k }}
+      containerPort: {{ default $v.port $v.targetPort }}
+  {{- end -}}
+  {{- end -}}
+  {{- end }}
+  env:
+    {{- include "lib.parts.env" . | nindent 4 -}}
+  {{- with .Values.livenessProbe }}
+  livenessProbe:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  {{- with .Values.readinessProbe }}
+  readinessProbe:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  {{- with .Values.resources }}
+  resources:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  {{- if or .Values.volumeMounts .Values.volumeClaimTemplates }}
+  volumeMounts:
+  {{- end }}
+  {{- with .Values.volumeMounts }}
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+  {{- range $v := .Values.volumeClaimTemplates }}
+    - name: {{ $v.name }}
+      mountPath: {{ $v.mountPath }}
+  {{- end }}
+{{- end }}

templates/parts/_env.tpl

@@ -0,0 +1,26 @@
+{{/*
+Get all environment variables configMaps and
+secrets that should be mounted as environment variables
+*/}}
+{{- define "lib.parts.env" -}}
+  {{/*
+  environment variables from .Values.env
+  */}}
+  {{- range $name, $value := .Values.env -}}
+    {{- printf "- name: %s" $name | nindent 0 }}
+    {{- printf "value: %s" $value | nindent 2 }}
+  {{- end -}}
+  {{/*
+  environment variables from configMaps
+  */}}
+  {{- range $cfgName, $settings := .Values.configs -}}
+    {{- if and $settings.enabled $settings.env -}}
+      {{- range $key, $value := $settings.data -}}
+        {{- printf "- name: %s" $key | nindent 0 }}
+        {{- printf "valueFrom:" | nindent 2 }}
+        {{- printf "configMapKeyRef:" | nindent 4 }}
+        {{- printf "name: %s" $key | nindent 5 }}
+      {{- end }}
+    {{- end }}
+  {{- end -}}
+{{- end -}}

values.yaml

@@ -1,24 +1,23 @@
 ---
-namespace: default
+namespace: default # namespace to install to
-controller:
+controller: # main workload
-  # -- enable the controller
+  enabled: true # should the main workload be included or not
-  enabled: true
+  type: deployment # valid options are deployment, statefulset, job
-  # type of controller
+  replicas: 1 # number of replicas
-  # valid options are deployment, statefulset, job
+  lifecycle: {} # Define postStart and preStop handlers
-  type: deployment
+  command: # override the containers entrypoint
-  replicas: 1
+  args: [] # add argument to the override command
 
 image:
-  repository:
+  repository:  # container image name
-  pullPolicy:
+  pullPolicy: IfNotPresent # kubernetes pull policy
-  # Overrides the image tag whose default is the chart appVersion.
+  tag: "" # Overrides the image tag whose default is the chart appVersion.
-  tag: ""
 
-fullnameOverride: ""
+fullnameOverride: ""  # override the name of the helm release
 
-service:
+service: # services that should be created
   main:
-    enabled: true
+    enabled: false
     type: ClusterIP
     annotations: {}
     labels: {}
@@ -46,7 +45,7 @@ service:
 
 ingress:
   enabled: false
-  service: main
+  service: main # what service should the ingress target
   #Service to target
   servicePort: 80
   className: ""
@@ -64,8 +63,7 @@ ingress:
   #    hosts:
   #      - chart-example.local
 
-resources:
+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
@@ -84,28 +82,32 @@ autoscaling:
   targetCPUUtilizationPercentage: 80
   # targetMemoryUtilizationPercentage: 80
 
-# Secrets that needs to be created
+secrets: {} # Secrets that needs to be created
-secrets: {}
 # secrets:
-#   <name>: 
+#   <name>:
 #     type:     #default Opaque
 #     annotations: {}
 #     labels: {}
-#     env: false #should template load each key in the seacret as 
 #     data:
 #        KEY: VALUE
 
-# ConfigMaps that needs to be created
+configs: {} # ConfigMaps that needs to be created
-configs: {}
 # configs:
-#   <name>: 
+#   <name>:
+#     enabled: false # should the configMap be created or not
 #     annotations: {}
 #     labels: {}
-#     env: false #should template load each key in the seacret as 
 #     data:
 #        KEY: VALUE
 
-env: {}
+envFrom: [] # mount environment variables from secrets or configMaps
+# - configMapRef:
+#     name: config-map-name
+# - secretRef:
+#     name: secret-name
+
+env:  # environment variables the controller should have
+  TZ: Europe/Stockholm
 
 # Additional volumes on the output Deployment definition.
 volumes: []
@@ -120,8 +122,7 @@ volumeMounts: []
 #   mountPath: "/etc/foo"
 #   readOnly: true
 
-# used for statefulset https://kubernetes.io/docs/concepts/workloads/controllers/statefulset
+volumeClaimTemplates: [] # used for statefulset https://kubernetes.io/docs/concepts/workloads/controllers/statefulset
-volumeClaimTemplates: []
 #volumeClaimTemplates:
 #  - name: www
 #    mountPath: /var/www/html