[homer] Migrate to common v3 (#1007)

Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>

charts/stable/homer/Chart.yaml

@@ -1,10 +1,10 @@
 apiVersion: v2
-appVersion: 20.09.1
+appVersion: 21.03.2
 description: A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.
 icon: https://raw.githubusercontent.com/bastienwirtz/homer/main/public/logo.png
 home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/homer
 name: homer
-version: 4.4.0
+version: 5.0.0
 kubeVersion: ">=1.16.0-0"
 sources:
 - https://github.com/bastienwirtz/homer
@@ -14,4 +14,4 @@ maintainers:
 dependencies:
 - name: common
   repository: https://library-charts.k8s-at-home.com
-  version: 2.5.0
+  version: 3.1.0

charts/stable/homer/README.md

@@ -1,6 +1,6 @@
 # homer
 
-![Version: 4.4.0](https://img.shields.io/badge/Version-4.4.0-informational?style=flat-square) ![AppVersion: 20.09.1](https://img.shields.io/badge/AppVersion-20.09.1-informational?style=flat-square)
+![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square) ![AppVersion: 21.03.2](https://img.shields.io/badge/AppVersion-21.03.2-informational?style=flat-square)
 
 A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.
 
@@ -18,7 +18,7 @@ Kubernetes: `>=1.16.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| https://library-charts.k8s-at-home.com | common | 2.5.0 |
+| https://library-charts.k8s-at-home.com | common | 3.1.0 |
 
 ## TL;DR
 
@@ -75,18 +75,18 @@ N/A
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| configmap.config | string | `"externalConfig: https://raw.githubusercontent.com/bastienwirtz/homer/main/public/assets/config.yml.dist\n"` | Homer configuration https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md |
+| configmap.config | string | See values.yaml | Homer configuration. See [image documentation](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md) for more information. |
 | configmap.enabled | bool | `false` | Store homer configuration as a ConfigMap |
-| env | object | `{}` |  |
+| env | object | See below | environment variables. |
-| image.pullPolicy | string | `"IfNotPresent"` |  |
+| env.GID | string | `"911"` | Specify the group ID the application will run as |
-| image.repository | string | `"b4bz/homer"` |  |
+| env.TZ | string | `"UTC"` | Set the container timezone |
-| image.tag | string | `"20.09.1"` |  |
+| env.UID | string | `"911"` | Specify the user ID the application will run as |
-| ingress.enabled | bool | `false` |  |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
-| persistence.config.emptyDir.enabled | bool | `false` |  |
+| image.repository | string | `"b4bz/homer"` | image repository |
-| persistence.config.enabled | bool | `false` |  |
+| image.tag | string | `"21.03.2"` | image tag |
-| persistence.config.mountPath | string | `"/www/assets"` |  |
+| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
-| service.port.port | int | `8080` |  |
+| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
-| strategy.type | string | `"Recreate"` |  |
+| service | object | See values.yaml | Configures service settings for the chart. |
 
 ## Changelog
 
@@ -94,6 +94,14 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [5.0.0]
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.1.0. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored).
+  Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.1.0/charts/stable/common/) for the up-to-date values.
+- Change image tag to `21.03.2`.
+
 ### [3.2.0]
 
 #### Added

charts/stable/homer/README_CHANGELOG.md.gotmpl

@@ -9,6 +9,14 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [5.0.0]
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.1.0. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored).
+  Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.1.0/charts/stable/common/) for the up-to-date values.
+- Change image tag to `21.03.2`.
+
 ### [3.2.0]
 
 #### Added

charts/stable/homer/templates/_helpers.tpl

@@ -1,32 +0,0 @@
-{{/* vim: set filetype=mustache: */}}
-{{/*
-Expand the name of the chart.
-*/}}
-{{- define "homer.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 "homer.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 "homer.chart" -}}
-{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
-{{- end -}}

charts/stable/homer/templates/common.yaml

@@ -12,30 +12,18 @@ configmap/checksum: {{ include (print $.Template.BasePath "/configmap.yaml") . |
 {{- $_ := set .Values "podAnnotations" (deepCopy $podAnnotations) -}}
 {{- end -}}
 
-{{/* Append the configMap to the additionalVolumes */}}
+{{/* Append the configMap volume to the volumes */}}
-{{- define "homer.configmap.volume" -}}
+{{- define "homer.configVolume" -}}
-name: config
+enabled: "true"
-configMap:
+mountPath: "/www/assets/config.yml"
-  name: {{ template "common.names.fullname" . }}-config
+subPath: "config.yml"
+type: "custom"
+volumeSpec:
+  configMap:
+    name: {{ include "common.names.fullname" . }}-config
 {{- end -}}
-
 {{- if .Values.configmap.enabled -}}
-{{- $volume := include "homer.configmap.volume" . | fromYaml -}}
+{{- $_ := set .Values.persistence "config" (include "homer.configVolume" . | fromYaml) -}}
-{{- $additionalVolumes := append .Values.additionalVolumes $volume }}
-{{- $_ := set .Values "additionalVolumes" (deepCopy $additionalVolumes) -}}
-{{- end -}}
-
-{{/* Append the configMap volume to the additionalVolumeMounts */}}
-{{- define "homer.configmap.volumeMount" -}}
-name: config
-mountPath: /www/assets/config.yml
-subPath: config.yml
-{{- end -}}
-
-{{- if .Values.configmap.enabled -}}
-{{- $volumeMount := include "homer.configmap.volumeMount" . | fromYaml -}}
-{{- $additionalVolumeMounts := append .Values.additionalVolumeMounts $volumeMount }}
-{{- $_ := set .Values "additionalVolumeMounts" (deepCopy $additionalVolumeMounts) -}}
 {{- end -}}
 
 {{/* Render the templates */}}

charts/stable/homer/templates/configmap.yaml

@@ -2,13 +2,9 @@
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: {{ template "homer.fullname" . }}-config
+  name: {{ include "common.names.fullname" . }}-config
-  namespace: {{ .Release.Namespace }}
   labels:
-    app.kubernetes.io/name: {{ include "homer.name" . }}
+    {{- include "common.labels" . | nindent 4 }}
-    helm.sh/chart: {{ include "homer.chart" . }}
-    app.kubernetes.io/instance: {{ .Release.Name }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
 data:
   config.yml: |
 {{ .Values.configmap.config | indent 4 }}

charts/stable/homer/values.yaml

@@ -6,36 +6,48 @@
 #
 
 image:
+  # -- image repository
   repository: b4bz/homer
-  tag: 20.09.1
+  # -- image tag
+  tag: 21.03.2
+  # -- image pull policy
   pullPolicy: IfNotPresent
 
-strategy:
+# -- environment variables.
-  type: Recreate
+# @default -- See below
-
+env:
-env: {}
+  # -- Set the container timezone
-  # UID:
+  TZ: UTC
-  # GID:
+  # -- Specify the user ID the application will run as
+  UID: "911"
+  # -- Specify the group ID the application will run as
+  GID: "911"
 
+# -- Configures service settings for the chart.
+# @default -- See values.yaml
 service:
-  port:
+  main:
+    ports:
+      http:
         port: 8080
 
 ingress:
+  # -- Enable and configure ingress settings for the chart under this key.
+  # @default -- See values.yaml
+  main:
     enabled: false
 
+# -- Configure persistence settings for the chart under this key.
+# @default -- See values.yaml
 persistence:
   config:
     enabled: false
-    emptyDir:
-      enabled: false
     mountPath: /www/assets
 
-
 configmap:
   # -- Store homer configuration as a ConfigMap
   enabled: false
-  # -- Homer configuration
+  # -- Homer configuration. See [image documentation](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md) for more information.
-  # https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md
+  # @default -- See values.yaml
   config: |
     externalConfig: https://raw.githubusercontent.com/bastienwirtz/homer/main/public/assets/config.yml.dist