diff --git a/charts/grocy/.helmignore b/charts/grocy/.helmignore index 46fd8996..fcf9212f 100644 --- a/charts/grocy/.helmignore +++ b/charts/grocy/.helmignore @@ -19,5 +19,6 @@ .project .idea/ *.tmproj +.vscode # OWNERS file for Kubernetes OWNERS diff --git a/charts/grocy/Chart.yaml b/charts/grocy/Chart.yaml index 373624b1..025ddd74 100644 --- a/charts/grocy/Chart.yaml +++ b/charts/grocy/Chart.yaml @@ -1,8 +1,8 @@ apiVersion: v2 -appVersion: v2.6.1 +appVersion: v2.7.1 description: ERP beyond your fridge - grocy is a web-based self-hosted groceries & household management solution for your home name: grocy -version: 2.0.0 +version: 3.0.0 keywords: - grocy home: https://github.com/k8s-at-home/charts/tree/master/charts/grocy @@ -10,5 +10,9 @@ icon: https://github.com/grocy/grocy/raw/master/public/img/appicons/mstile-150x1 sources: - https://github.com/grocy/grocy maintainers: - - name: carpenike - email: ryan@ryanholt.net + - name: billimek + email: jeff@billimek.com +dependencies: + - name: common + version: 1.7.0 + repository: https://k8s-at-home.com/charts/ diff --git a/charts/grocy/OWNERS b/charts/grocy/OWNERS index 51f88652..1ce35762 100644 --- a/charts/grocy/OWNERS +++ b/charts/grocy/OWNERS @@ -1,4 +1,8 @@ approvers: - billimek +- onedr0p +- bjw-s reviewers: -- billimek \ No newline at end of file +- billimek +- onedr0p +- bjw-s diff --git a/charts/grocy/README.md b/charts/grocy/README.md index 1960776f..7e6cd752 100644 --- a/charts/grocy/README.md +++ b/charts/grocy/README.md @@ -1,6 +1,8 @@ -# Grocy +# grocy -This is a helm chart for [Grocy](https://grocy.info/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/grocy/) +This is a helm chart for [grocy](https://grocy.info/). + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** ## TL;DR; @@ -28,71 +30,40 @@ helm delete my-release --purge The command removes all the Kubernetes components associated with the chart and deletes the release. ## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `image.repository` | Image repository | `linuxserver/grocy` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/grocy/tags/).| `v2.6.1-ls51`| -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Timezone the grocy instance should run as, e.g. 'America/New_York' | `UTC` | -| `puid` | process userID the grocy instance should run as | `1000` | -| `pgid` | process groupID the grocy instance should run as | `1000` | -| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the deployment | `5` | -| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.liveness.periodSeconds` | Specify liveness `periodSeconds` parameter for the deployment | `10` | -| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the deployment | `5` | -| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.readiness.periodSeconds` | Specify readiness `periodSeconds` parameter for the deployment | `10` | -| `Service.type` | Kubernetes service type for the grocy GUI | `ClusterIP` | -| `Service.port` | Kubernetes port where the grocy GUI is exposed| `9283` | -| `Service.annotations` | Service annotations for the grocy GUI | `{}` | -| `Service.labels` | Custom labels | `{}` | -| `Service.loadBalancerIP` | Loadbalance IP for the grocy GUI | `{}` | -| `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.labels` | Custom labels | `{}` -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.config.enabled` | Use persistent volume to store configuration data | `true` | -| `persistence.config.size` | Size of persistent volume claim | `1Gi` | -| `persistence.config.existingClaim`| Use an existing PVC to persist data | `nil` | -| `persistence.config.subPath` | Mount a sub directory of the persistent volume if set | `""` | -| `persistence.config.storageClass` | Type of persistent volume claim | `-` | -| `persistence.config.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.config.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | -| `deploymentAnnotations` | Key-value pairs to add as deployment annotations | `{}` | +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/grocy/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - ```console -helm install --name my-release \ - --set timezone="America/New York" \ +helm install grocy \ + --set env.TZ="America/New_York" \ k8s-at-home/grocy ``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, ```console -helm install --name my-release -f values.yaml k8s-at-home/grocy +helm install grocy k8s-at-home/grocy --values values.yaml +``` + +```yaml +image: + tag: ... ``` --- **NOTE** -If you get `Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +If you get +```console +Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` +``` +it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. --- -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/grocy/values.yaml) file. It has several commented out suggested values. +## Upgrading an existing Release to a new major version + +A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. + +Refer to the library values.yaml for more configuration options. diff --git a/charts/grocy/ci/ct-values.yaml b/charts/grocy/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/grocy/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/grocy/templates/NOTES.txt b/charts/grocy/templates/NOTES.txt deleted file mode 100644 index 2472f1ea..00000000 --- a/charts/grocy/templates/NOTES.txt +++ /dev/null @@ -1,19 +0,0 @@ -1. Get the application URL by running these commands: -{{- if .Values.ingress.enabled }} -{{- range .Values.ingress.hosts }} - http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }} -{{- end }} -{{- else if contains "NodePort" .Values.service.type }} - export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "grocy.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 svc -w {{ include "grocy.fullname" . }}' - export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "grocy.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') - 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 "grocy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - echo "Visit http://127.0.0.1:3579 to use your application" - kubectl port-forward $POD_NAME 3579:80 -{{- end }} \ No newline at end of file diff --git a/charts/grocy/templates/_helpers.tpl b/charts/grocy/templates/_helpers.tpl deleted file mode 100644 index d9870d09..00000000 --- a/charts/grocy/templates/_helpers.tpl +++ /dev/null @@ -1,32 +0,0 @@ -{{/* vim: set filetype=mustache: */}} -{{/* -Expand the name of the chart. -*/}} -{{- define "grocy.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 "grocy.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 "grocy.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} -{{- end -}} diff --git a/charts/grocy/templates/common.yaml b/charts/grocy/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/grocy/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/grocy/templates/config-pvc.yaml b/charts/grocy/templates/config-pvc.yaml deleted file mode 100644 index 6713d5d0..00000000 --- a/charts/grocy/templates/config-pvc.yaml +++ /dev/null @@ -1,29 +0,0 @@ - -{{- if and .Values.persistence.config.enabled (not .Values.persistence.config.existingClaim) }} -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: {{ template "grocy.fullname" . }}-config - {{- if .Values.persistence.config.skipuninstall }} - annotations: - "helm.sh/resource-policy": keep - {{- end }} - labels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - helm.sh/chart: {{ include "grocy.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -spec: - accessModes: - - {{ .Values.persistence.config.accessMode | quote }} - resources: - requests: - storage: {{ .Values.persistence.config.size | quote }} -{{- if .Values.persistence.config.storageClass }} -{{- if (eq "-" .Values.persistence.config.storageClass) }} - storageClassName: "" -{{- else }} - storageClassName: "{{ .Values.persistence.config.storageClass }}" -{{- end }} -{{- end }} -{{- end -}} \ No newline at end of file diff --git a/charts/grocy/templates/deployment.yaml b/charts/grocy/templates/deployment.yaml deleted file mode 100644 index fc474113..00000000 --- a/charts/grocy/templates/deployment.yaml +++ /dev/null @@ -1,95 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: {{ include "grocy.fullname" . }} - {{- if .Values.deploymentAnnotations }} - annotations: - {{- range $key, $value := .Values.deploymentAnnotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - labels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - helm.sh/chart: {{ include "grocy.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -spec: - replicas: 1 - revisionHistoryLimit: 3 - strategy: - type: {{ .Values.strategyType }} - selector: - matchLabels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - template: - metadata: - labels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - {{- if .Values.podAnnotations }} - annotations: - {{- range $key, $value := .Values.podAnnotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - spec: - containers: - - name: {{ .Chart.Name }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" - imagePullPolicy: {{ .Values.image.pullPolicy }} - ports: - - name: http - containerPort: 80 - protocol: TCP - livenessProbe: - httpGet: - path: / - port: http - initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.liveness.failureThreshold }} - periodSeconds: {{ .Values.probes.liveness.periodSeconds }} - timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }} - readinessProbe: - httpGet: - path: / - port: http - initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.readiness.failureThreshold }} - periodSeconds: {{ .Values.probes.readiness.periodSeconds }} - timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }} - env: - - name: TZ - value: "{{ .Values.timezone }}" - - name: PUID - value: "{{ .Values.puid }}" - - name: PGID - value: "{{ .Values.pgid }}" - volumeMounts: - - mountPath: /config - name: config - {{- if .Values.persistence.config.subPath }} - subPath: "{{ .Values.persistence.config.subPath }}" - {{- end }} - resources: -{{ toYaml .Values.resources | indent 12 }} - volumes: - - name: config - {{- if .Values.persistence.config.enabled }} - persistentVolumeClaim: - claimName: {{ if .Values.persistence.config.existingClaim }}{{ .Values.persistence.config.existingClaim }}{{- else }}{{ template "grocy.fullname" . }}-config{{- end }} - {{- else }} - emptyDir: {} - {{ end }} - {{- with .Values.nodeSelector }} - nodeSelector: -{{ toYaml . | indent 8 }} - {{- end }} - {{- with .Values.affinity }} - affinity: -{{ toYaml . | indent 8 }} - {{- end }} - {{- with .Values.tolerations }} - tolerations: -{{ toYaml . | indent 8 }} - {{- end }} diff --git a/charts/grocy/templates/ingress.yaml b/charts/grocy/templates/ingress.yaml deleted file mode 100644 index c8d1355e..00000000 --- a/charts/grocy/templates/ingress.yaml +++ /dev/null @@ -1,41 +0,0 @@ -{{- if .Values.ingress.enabled -}} -{{- $fullName := include "grocy.fullname" . -}} -{{- $ingressPath := .Values.ingress.path -}} -apiVersion: extensions/v1beta1 -kind: Ingress -metadata: - name: {{ $fullName }} - labels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - helm.sh/chart: {{ include "grocy.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} - {{- with .Values.ingress.labels -}} - {{ toYaml . | nindent 4 }} - {{- end -}} -{{- with .Values.ingress.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if .Values.ingress.tls }} - tls: - {{- range .Values.ingress.tls }} - - hosts: - {{- range .hosts }} - - {{ . | quote }} - {{- end }} - secretName: {{ .secretName }} - {{- end }} -{{- end }} - rules: - {{- range .Values.ingress.hosts }} - - host: {{ . | quote }} - http: - paths: - - path: {{ $ingressPath }} - backend: - serviceName: {{ $fullName }} - servicePort: http - {{- end }} -{{- end }} diff --git a/charts/grocy/templates/service.yaml b/charts/grocy/templates/service.yaml deleted file mode 100644 index 01182f28..00000000 --- a/charts/grocy/templates/service.yaml +++ /dev/null @@ -1,53 +0,0 @@ -apiVersion: v1 -kind: Service -metadata: - name: {{ template "grocy.fullname" . }} - labels: - app.kubernetes.io/name: {{ include "grocy.name" . }} - helm.sh/chart: {{ include "grocy.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- if .Values.service.labels }} -{{ toYaml .Values.service.labels | indent 4 }} -{{- end }} -{{- with .Values.service.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if (or (eq .Values.service.type "ClusterIP") (empty .Values.service.type)) }} - type: ClusterIP - {{- if .Values.service.clusterIP }} - clusterIP: {{ .Values.service.clusterIP }} - {{end}} -{{- else if eq .Values.service.type "LoadBalancer" }} - type: {{ .Values.service.type }} - {{- if .Values.service.loadBalancerIP }} - loadBalancerIP: {{ .Values.service.loadBalancerIP }} - {{- end }} - {{- if .Values.service.loadBalancerSourceRanges }} - loadBalancerSourceRanges: -{{ toYaml .Values.service.loadBalancerSourceRanges | indent 4 }} - {{- end -}} -{{- else }} - type: {{ .Values.service.type }} -{{- end }} -{{- if .Values.service.externalIPs }} - externalIPs: -{{ toYaml .Values.service.externalIPs | indent 4 }} -{{- end }} - {{- if .Values.service.externalTrafficPolicy }} - externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }} - {{- end }} - ports: - - name: http - port: {{ .Values.service.port }} - protocol: TCP - targetPort: http -{{ if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }} - nodePort: {{.Values.service.nodePort}} -{{ end }} - selector: - app.kubernetes.io/name: {{ include "grocy.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - \ No newline at end of file diff --git a/charts/grocy/values.yaml b/charts/grocy/values.yaml index dfd93c67..be4c1306 100644 --- a/charts/grocy/values.yaml +++ b/charts/grocy/values.yaml @@ -1,113 +1,23 @@ -# Default values for Ombi. -# This is a YAML-formatted file. -# Declare variables to be passed into your templates. +# Default values for grocy. image: repository: linuxserver/grocy - tag: v2.6.1-ls51 + tag: version-v2.7.1 pullPolicy: IfNotPresent -# upgrade strategy type (e.g. Recreate or RollingUpdate) -strategyType: Recreate - -# Probes configuration -probes: - liveness: - initialDelaySeconds: 180 - failureThreshold: 10 - periodSeconds: 60 - timeoutSeconds: 10 - readiness: - initialDelaySeconds: 180 - failureThreshold: 10 - periodSeconds: 60 - timeoutSeconds: 10 - -nameOverride: "" -fullnameOverride: "" - -timezone: UTC -puid: 1000 -pgid: 1000 +strategy: + type: Recreate service: - type: ClusterIP - port: 80 - ## Specify the nodePort value for the LoadBalancer and NodePort service types. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - ## - # nodePort: - ## Provide any additional annotations which may be required. This can be used to - ## set the LoadBalancer service type to internal only. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer - ## - annotations: {} - labels: {} - ## Use loadBalancerIP to request a specific static IP, - ## otherwise leave blank - ## - loadBalancerIP: - # loadBalancerSourceRanges: [] - ## Set the externalTrafficPolicy in the Service to either Cluster or Local - # externalTrafficPolicy: Cluster + port: + port: 80 -ingress: - enabled: false - annotations: {} - # kubernetes.io/ingress.class: nginx - # kubernetes.io/tls-acme: "true" - values: {} - path: / - hosts: - - chart-example.local - tls: [] - # - secretName: chart-example-tls - # hosts: - # - chart-example.local +env: {} + # TZ: + # PUID: + # PGID: persistence: config: - enabled: true - ## Ombi configuration data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## - # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable - # existingClaim: your-claim - accessMode: ReadWriteOnce - size: 1Gi - - ## If subPath is set mount a sub folder of a volume instead of the root of the volume. - ## This is especially handy for volume plugins that don't natively support sub mounting (like glusterfs). - ## - subPath: "" - ## Do not delete the pvc upon helm uninstall - skipuninstall: false - -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 - -nodeSelector: {} - -tolerations: [] - -affinity: {} - -podAnnotations: {} - -deploymentAnnotations: {} + enabled: false + emptyDir: false diff --git a/charts/heimdall/.helmignore b/charts/heimdall/.helmignore new file mode 100644 index 00000000..fcf9212f --- /dev/null +++ b/charts/heimdall/.helmignore @@ -0,0 +1,24 @@ +# 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 +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/heimdall/Chart.yaml b/charts/heimdall/Chart.yaml index 1701cc33..4b156ed4 100644 --- a/charts/heimdall/Chart.yaml +++ b/charts/heimdall/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 2.2.2 description: An Application dashboard and launcher name: heimdall -version: 2.0.1 +version: 3.0.0 keywords: - heimdall home: https://github.com/k8s-at-home/charts/tree/master/charts/heimdall @@ -11,5 +11,9 @@ sources: - https://hub.docker.com/r/linuxserver/heimdall/ - https://github.com/linuxserver/heimdall maintainers: - - name: skaro13 - email: simon.caron@protonmail.com + - name: billimek + email: jeff@billimek.com +dependencies: + - name: common + version: 1.7.0 + repository: https://k8s-at-home.com/charts/ diff --git a/charts/heimdall/OWNERS b/charts/heimdall/OWNERS index 51f88652..1ce35762 100644 --- a/charts/heimdall/OWNERS +++ b/charts/heimdall/OWNERS @@ -1,4 +1,8 @@ approvers: - billimek +- onedr0p +- bjw-s reviewers: -- billimek \ No newline at end of file +- billimek +- onedr0p +- bjw-s diff --git a/charts/heimdall/README.md b/charts/heimdall/README.md index 8ad79f79..bd64ccc9 100644 --- a/charts/heimdall/README.md +++ b/charts/heimdall/README.md @@ -1,6 +1,8 @@ -# Heimdall Application Dashboard +# heimdall -This is a helm chart for [heimdall](https://github.com/heimdall/heimdall) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/heimdall/) +This is a helm chart for [heimdall](https://github.com/heimdall/heimdall). + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** ## TL;DR; @@ -14,7 +16,7 @@ $ helm install k8s-at-home/heimdall To install the chart with the release name `my-release`: ```console -helm install my-release k8s-at-home/heimdall +helm install --name my-release k8s-at-home/heimdall ``` ## Uninstalling the Chart @@ -22,75 +24,46 @@ helm install my-release k8s-at-home/heimdall To uninstall/delete the `my-release` deployment: ```console -helm delete my-release +helm delete my-release --purge ``` The command removes all the Kubernetes components associated with the chart and deletes the release. ## Configuration - -The following tables lists the configurable parameters of the Sentry chart and their default values. - -| Parameter | Description | Default | -|----------------------------|-------------------------------------|---------------------------------------------------------| -| `image.repository` | Image repository | `linuxserver/heimdall` | -| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/heimdall/tags/).| `2.2.2-ls84`| -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `strategyType` | Specifies the strategy used to replace old Pods by new ones | `Recreate` | -| `timezone` | Timezone the heimdall instance should run as, e.g. 'America/New_York' | `UTC` | -| `puid` | process userID the heimdall instance should run as | `1001` | -| `pgid` | process groupID the heimdall instance should run as | `1001` | -| `probes.liveness.initialDelaySeconds` | Specify liveness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.liveness.failureThreshold` | Specify liveness `failureThreshold` parameter for the deployment | `5` | -| `probes.liveness.timeoutSeconds` | Specify liveness `timeoutSeconds` parameter for the deployment | `10` | -| `probes.readiness.initialDelaySeconds` | Specify readiness `initialDelaySeconds` parameter for the deployment | `60` | -| `probes.readiness.failureThreshold` | Specify readiness `failureThreshold` parameter for the deployment | `5` | -| `probes.readiness.timeoutSeconds` | Specify readiness `timeoutSeconds` parameter for the deployment | `10` | -| `Service.type` | Kubernetes service type for the heimdall GUI | `ClusterIP` | -| `Service.port` | Kubernetes port where the heimdall GUI is exposed| `80` | -| `Service.annotations` | Service annotations for the heimdall GUI | `{}` | -| `Service.labels` | Custom labels | `{}` | -| `Service.loadBalancerIP` | Loadbalance IP for the heimdall GUI | `{}` | -| `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.annotations` | Ingress annotations | `{}` | -| `ingress.labels` | Custom labels | `{}` -| `ingress.path` | Ingress path | `/` | -| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `persistence.config.enabled` | Use persistent volume to store configuration data | `true` | -| `persistence.config.size` | Size of persistent volume claim | `1Gi` | -| `persistence.config.existingClaim`| Use an existing PVC to persist data | `nil` | -| `persistence.config.storageClass` | Type of persistent volume claim | `-` | -| `persistence.config.accessMode` | Persistence access mode | `ReadWriteOnce` | -| `persistence.config.skipuninstall` | Do not delete the pvc upon helm uninstall | `false` | -| `persistence.extraExistingClaimMounts` | Optionally add multiple existing claims | `[]` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Toleration labels for pod assignment | `[]` | -| `affinity` | Affinity settings for pod assignment | `{}` | -| `podAnnotations` | Key-value pairs to add as pod annotations | `{}` | -| `deploymentAnnotations` | Key-value pairs to add as deployment annotations | `{}` | +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/heimdall/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, - ```console -helm install my-release \ - --set timezone="America/New York" \ +helm install heimdall \ + --set env.TZ="America/New_York" \ k8s-at-home/heimdall ``` - -Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, - +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, ```console -helm install my-release -f values.yaml k8s-at-home/heimdall +helm install heimdall k8s-at-home/heimdall --values values.yaml +``` + +```yaml +image: + tag: ... ``` --- **NOTE** -If you get `Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. +If you get +```console +Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` +``` +it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. --- -Read through the [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/heimdall/values.yaml) file. It has several commented out suggested values. +## Upgrading an existing Release to a new major version + +A major chart version change (like 4.0.1 -> 5.0.0) indicates that there is an incompatible breaking change potentially needing manual actions. + +Refer to the library values.yaml for more configuration options. diff --git a/charts/heimdall/ci/ct-values.yaml b/charts/heimdall/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/heimdall/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/heimdall/templates/NOTES.txt b/charts/heimdall/templates/NOTES.txt deleted file mode 100644 index 5b0d05f0..00000000 --- a/charts/heimdall/templates/NOTES.txt +++ /dev/null @@ -1,19 +0,0 @@ -1. Get the application URL by running these commands: -{{- if .Values.ingress.enabled }} -{{- range .Values.ingress.hosts }} - http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }} -{{- end }} -{{- else if contains "NodePort" .Values.service.type }} - export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "heimdall.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 svc -w {{ include "heimdall.fullname" . }}' - export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "heimdall.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') - 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 "heimdall.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - echo "Visit http://127.0.0.1:8080 to use your application" - kubectl port-forward $POD_NAME 8080:80 -{{- end }} diff --git a/charts/heimdall/templates/_helpers.tpl b/charts/heimdall/templates/_helpers.tpl deleted file mode 100644 index 19cb63ef..00000000 --- a/charts/heimdall/templates/_helpers.tpl +++ /dev/null @@ -1,32 +0,0 @@ -{{/* vim: set filetype=mustache: */}} -{{/* -Expand the name of the chart. -*/}} -{{- define "heimdall.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 "heimdall.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 "heimdall.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} -{{- end -}} diff --git a/charts/heimdall/templates/common.yaml b/charts/heimdall/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/heimdall/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/heimdall/templates/config-pvc.yaml b/charts/heimdall/templates/config-pvc.yaml deleted file mode 100644 index cc45b8c1..00000000 --- a/charts/heimdall/templates/config-pvc.yaml +++ /dev/null @@ -1,29 +0,0 @@ - -{{- if and .Values.persistence.config.enabled (not .Values.persistence.config.existingClaim) }} -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: {{ template "heimdall.fullname" . }}-config - {{- if .Values.persistence.config.skipuninstall }} - annotations: - "helm.sh/resource-policy": keep - {{- end }} - labels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - helm.sh/chart: {{ include "heimdall.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -spec: - accessModes: - - {{ .Values.persistence.config.accessMode | quote }} - resources: - requests: - storage: {{ .Values.persistence.config.size | quote }} -{{- if .Values.persistence.config.storageClass }} -{{- if (eq "-" .Values.persistence.config.storageClass) }} - storageClassName: "" -{{- else }} - storageClassName: "{{ .Values.persistence.config.storageClass }}" -{{- end }} -{{- end }} -{{- end -}} \ No newline at end of file diff --git a/charts/heimdall/templates/deployment.yaml b/charts/heimdall/templates/deployment.yaml deleted file mode 100644 index 1cd2727b..00000000 --- a/charts/heimdall/templates/deployment.yaml +++ /dev/null @@ -1,98 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: {{ include "heimdall.fullname" . }} - {{- if .Values.deploymentAnnotations }} - annotations: - {{- range $key, $value := .Values.deploymentAnnotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - labels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - helm.sh/chart: {{ include "heimdall.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -spec: - replicas: 1 - revisionHistoryLimit: 3 - strategy: - type: {{ .Values.strategyType }} - selector: - matchLabels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - template: - metadata: - labels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - {{- if .Values.podAnnotations }} - annotations: - {{- range $key, $value := .Values.podAnnotations }} - {{ $key }}: {{ $value | quote }} - {{- end }} - {{- end }} - spec: - containers: - - name: {{ .Chart.Name }} - image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" - imagePullPolicy: {{ .Values.image.pullPolicy }} - ports: - - name: http - containerPort: 80 - protocol: TCP - livenessProbe: - tcpSocket: - port: http - initialDelaySeconds: {{ .Values.probes.liveness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.liveness.failureThreshold }} - timeoutSeconds: {{ .Values.probes.liveness.timeoutSeconds }} - readinessProbe: - tcpSocket: - port: http - initialDelaySeconds: {{ .Values.probes.readiness.initialDelaySeconds }} - failureThreshold: {{ .Values.probes.readiness.failureThreshold }} - timeoutSeconds: {{ .Values.probes.readiness.timeoutSeconds }} - env: - - name: TZ - value: "{{ .Values.timezone }}" - - name: PUID - value: "{{ .Values.puid }}" - - name: PGID - value: "{{ .Values.pgid }}" - volumeMounts: - - mountPath: /config - name: config - {{- range .Values.persistence.extraExistingClaimMounts }} - - name: {{ .name }} - mountPath: {{ .mountPath }} - readOnly: {{ .readOnly }} - {{- end }} - resources: -{{ toYaml .Values.resources | indent 12 }} - volumes: - - name: config - {{- if .Values.persistence.config.enabled }} - persistentVolumeClaim: - claimName: {{ if .Values.persistence.config.existingClaim }}{{ .Values.persistence.config.existingClaim }}{{- else }}{{ template "heimdall.fullname" . }}-config{{- end }} - {{- else }} - emptyDir: {} - {{- end }} - {{- range .Values.persistence.extraExistingClaimMounts }} - - name: {{ .name }} - persistentVolumeClaim: - claimName: {{ .existingClaim }} - {{- end }} - {{- with .Values.nodeSelector }} - nodeSelector: -{{ toYaml . | indent 8 }} - {{- end }} - {{- with .Values.affinity }} - affinity: -{{ toYaml . | indent 8 }} - {{- end }} - {{- with .Values.tolerations }} - tolerations: -{{ toYaml . | indent 8 }} - {{- end }} diff --git a/charts/heimdall/templates/ingress.yaml b/charts/heimdall/templates/ingress.yaml deleted file mode 100644 index e1ca2c9e..00000000 --- a/charts/heimdall/templates/ingress.yaml +++ /dev/null @@ -1,41 +0,0 @@ -{{- if .Values.ingress.enabled -}} -{{- $fullName := include "heimdall.fullname" . -}} -{{- $ingressPath := .Values.ingress.path -}} -apiVersion: extensions/v1beta1 -kind: Ingress -metadata: - name: {{ $fullName }} - labels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - helm.sh/chart: {{ include "heimdall.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} - {{- with .Values.ingress.labels -}} - {{ toYaml . | nindent 4 }} - {{- end -}} -{{- with .Values.ingress.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if .Values.ingress.tls }} - tls: - {{- range .Values.ingress.tls }} - - hosts: - {{- range .hosts }} - - {{ . | quote }} - {{- end }} - secretName: {{ .secretName }} - {{- end }} -{{- end }} - rules: - {{- range .Values.ingress.hosts }} - - host: {{ . | quote }} - http: - paths: - - path: {{ $ingressPath }} - backend: - serviceName: {{ $fullName }} - servicePort: http - {{- end }} -{{- end }} diff --git a/charts/heimdall/templates/service.yaml b/charts/heimdall/templates/service.yaml deleted file mode 100644 index 9504d7e7..00000000 --- a/charts/heimdall/templates/service.yaml +++ /dev/null @@ -1,52 +0,0 @@ -apiVersion: v1 -kind: Service -metadata: - name: {{ template "heimdall.fullname" . }} - labels: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - helm.sh/chart: {{ include "heimdall.chart" . }} - app.kubernetes.io/instance: {{ .Release.Name }} - app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- if .Values.service.labels }} -{{ toYaml .Values.service.labels | indent 4 }} -{{- end }} -{{- with .Values.service.annotations }} - annotations: -{{ toYaml . | indent 4 }} -{{- end }} -spec: -{{- if (or (eq .Values.service.type "ClusterIP") (empty .Values.service.type)) }} - type: ClusterIP - {{- if .Values.service.clusterIP }} - clusterIP: {{ .Values.service.clusterIP }} - {{end}} -{{- else if eq .Values.service.type "LoadBalancer" }} - type: {{ .Values.service.type }} - {{- if .Values.service.loadBalancerIP }} - loadBalancerIP: {{ .Values.service.loadBalancerIP }} - {{- end }} - {{- if .Values.service.loadBalancerSourceRanges }} - loadBalancerSourceRanges: -{{ toYaml .Values.service.loadBalancerSourceRanges | indent 4 }} - {{- end -}} -{{- else }} - type: {{ .Values.service.type }} -{{- end }} -{{- if .Values.service.externalIPs }} - externalIPs: -{{ toYaml .Values.service.externalIPs | indent 4 }} -{{- end }} - {{- if .Values.service.externalTrafficPolicy }} - externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }} - {{- end }} - ports: - - name: http - port: {{ .Values.service.port }} - protocol: TCP - targetPort: http -{{ if (and (eq .Values.service.type "NodePort") (not (empty .Values.service.nodePort))) }} - nodePort: {{.Values.service.nodePort}} -{{ end }} - selector: - app.kubernetes.io/name: {{ include "heimdall.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} \ No newline at end of file diff --git a/charts/heimdall/values.yaml b/charts/heimdall/values.yaml index 480edca2..a40e5f71 100644 --- a/charts/heimdall/values.yaml +++ b/charts/heimdall/values.yaml @@ -1,106 +1,27 @@ -# Default values for heimdall. -# This is a YAML-formatted file. -# Declare variables to be passed into your templates. +# Default values for grocy. image: repository: linuxserver/heimdall - tag: 2.2.2-ls98 + tag: version-2.2.2 pullPolicy: IfNotPresent -# upgrade strategy type (e.g. Recreate or RollingUpdate) -strategyType: Recreate - -# Probes configuration -probes: - liveness: - initialDelaySeconds: 60 - failureThreshold: 5 - timeoutSeconds: 10 - readiness: - initialDelaySeconds: 60 - failureThreshold: 5 - timeoutSeconds: 10 - -nameOverride: "" -fullnameOverride: "" - -timezone: UTC -puid: 1001 -pgid: 1001 +strategy: + type: Recreate service: - type: ClusterIP - port: 80 - ## Specify the nodePort value for the LoadBalancer and NodePort service types. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - ## - # nodePort: - ## Provide any additional annotations which may be required. This can be used to - ## set the LoadBalancer service type to internal only. - ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer - ## - annotations: {} - labels: {} - ## Use loadBalancerIP to request a specific static IP, - ## otherwise leave blank - ## - loadBalancerIP: - # loadBalancerSourceRanges: [] - ## Set the externalTrafficPolicy in the Service to either Cluster or Local - # externalTrafficPolicy: Cluster + port: + port: 80 -ingress: - enabled: false - annotations: {} - # kubernetes.io/ingress.class: nginx - # kubernetes.io/tls-acme: "true" - labels: {} - path: / - hosts: - - chart-example.local - tls: [] - # - secretName: chart-example-tls - # hosts: - # - chart-example.local +env: {} + # TZ: + # PUID: + # PGID: persistence: config: + enabled: false + emptyDir: false + +probes: + startup: enabled: true - ## heimdall configuration data Persistent Volume Storage Class - ## If defined, storageClassName: - ## If set to "-", storageClassName: "", which disables dynamic provisioning - ## If undefined (the default) or set to null, no storageClassName spec is - ## set, choosing the default provisioner. (gp2 on AWS, standard on - ## GKE, AWS & OpenStack) - ## - # storageClass: "-" - ## - ## If you want to reuse an existing claim, you can pass the name of the PVC using - ## the existingClaim variable - # existingClaim: your-claim - accessMode: ReadWriteOnce - size: 1Gi - ## Do not delete the pvc upon helm uninstall - skipuninstall: false - -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 - -nodeSelector: {} - -tolerations: [] - -affinity: {} - -podAnnotations: {} - -deploymentAnnotations: {}