From 9819265d4e3b2f5e9c7087c69826bf64bd545dae Mon Sep 17 00:00:00 2001 From: Ryan Holt Date: Mon, 23 Mar 2020 10:09:34 -0400 Subject: [PATCH] [grocy] Add Grocy (#185) * initial grocy build Signed-off-by: Ryan Holt * forgot the helper file Signed-off-by: Ryan Holt * remove comments Signed-off-by: Ryan Holt * change to port 80 Signed-off-by: Ryan Holt * add liveness probe Signed-off-by: Ryan Holt * helps if the probes are actually defined in values Signed-off-by: Ryan Holt * adding more time for readiness probe Signed-off-by: Ryan Holt * flip from readiness to liveness Signed-off-by: Ryan Holt * add startup probe, revert readiness/liveness to default Signed-off-by: Ryan Holt * remove readiness probe Signed-off-by: Ryan Holt * remove startupprobe, change default liveness and readiness to higher numbers Signed-off-by: Ryan Holt * trying the startupProbe again * fix indentations * that wasn't a fix * definitely not right * bump up default values * change from timeoutSeconds to periodSeconds * rename the value variable * add timeoutSeconds back in * update readme and chart owner Signed-off-by: Ryan Holt --- charts/grocy/.helmignore | 23 +++++ charts/grocy/Chart.yaml | 14 ++++ charts/grocy/OWNERS | 4 + charts/grocy/README.md | 98 ++++++++++++++++++++++ charts/grocy/templates/NOTES.txt | 19 +++++ charts/grocy/templates/_helpers.tpl | 32 +++++++ charts/grocy/templates/config-pvc.yaml | 29 +++++++ charts/grocy/templates/deployment.yaml | 95 +++++++++++++++++++++ charts/grocy/templates/ingress.yaml | 38 +++++++++ charts/grocy/templates/service.yaml | 53 ++++++++++++ charts/grocy/values.yaml | 112 +++++++++++++++++++++++++ 11 files changed, 517 insertions(+) create mode 100644 charts/grocy/.helmignore create mode 100644 charts/grocy/Chart.yaml create mode 100644 charts/grocy/OWNERS create mode 100644 charts/grocy/README.md create mode 100644 charts/grocy/templates/NOTES.txt create mode 100644 charts/grocy/templates/_helpers.tpl create mode 100644 charts/grocy/templates/config-pvc.yaml create mode 100644 charts/grocy/templates/deployment.yaml create mode 100644 charts/grocy/templates/ingress.yaml create mode 100644 charts/grocy/templates/service.yaml create mode 100644 charts/grocy/values.yaml diff --git a/charts/grocy/.helmignore b/charts/grocy/.helmignore new file mode 100644 index 00000000..46fd8996 --- /dev/null +++ b/charts/grocy/.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 +*~ +# Various IDEs +.project +.idea/ +*.tmproj +# OWNERS file for Kubernetes +OWNERS diff --git a/charts/grocy/Chart.yaml b/charts/grocy/Chart.yaml new file mode 100644 index 00000000..8604fd94 --- /dev/null +++ b/charts/grocy/Chart.yaml @@ -0,0 +1,14 @@ +apiVersion: v1 +appVersion: v2.6.1 +description: ERP beyond your fridge - grocy is a web-based self-hosted groceries & household management solution for your home +name: grocy +version: 1.0.0 +keywords: + - grocy +home: https://github.com/billimek/billimek-charts/tree/master/charts/grocy +icon: https://github.com/grocy/grocy/raw/master/public/img/appicons/mstile-150x150.png +sources: + - https://github.com/grocy/grocy +maintainers: + - name: carpenike + email: ryan@ryanholt.net diff --git a/charts/grocy/OWNERS b/charts/grocy/OWNERS new file mode 100644 index 00000000..51f88652 --- /dev/null +++ b/charts/grocy/OWNERS @@ -0,0 +1,4 @@ +approvers: +- billimek +reviewers: +- billimek \ No newline at end of file diff --git a/charts/grocy/README.md b/charts/grocy/README.md new file mode 100644 index 00000000..17b14fa6 --- /dev/null +++ b/charts/grocy/README.md @@ -0,0 +1,98 @@ +# Grocy + +This is a helm chart for [Grocy](https://grocy.info/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/grocy/) + +## TL;DR; + +```shell +$ helm repo add billimek https://billimek.com/billimek-charts/ +$ helm install billimek/grocy +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release billimek/grocy +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +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 | `{}` | + +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" \ + billimek/grocy +``` + +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 billimek/grocy +``` + +--- +**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`. + +--- + +Read through the [values.yaml](https://github.com/billimek/billimek-charts/blob/master/charts/grocy/values.yaml) file. It has several commented out suggested values. diff --git a/charts/grocy/templates/NOTES.txt b/charts/grocy/templates/NOTES.txt new file mode 100644 index 00000000..2472f1ea --- /dev/null +++ b/charts/grocy/templates/NOTES.txt @@ -0,0 +1,19 @@ +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 new file mode 100644 index 00000000..d9870d09 --- /dev/null +++ b/charts/grocy/templates/_helpers.tpl @@ -0,0 +1,32 @@ +{{/* 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/config-pvc.yaml b/charts/grocy/templates/config-pvc.yaml new file mode 100644 index 00000000..6713d5d0 --- /dev/null +++ b/charts/grocy/templates/config-pvc.yaml @@ -0,0 +1,29 @@ + +{{- 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 new file mode 100644 index 00000000..fc474113 --- /dev/null +++ b/charts/grocy/templates/deployment.yaml @@ -0,0 +1,95 @@ +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 new file mode 100644 index 00000000..470e565b --- /dev/null +++ b/charts/grocy/templates/ingress.yaml @@ -0,0 +1,38 @@ +{{- 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.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 new file mode 100644 index 00000000..01182f28 --- /dev/null +++ b/charts/grocy/templates/service.yaml @@ -0,0 +1,53 @@ +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 new file mode 100644 index 00000000..a933654d --- /dev/null +++ b/charts/grocy/values.yaml @@ -0,0 +1,112 @@ +# Default values for Ombi. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +image: + repository: linuxserver/grocy + tag: v2.6.1-ls51 + 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 + +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 + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + path: / + hosts: + - chart-example.local + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +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: {}