From 5c3e4f49a3101e778a26a0f1954112587aa1ef87 Mon Sep 17 00:00:00 2001 From: Felix Delattre Date: Mon, 28 Oct 2024 16:35:51 +0100 Subject: [PATCH] Added general polder deployment with its dependencies. --- .github/workflows/check_charts.yaml | 4 +- deployment/helm/.gitignore | 37 ++++++++++ deployment/helm/polder/.helmignore | 23 +++++++ deployment/helm/polder/Chart.lock | 9 +++ deployment/helm/polder/Chart.yaml | 24 +++++++ deployment/helm/polder/templates/NOTES.txt | 22 ++++++ deployment/helm/polder/templates/_helpers.tpl | 62 +++++++++++++++++ .../helm/polder/templates/deployment.yaml | 68 +++++++++++++++++++ deployment/helm/polder/templates/hpa.yaml | 32 +++++++++ deployment/helm/polder/templates/ingress.yaml | 43 ++++++++++++ deployment/helm/polder/templates/service.yaml | 15 ++++ .../helm/polder/templates/serviceaccount.yaml | 13 ++++ .../templates/tests/test-connection.yaml | 15 ++++ deployment/helm/polder/values.yaml | 36 ++++++++++ 14 files changed, 401 insertions(+), 2 deletions(-) create mode 100644 deployment/helm/.gitignore create mode 100644 deployment/helm/polder/.helmignore create mode 100644 deployment/helm/polder/Chart.lock create mode 100644 deployment/helm/polder/Chart.yaml create mode 100644 deployment/helm/polder/templates/NOTES.txt create mode 100644 deployment/helm/polder/templates/_helpers.tpl create mode 100644 deployment/helm/polder/templates/deployment.yaml create mode 100644 deployment/helm/polder/templates/hpa.yaml create mode 100644 deployment/helm/polder/templates/ingress.yaml create mode 100644 deployment/helm/polder/templates/service.yaml create mode 100644 deployment/helm/polder/templates/serviceaccount.yaml create mode 100644 deployment/helm/polder/templates/tests/test-connection.yaml create mode 100644 deployment/helm/polder/values.yaml diff --git a/.github/workflows/check_charts.yaml b/.github/workflows/check_charts.yaml index 3e22595..bf222f0 100644 --- a/.github/workflows/check_charts.yaml +++ b/.github/workflows/check_charts.yaml @@ -25,7 +25,7 @@ jobs: - name: Check Version run: | current_version=$(grep '^version=' pyproject.toml | cut -f2 -d= | tr -d ' ' | tr -d '"') - app_version=$(grep 'appVersion:' deployment/helm/Chart.yaml | cut -f2 -d: | tr -d ' ' | tr -d '"') + app_version=$(grep 'appVersion:' deployment/helm/polder/Chart.yaml | cut -f2 -d: | tr -d ' ' | tr -d '"') if [[ "$current_version" != "$app_version" ]]; then echo "❌ current version from pyproject.toml ($current_version) and appVersion from Chart.yaml ($app_version) differs"; exit 1; @@ -74,4 +74,4 @@ jobs: - name: Run chart-testing (install) run: ct install --chart-dirs deployment/k8s - if: steps.list-changed.outputs.changed == 'true' \ No newline at end of file + if: steps.list-changed.outputs.changed == 'true' diff --git a/deployment/helm/.gitignore b/deployment/helm/.gitignore new file mode 100644 index 0000000..92a43e0 --- /dev/null +++ b/deployment/helm/.gitignore @@ -0,0 +1,37 @@ +# General files for the project +pkg/* +*.pyc +bin/* +.project +/.bin +/_test/secrets/*.json + +# OSX leaves these everywhere on SMB shares +._* + +# OSX trash +.DS_Store + +# Files generated by JetBrains IDEs, e.g. IntelliJ IDEA +.idea/ +*.iml + +# Vscode files +.vscode + +# Emacs save files +*~ +\#*\# +.\#* + +# Vim-related files +[._]*.s[a-w][a-z] +[._]s[a-w][a-z] +*.un~ +Session.vim +.netrwhist + +# Chart dependencies +**/charts/*.tgz + +.history diff --git a/deployment/helm/polder/.helmignore b/deployment/helm/polder/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/deployment/helm/polder/.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/deployment/helm/polder/Chart.lock b/deployment/helm/polder/Chart.lock new file mode 100644 index 0000000..9790b1a --- /dev/null +++ b/deployment/helm/polder/Chart.lock @@ -0,0 +1,9 @@ +dependencies: +- name: eoapi + repository: https://devseed.com/eoapi-k8s/ + version: 0.4.17 +- name: webapp-polder + repository: file://../webapp-polder + version: 0.1.0 +digest: sha256:42a9ad509dc7c456f1d479cff6085182c439b28d02a50497dc5de373b8d89247 +generated: "2024-10-28T17:29:59.493228222+01:00" diff --git a/deployment/helm/polder/Chart.yaml b/deployment/helm/polder/Chart.yaml new file mode 100644 index 0000000..a92ee56 --- /dev/null +++ b/deployment/helm/polder/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: polder +description: Create a polder - Web AOI viewer - instance. + +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.0 + +# 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: "0.2.0" + +dependencies: + - name: eoapi + version: 0.4.17 + repository: "https://devseed.com/eoapi-k8s/" + - name: webapp-polder + version: 0.1.0 + repository: file://../webapp-polder diff --git a/deployment/helm/polder/templates/NOTES.txt b/deployment/helm/polder/templates/NOTES.txt new file mode 100644 index 0000000..4b1679a --- /dev/null +++ b/deployment/helm/polder/templates/NOTES.txt @@ -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 "polder.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 its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "polder.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "polder.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 "polder.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 }} diff --git a/deployment/helm/polder/templates/_helpers.tpl b/deployment/helm/polder/templates/_helpers.tpl new file mode 100644 index 0000000..5d3ecd7 --- /dev/null +++ b/deployment/helm/polder/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "polder.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 "polder.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 "polder.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "polder.labels" -}} +helm.sh/chart: {{ include "polder.chart" . }} +{{ include "polder.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "polder.selectorLabels" -}} +app.kubernetes.io/name: {{ include "polder.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "polder.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "polder.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/deployment/helm/polder/templates/deployment.yaml b/deployment/helm/polder/templates/deployment.yaml new file mode 100644 index 0000000..ee6ad0b --- /dev/null +++ b/deployment/helm/polder/templates/deployment.yaml @@ -0,0 +1,68 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "polder.fullname" . }} + labels: + {{- include "polder.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "polder.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "polder.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "polder.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + - name: {{ include "polder.fullname" . }}-config + mountPath: /usr/share/nginx/html/app_config.js + subPath: app_config.js + volumes: + - name: {{ include "polder.fullname" . }}-config + configMap: + name: {{ include "polder.fullname" . }}-configmap + {{- 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/deployment/helm/polder/templates/hpa.yaml b/deployment/helm/polder/templates/hpa.yaml new file mode 100644 index 0000000..d044055 --- /dev/null +++ b/deployment/helm/polder/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "polder.fullname" . }} + labels: + {{- include "polder.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "polder.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/deployment/helm/polder/templates/ingress.yaml b/deployment/helm/polder/templates/ingress.yaml new file mode 100644 index 0000000..a505530 --- /dev/null +++ b/deployment/helm/polder/templates/ingress.yaml @@ -0,0 +1,43 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "polder.fullname" . }} + labels: + {{- include "polder.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- 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 }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "polder.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/deployment/helm/polder/templates/service.yaml b/deployment/helm/polder/templates/service.yaml new file mode 100644 index 0000000..0b26545 --- /dev/null +++ b/deployment/helm/polder/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "polder.fullname" . }} + labels: + {{- include "polder.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "polder.selectorLabels" . | nindent 4 }} diff --git a/deployment/helm/polder/templates/serviceaccount.yaml b/deployment/helm/polder/templates/serviceaccount.yaml new file mode 100644 index 0000000..6079057 --- /dev/null +++ b/deployment/helm/polder/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "polder.serviceAccountName" . }} + labels: + {{- include "polder.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/deployment/helm/polder/templates/tests/test-connection.yaml b/deployment/helm/polder/templates/tests/test-connection.yaml new file mode 100644 index 0000000..4a26c22 --- /dev/null +++ b/deployment/helm/polder/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "polder.fullname" . }}-test-connection" + labels: + {{- include "polder.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "polder.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/deployment/helm/polder/values.yaml b/deployment/helm/polder/values.yaml new file mode 100644 index 0000000..1ccd8f9 --- /dev/null +++ b/deployment/helm/polder/values.yaml @@ -0,0 +1,36 @@ +# Default values for polder. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This is to override the chart name. +nameOverride: "polder" +fullnameOverride: "test-polder" + +# polder custom configuration +mapboxToken: "pk.eyJ0IjoiZGV2c2VlZCIsImEiOiJnUi1mbkVvIn0.018aLhX0Mb0tdtaT2QNe2Q" +stacApi: "https://rx2hna9pbg.execute-api.eu-central-1.amazonaws.com" +tilerApi: "https://zbrrek2x0i.execute-api.eu-central-1.amazonaws.com" + + +# replicaCount: 1 + +# image: +# repository: nginx +# pullPolicy: IfNotPresent +# tag: "1.27.2" + +# service: +# enabled: true +# name: polder-webapp +# type: NodePort +# ports: +# - port: 8081 +# targetPort: 80 +# nodePort: 30001 +# selector: +# app: polder-webapp + +# resources: {}