From 1bdd6181baf18a3f3608298fc4a8287228357eb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20T=C3=B6lle?= Date: Fri, 8 May 2020 02:11:39 +0200 Subject: [PATCH] feat(cd): add Helm Chart with automated releases --- .github/workflows/release.yaml | 5 ++ .releaserc.yml | 23 +++++- charts/listory/.helmignore | 23 ++++++ charts/listory/Chart.yaml | 21 +++++ charts/listory/templates/NOTES.txt | 21 +++++ charts/listory/templates/_helpers.tpl | 63 +++++++++++++++ charts/listory/templates/deployment.yaml | 80 +++++++++++++++++++ charts/listory/templates/ingress.yaml | 37 +++++++++ .../templates/secrets-external-db.yaml | 11 +++ charts/listory/templates/secrets.yaml | 10 +++ charts/listory/templates/service.yaml | 15 ++++ charts/listory/templates/serviceaccount.yaml | 12 +++ charts/listory/values.yaml | 80 +++++++++++++++++++ 13 files changed, 399 insertions(+), 2 deletions(-) create mode 100644 charts/listory/.helmignore create mode 100644 charts/listory/Chart.yaml create mode 100644 charts/listory/templates/NOTES.txt create mode 100644 charts/listory/templates/_helpers.tpl create mode 100644 charts/listory/templates/deployment.yaml create mode 100644 charts/listory/templates/ingress.yaml create mode 100644 charts/listory/templates/secrets-external-db.yaml create mode 100644 charts/listory/templates/secrets.yaml create mode 100644 charts/listory/templates/service.yaml create mode 100644 charts/listory/templates/serviceaccount.yaml create mode 100644 charts/listory/values.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index accd96f..0294644 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -23,3 +23,8 @@ jobs: DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} run: semantic-release + + - name: Release Helm Chart + uses: helm/chart-releaser-action@v1.0.0-rc.2 + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.releaserc.yml b/.releaserc.yml index de0f432..38691b2 100644 --- a/.releaserc.yml +++ b/.releaserc.yml @@ -6,8 +6,27 @@ plugins: - - "@semantic-release/npm" - npmPublish: false - - "@semantic-release/exec" - - prepareCmd: "docker build -t apricote/listory --build-arg VERSION=${nextRelease.version} --build-arg GIT_COMMIT=`git rev-parse HEAD` ." + - prepareCmd: | + # Build Docker Container + docker build \ + -t apricote/listory \ + --build-arg VERSION=${nextRelease.version} \ + --build-arg GIT_COMMIT=`git rev-parse HEAD` \ + . + + # Update version in Helm Chart + CHART_FILE=charts/listory/Chart.yaml + + sed -i \ + -e "s/version: .*/version: ${nextRelease.version}/g" \ + -e "s/appVersion: .*/appVersion: ${nextRelease.version}/g" \ + $CHART_FILE - - semantic-release-docker - name: apricote/listory - - "@semantic-release/git" + - - "@semantic-release/git" + - assets: + - CHANGELOG.md + - package.json + - package-lock.json + - charts/listory/Chart.yaml - "@semantic-release/github" diff --git a/charts/listory/.helmignore b/charts/listory/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/listory/.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 +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/listory/Chart.yaml b/charts/listory/Chart.yaml new file mode 100644 index 0000000..84573aa --- /dev/null +++ b/charts/listory/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v2 +name: listory +description: Track your Spotify Listen History + +# 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. +version: 1.0.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. +appVersion: 1.0.1 diff --git a/charts/listory/templates/NOTES.txt b/charts/listory/templates/NOTES.txt new file mode 100644 index 0000000..5fba74a --- /dev/null +++ b/charts/listory/templates/NOTES.txt @@ -0,0 +1,21 @@ +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 }}{{ . }} + {{- 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 "listory.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 "listory.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "listory.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 "listory.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 --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/charts/listory/templates/_helpers.tpl b/charts/listory/templates/_helpers.tpl new file mode 100644 index 0000000..9a7f4e0 --- /dev/null +++ b/charts/listory/templates/_helpers.tpl @@ -0,0 +1,63 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "listory.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 "listory.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 "listory.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Common labels +*/}} +{{- define "listory.labels" -}} +helm.sh/chart: {{ include "listory.chart" . }} +{{ include "listory.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end -}} + +{{/* +Selector labels +*/}} +{{- define "listory.selectorLabels" -}} +app.kubernetes.io/name: {{ include "listory.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end -}} + +{{/* +Create the name of the service account to use +*/}} +{{- define "listory.serviceAccountName" -}} +{{- if .Values.serviceAccount.create -}} + {{ default (include "listory.fullname" .) .Values.serviceAccount.name }} +{{- else -}} + {{ default "default" .Values.serviceAccount.name }} +{{- end -}} +{{- end -}} diff --git a/charts/listory/templates/deployment.yaml b/charts/listory/templates/deployment.yaml new file mode 100644 index 0000000..d94df0e --- /dev/null +++ b/charts/listory/templates/deployment.yaml @@ -0,0 +1,80 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "listory.fullname" . }} + labels: + {{- include "listory.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "listory.selectorLabels" . | nindent 6 }} + template: + metadata: + labels: + {{- include "listory.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "listory.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + - name: DB_HOST + value: {{ .Values.externalDatabase.host }} + - name: DB_USERNAME + value: {{ .Values.externalDatabase.user }} + - name: DB_PASSWORD + valueFrom: + secretKeyRef: + name: {{ include "listory.fullname" . }}-external-db + key: postgres-password + - name: DB_DATABASE + value: {{ .Values.externalDatabase.database }} + - name: JWT_SECRET + valueFrom: + secretKeyRef: + name: {{ include "listory.fullname" . }} + key: jwt-secret + - name: APP_URL + value: https://{{ .Values.ingress.host }} + - name: SPOTIFY_CLIENT_ID + value: {{ .Values.spotify.clientId }} + - name: SPOTIFY_CLIENT_SECRET + valueFrom: + secretKeyRef: + name: {{ include "listory.fullname" . }} + key: spotify-client-secret + - name: SPOTIFY_USER_FILTER + value: {{ .Values.spotify.userFilter }} + + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + ports: + - name: http + containerPort: 3000 + protocol: TCP + readinessProbe: + httpGet: + path: /api/v1/health + 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 }} diff --git a/charts/listory/templates/ingress.yaml b/charts/listory/templates/ingress.yaml new file mode 100644 index 0000000..6b25cc8 --- /dev/null +++ b/charts/listory/templates/ingress.yaml @@ -0,0 +1,37 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "listory.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- 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 "listory.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: +{{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} +{{- end }} + rules: + - host: {{ .Values.ingress.host | quote }} + http: + paths: + - path: / + backend: + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} +{{- end }} diff --git a/charts/listory/templates/secrets-external-db.yaml b/charts/listory/templates/secrets-external-db.yaml new file mode 100644 index 0000000..c5a55d5 --- /dev/null +++ b/charts/listory/templates/secrets-external-db.yaml @@ -0,0 +1,11 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "listory.fullname" . }}-external-db + labels: + {{- include "listory.labels" . | nindent 4 }} +type: Opaque +data: + {{- if .Values.externalDatabase.password }} + postgres-password: {{ .Values.externalDatabase.password | b64enc | quote }} + {{- end }} diff --git a/charts/listory/templates/secrets.yaml b/charts/listory/templates/secrets.yaml new file mode 100644 index 0000000..2858c1f --- /dev/null +++ b/charts/listory/templates/secrets.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "listory.fullname" . }} + labels: + {{- include "listory.labels" . | nindent 4 }} +type: Opaque +data: + spotify-client-secret: {{ .Values.spotify.clientSecret | b64enc | quote }} + jwt-secret: {{ .Values.auth.jwtSecret | b64enc | quote }} diff --git a/charts/listory/templates/service.yaml b/charts/listory/templates/service.yaml new file mode 100644 index 0000000..1e50a93 --- /dev/null +++ b/charts/listory/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "listory.fullname" . }} + labels: + {{- include "listory.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "listory.selectorLabels" . | nindent 4 }} diff --git a/charts/listory/templates/serviceaccount.yaml b/charts/listory/templates/serviceaccount.yaml new file mode 100644 index 0000000..7adb5c1 --- /dev/null +++ b/charts/listory/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "listory.serviceAccountName" . }} + labels: + {{- include "listory.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end -}} diff --git a/charts/listory/values.yaml b/charts/listory/values.yaml new file mode 100644 index 0000000..b3b2d46 --- /dev/null +++ b/charts/listory/values.yaml @@ -0,0 +1,80 @@ +# Default values for listory. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: apricote/listory + pullPolicy: IfNotPresent + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +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: + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 3000 + +ingress: + enabled: false + host: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +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: {} + +externalDatabase: + host: + user: + password: + database: + +spotify: + clientId: + clientSecret: + userFilter: + +auth: + jwtSecret: \ No newline at end of file