Create Helm Chart (#43)

* chore: initial commit of helm chart yaml

* chore: add docs and reset ingress classname default

* chore: helm repo add and install documentation

* chore: add env variables to deployment and values

* fix: remove port env variable
This commit is contained in:
Nathan Lanier 2022-10-18 13:59:34 -05:00 committed by GitHub
parent 28ddbb1f6c
commit 31531b607d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 594 additions and 0 deletions

23
chart/.helmignore Normal file
View file

@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/

24
chart/Chart.yaml Normal file
View file

@ -0,0 +1,24 @@
apiVersion: v2
name: christmas-community
description: A Helm chart for Kubernetes
# A chart can be either an 'application' or a 'library' chart.
#
# Application charts are a collection of templates that can be packaged into versioned archives
# to be deployed.
#
# Library charts provide useful utilities or functions for the chart developer. They're included as
# a dependency of application charts to inject those utilities and functions into the rendering
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.1.1
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "1.30.0"

66
chart/README.md Normal file
View file

@ -0,0 +1,66 @@
# christmas-community
![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.30.0](https://img.shields.io/badge/AppVersion-1.30.0-informational?style=flat-square)
A Helm chart for Kubernetes
## Install
```
helm repo add <helm repo name> <helm repo url>
helm install christmas-community <helm repo>/christmas-community
```
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| env.BULMASWATCH | string | `"default"` | `Any theme from https://jenil.github.io/bulmaswatch` |
| env.DB_EXPOSE_PORT | string | `""` | `Expose the internal PouchDB with CouchDB API and Fauxton browser. Mostly used for debugging. Leave empty to disable.` |
| env.DB_PREFIX | string | `"dbs/"` | `Where to store databases, can be a CouchDB compatible server or directory.` |
| env.DEFAULT_FAILURE_REDIRECT | string | `"/login"` | `Where to send someone if they need to log in` |
| env.LANGUAGE | string | `"en-US"` | `Language of the interface, options listed in languages directory` |
| env.LISTS_PUBLIC | bool | `false` | `Set to false to allow viewing wishlists without logging in` |
| env.MARKDOWN | bool | `false` | `Allow Markdown in item notes. Does not work with TABLE=false.` |
| env.PFP | bool | `true` | `Set to false to disable the profile pictures feature` |
| env.PROXY_SERVER | string | `""` | `Proxy to send item data requests to. Leave empty to disable.` |
| env.ROOT_PATH | string | `"/"` | `The root path for forms, CSS, and a small amount of JS. Useful when proxying` |
| env.SECRET | string | `""` | `Secret string to store session cookies with. Automatically generated if not provided.` |
| env.SESSION_MAX_AGE | int | `604800000` | `How long a user is logged in (milliseconds). Defaults to one week.` |
| env.SHORT_TITLE | string | `"Christmas"` | `Used when shared to home screen` |
| env.SINGLE_LIST | bool | `false` | `Set to true to not allow users to have their own lists. You may want this for a birthday or wedding.` |
| env.SITE_TITLE | string | `"Christmas Community"` | `The name of the site in the <title> and navigation bar` |
| env.SMILE | bool | `true` | `Convert Amazon links to Amazon Smile links. A percentage of the profit goes to a charity of buyer's choice.` |
| env.TABLE | bool | `true` | `Defaults to true. Set to false for legacy cards view.` |
| env.TRUST_PROXY | string | `"loopback"` | `Where to trust the X-Forwarded-For header from. Defaults to "loopback". Useful for proxying to docker.` |
| env.UPDATE_CHECK | bool | `true` | `Set to false to disable update notices` |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"wingysam/christmas-community"` | |
| image.tag | string | `"1.30.0"` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"Prefix"` | |
| ingress.tls | list | `[]` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| persistence.enabled | bool | `false` | |
| persistence.mountPath | string | `"/data"` | |
| podAnnotations | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `1` | |
| securityContext | object | `{}` | |
| service.port | int | `80` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

22
chart/templates/NOTES.txt Normal file
View file

@ -0,0 +1,22 @@
1. Get the application URL by running these commands:
{{- if .Values.ingress.enabled }}
{{- range $host := .Values.ingress.hosts }}
{{- range .paths }}
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
{{- end }}
{{- end }}
{{- else if contains "NodePort" .Values.service.type }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "christmas-community.fullname" . }})
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
echo http://$NODE_IP:$NODE_PORT
{{- else if contains "LoadBalancer" .Values.service.type }}
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "christmas-community.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "christmas-community.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
echo http://$SERVICE_IP:{{ .Values.service.port }}
{{- else if contains "ClusterIP" .Values.service.type }}
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "christmas-community.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
{{- end }}

View file

@ -0,0 +1,62 @@
{{/*
Expand the name of the chart.
*/}}
{{- define "christmas-community.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 "christmas-community.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 "christmas-community.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}
{{/*
Common labels
*/}}
{{- define "christmas-community.labels" -}}
helm.sh/chart: {{ include "christmas-community.chart" . }}
{{ include "christmas-community.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}
{{/*
Selector labels
*/}}
{{- define "christmas-community.selectorLabels" -}}
app.kubernetes.io/name: {{ include "christmas-community.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}
{{/*
Create the name of the service account to use
*/}}
{{- define "christmas-community.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "christmas-community.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}

View file

@ -0,0 +1,148 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ include "christmas-community.fullname" . }}
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
spec:
selector:
matchLabels:
{{- include "christmas-community.selectorLabels" . | nindent 6 }}
template:
metadata:
{{- with .Values.podAnnotations }}
annotations:
{{- toYaml . | nindent 8 }}
{{- end }}
labels:
{{- include "christmas-community.selectorLabels" . | nindent 8 }}
spec:
{{- with .Values.imagePullSecrets }}
imagePullSecrets:
{{- toYaml . | nindent 8 }}
{{- end }}
serviceAccountName: {{ include "christmas-community.serviceAccountName" . }}
securityContext:
{{- toYaml .Values.podSecurityContext | nindent 8 }}
volumes:
- name: {{ include "christmas-community.fullname" . }}-pv
persistentVolumeClaim:
claimName: {{ include "christmas-community.fullname" . }}-pvc
containers:
- name: {{ .Chart.Name }}
securityContext:
{{- toYaml .Values.securityContext | nindent 12 }}
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
volumeMounts:
- name: {{ include "christmas-community.fullname" . }}-pv
mountPath: {{- toYaml .Values.persistence.mountPath | indent 8}}
{{- if .Values.env}}
env:
{{- if .Values.env.DB_PREFIX }}
- name: DB_PREFIX
value: {{ .Values.env.DB_PREFIX }}
{{- end}}
{{- if .Values.env.DEFAULT_FAILURE_REDIRECT }}
- name: DEFAULT_FAILURE_REDIRECT
value: {{ .Values.env.DEFAULT_FAILURE_REDIRECT }}
{{- end}}
{{- if .Values.env.DB_EXPOSE_PORT }}
- name: DB_EXPOSE_PORT
value: {{ .Values.env.DB_EXPOSE_PORT }}
{{- end}}
{{- if .Values.env.PROXY_SERVER }}
- name: PROXY_SERVER
value: {{ .Values.env.PROXY_SERVER }}
{{- end}}
{{- if .Values.env.SECRET }}
- name: SECRET
value: {{ .Values.env.SECRET }}
{{- end}}
{{- if .Values.env.SESSION_MAX_AGE }}
- name: SESSION_MAX_AGE
value: {{ .Values.env.SESSION_MAX_AGE }}
{{- end}}
{{- if .Values.env.SITE_TITLE }}
- name: SITE_TITLE
value: {{ .Values.env.SITE_TITLE }}
{{- end}}
{{- if .Values.env.SHORT_TITLE }}
- name: SHORT_TITLE
value: {{ .Values.env.SHORT_TITLE }}
{{- end}}
{{- if .Values.env.ROOT_PATH }}
- name: ROOT_PATH
value: {{ .Values.env.ROOT_PATH }}
{{- end}}
{{- if .Values.env.TRUST_PROXY }}
- name: TRUST_PROXY
value: {{ .Values.env.TRUST_PROXY }}
{{- end}}
{{- if .Values.env.BULMASWATCH }}
- name: BULMASWATCH
value: {{ .Values.env.BULMASWATCH }}
{{- end}}
{{- if .Values.env.DB_PREFIX }}
- name: DB_PREFIX
value: {{ .Values.env.DB_PREFIX }}
{{- end}}
{{- if .Values.env.UPDATE_CHECK }}
- name: UPDATE_CHECK
value: {{ .Values.env.UPDATE_CHECK }}
{{- end}}
{{- if .Values.env.PFP }}
- name: PFP
value: {{ .Values.env.PFP }}
{{- end}}
{{- if .Values.env.LANGUAGE }}
- name: LANGUAGE
value: {{ .Values.env.LANGUAGE }}
{{- end}}
{{- if .Values.env.SINGLE_LIST }}
- name: SINGLE_LIST
value: {{ .Values.env.SINGLE_LIST }}
{{- end}}
{{- if .Values.env.LISTS_PUBLIC }}
- name: LISTS_PUBLIC
value: {{ .Values.env.LISTS_PUBLIC }}
{{- end}}
{{- if .Values.env.TABLE }}
- name: TABLE
value: {{ .Values.env.TABLE }}
{{- end}}
{{- if .Values.env.SMILE }}
- name: SMILE
value: {{ .Values.env.SMILE }}
{{- end}}
{{- if .Values.env.MARKDOWN }}
- name: MARKDOWN
value: {{ .Values.env.MARKDOWN }}
{{- end }}
{{- end }}
ports:
- name: http
containerPort: 80
protocol: TCP
livenessProbe:
httpGet:
path: /
port: http
readinessProbe:
httpGet:
path: /
port: http
resources:
{{- toYaml .Values.resources | nindent 12 }}
{{- with .Values.nodeSelector }}
nodeSelector:
{{- toYaml . | nindent 8 }}
{{- end }}
{{- with .Values.affinity }}
affinity:
{{- toYaml . | nindent 8 }}
{{- end }}
{{- with .Values.tolerations }}
tolerations:
{{- toYaml . | nindent 8 }}
{{- end }}

View file

@ -0,0 +1,61 @@
{{- if .Values.ingress.enabled -}}
{{- $fullName := include "christmas-community.fullname" . -}}
{{- $svcPort := .Values.service.port -}}
{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
{{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
{{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
{{- end }}
{{- end }}
{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
apiVersion: networking.k8s.io/v1
{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
apiVersion: networking.k8s.io/v1beta1
{{- else -}}
apiVersion: extensions/v1beta1
{{- end }}
kind: Ingress
metadata:
name: {{ $fullName }}
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
{{- with .Values.ingress.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
ingressClassName: {{ .Values.ingress.className }}
{{- end }}
{{- if .Values.ingress.tls }}
tls:
{{- range .Values.ingress.tls }}
- hosts:
{{- range .hosts }}
- {{ . | quote }}
{{- end }}
secretName: {{ .secretName }}
{{- end }}
{{- end }}
rules:
{{- range .Values.ingress.hosts }}
- host: {{ .host | quote }}
http:
paths:
{{- range .paths }}
- path: {{ .path }}
{{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
pathType: {{ .pathType }}
{{- end }}
backend:
{{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
service:
name: {{ $fullName }}
port:
number: {{ $svcPort }}
{{- else }}
serviceName: {{ $fullName }}
servicePort: {{ $svcPort }}
{{- end }}
{{- end }}
{{- end }}
{{- end }}

18
chart/templates/pv.yaml Normal file
View file

@ -0,0 +1,18 @@
{{- if .Values.persistence.enabled -}}
apiVersion: v1
kind: PersistentVolume
metadata:
name: {{ include "christmas-community.fullname" . }}-pv
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
spec:
storageClassName: local-path
persistentVolumeReclaimPolicy: Delete
capacity:
storage: 2Gi
accessModes:
- ReadWriteOnce
hostPath:
path: {{- toYaml .Values.persistence.mountPath | indent 8}}
volumeMode: Filesystem
{{- end }}

17
chart/templates/pvc.yaml Normal file
View file

@ -0,0 +1,17 @@
{{- if .Values.persistence.enabled -}}
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: {{ include "christmas-community.fullname" . }}-pvc
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 2Gi
storageClassName: local-path
volumeMode: Filesystem
volumeName: {{ include "christmas-community.fullname" . }}-pv
{{- end }}

View file

@ -0,0 +1,15 @@
apiVersion: v1
kind: Service
metadata:
name: {{ include "christmas-community.fullname" . }}
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
spec:
type: {{ .Values.service.type }}
ports:
- port: {{ .Values.service.port }}
targetPort: http
protocol: TCP
name: http
selector:
{{- include "christmas-community.selectorLabels" . | nindent 4 }}

View file

@ -0,0 +1,12 @@
{{- if .Values.serviceAccount.create -}}
apiVersion: v1
kind: ServiceAccount
metadata:
name: {{ include "christmas-community.serviceAccountName" . }}
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
{{- with .Values.serviceAccount.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
{{- end }}

View file

@ -0,0 +1,15 @@
apiVersion: v1
kind: Pod
metadata:
name: "{{ include "christmas-community.fullname" . }}-test-connection"
labels:
{{- include "christmas-community.labels" . | nindent 4 }}
annotations:
"helm.sh/hook": test
spec:
containers:
- name: wget
image: busybox
command: ['wget']
args: ['{{ include "christmas-community.fullname" . }}:{{ .Values.service.port }}']
restartPolicy: Never

111
chart/values.yaml Normal file
View file

@ -0,0 +1,111 @@
# Default values for christmas-community.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
replicaCount: 1
image:
repository: wingysam/christmas-community
pullPolicy: IfNotPresent
# Overrides the image tag whose default is the chart appVersion.
tag: "1.30.0"
imagePullSecrets: []
nameOverride: ""
fullnameOverride: ""
#Container ENV variables
env: []
# ## Core Settings
# # Where to store databases, can be a CouchDB compatible server or directory.
# DB_PREFIX: "dbs/"
# # Where to send someone if they need to log in
# DEFAULT_FAILURE_REDIRECT: "/login"
# # Expose the internal PouchDB with CouchDB API and Fauxton browser. Mostly used for debugging. Leave empty to disable.
# DB_EXPOSE_PORT: ""
# # Proxy to send item data requests to. Leave empty to disable.
# PROXY_SERVER: ""
# # Secret string to store session cookies with. Automatically generated if not provided.
# SECRET: ""
# # How long a user is logged in (milliseconds). Defaults to one week.
# SESSION_MAX_AGE: 604800000
# # The name of the site in the <title> and navigation bar
# SITE_TITLE: "Christmas Community"
# # Used when shared to home screen
# SHORT_TITLE: "Christmas"
# # The root path for forms, CSS, and a small amount of JS. Useful when proxying.
# ROOT_PATH: "/"
# # Where to trust the X-Forwarded-For header from. Defaults to "loopback". Useful for proxying to docker.
# TRUST_PROXY: "loopback"
# # Any theme from https://jenil.github.io/bulmaswatch
# BULMASWATCH: "default"
# # Set to false to disable update notices
# UPDATE_CHECK: true
# # Set to false to disable the profile pictures feature
# PFP: true
# # Language of the interface, options listed in `languages` directory
# LANGUAGE: "en-US"
# ## Wishlist Settings
# # Set to true to not allow users to have their own lists. You may want this for a birthday or wedding.
# SINGLE_LIST: false
# # Set to false to allow viewing wishlists without logging in
# LISTS_PUBLIC: false
# # Defaults to true. Set to false for legacy cards view.
# TABLE: true
# # Convert Amazon links to Amazon Smile links. A percentage of the profit goes to a charity of buyer's choice. Defaults to true.
# SMILE: true
# # Allow Markdown in item notes. Does not work with TABLE=false. Defaults to false.
# MARKDOWN: false
serviceAccount:
# Specifies whether a service account should be created
create: true
# Annotations to add to the service account
annotations: {}
# The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: ""
podAnnotations: {}
podSecurityContext: {}
# fsGroup: 2000
securityContext: {}
# capabilities:
# drop:
# - ALL
# readOnlyRootFilesystem: true
# runAsNonRoot: true
# runAsUser: 1000
persistence:
enabled: false
mountPath: /data
service:
type: ClusterIP
port: 80
ingress:
enabled: false
className: ""
annotations: {}
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
hosts:
- host: chart-example.local
paths:
- path: /
pathType: Prefix
tls: []
# - secretName: chart-example-tls
# hosts:
# - chart-example.local
nodeSelector: {}
tolerations: []
affinity: {}