From 80c51fff1cd5bc7a42300e16011d5c09fe1ee5ff Mon Sep 17 00:00:00 2001 From: Kyle White Date: Thu, 16 Jan 2025 14:14:27 -0500 Subject: [PATCH] Add frontend chart (#582) * Add frontend chart * Add env vars for nginx * Fix up port, fix up Release.Name, add configmap * Change frontend tag --- .../helm/lumigator/charts/backend/values.yaml | 2 +- .../lumigator/charts/frontend/.helmignore | 23 ++++++ .../helm/lumigator/charts/frontend/Chart.yaml | 24 ++++++ .../charts/frontend/templates/NOTES.txt | 16 ++++ .../charts/frontend/templates/_helpers.tpl | 51 ++++++++++++ .../charts/frontend/templates/deployment.yaml | 75 ++++++++++++++++++ .../charts/frontend/templates/nginx-cm.yaml | 33 ++++++++ .../charts/frontend/templates/service.yaml | 15 ++++ .../lumigator/charts/frontend/values.yaml | 78 +++++++++++++++++++ 9 files changed, 316 insertions(+), 1 deletion(-) create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/.helmignore create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/Chart.yaml create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/NOTES.txt create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/_helpers.tpl create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/deployment.yaml create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/nginx-cm.yaml create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/service.yaml create mode 100644 lumigator/infra/mzai/helm/lumigator/charts/frontend/values.yaml diff --git a/lumigator/infra/mzai/helm/lumigator/charts/backend/values.yaml b/lumigator/infra/mzai/helm/lumigator/charts/backend/values.yaml index 5ecc9cea..ceb433ef 100644 --- a/lumigator/infra/mzai/helm/lumigator/charts/backend/values.yaml +++ b/lumigator/infra/mzai/helm/lumigator/charts/backend/values.yaml @@ -46,7 +46,7 @@ securityContext: service: type: ClusterIP - port: 80 + port: 8000 https: false resources: diff --git a/lumigator/infra/mzai/helm/lumigator/charts/frontend/.helmignore b/lumigator/infra/mzai/helm/lumigator/charts/frontend/.helmignore new file mode 100644 index 00000000..0e8a0eb3 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/.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/lumigator/infra/mzai/helm/lumigator/charts/frontend/Chart.yaml b/lumigator/infra/mzai/helm/lumigator/charts/frontend/Chart.yaml new file mode 100644 index 00000000..8acc22f3 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: frontend +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.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" diff --git a/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/NOTES.txt b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/NOTES.txt new file mode 100644 index 00000000..84c311f6 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/NOTES.txt @@ -0,0 +1,16 @@ +1. Get the application URL by running these commands: +{{- if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "frontend.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 "frontend.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "frontend.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 "frontend.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/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/_helpers.tpl b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/_helpers.tpl new file mode 100644 index 00000000..b0cc2628 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/_helpers.tpl @@ -0,0 +1,51 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "frontend.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 "frontend.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 "frontend.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "frontend.labels" -}} +helm.sh/chart: {{ include "frontend.chart" . }} +{{ include "frontend.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "frontend.selectorLabels" -}} +app.kubernetes.io/name: {{ include "frontend.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} diff --git a/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/deployment.yaml b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/deployment.yaml new file mode 100644 index 00000000..b76df5d3 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/deployment.yaml @@ -0,0 +1,75 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "frontend.fullname" . }} + labels: + {{- include "frontend.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "frontend.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "frontend.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ .Values.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 }} + env: + - name: LUMIGATOR_API_PORT + value: "8000" + - name: LUMIGATOR_API_HOST + value: {{ .Release.Name }}-backend + 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: nginx-conf + mountPath: /etc/nginx/templates/default.conf.template + subPath: default.conf.template + readOnly: true + volumes: + - name: nginx-conf + configMap: + name: nginx-conf + items: + - key: default.conf.template + path: default.conf.template + {{- 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/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/nginx-cm.yaml b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/nginx-cm.yaml new file mode 100644 index 00000000..2af334ae --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/nginx-cm.yaml @@ -0,0 +1,33 @@ + +apiVersion: v1 +kind: ConfigMap +metadata: + name: nginx-conf +data: + default.conf.template: | + server { + listen 80; + listen [::]:80; + server_name localhost; + + location /api { + proxy_pass http://$LUMIGATOR_API_HOST:$LUMIGATOR_API_PORT; # This will use the API_SERVER environment variable + proxy_http_version 1.1; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + + location / { + root /usr/share/nginx/html; + index index.html index.htm; + try_files $uri $uri/ /index.html; + } + + # redirect server error pages to the static page /50x.html + error_page 500 502 503 504 /50x.html; + location = /50x.html { + root /usr/share/nginx/html; + } + } diff --git a/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/service.yaml b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/service.yaml new file mode 100644 index 00000000..708b0eda --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "frontend.fullname" . }} + labels: + {{- include "frontend.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "frontend.selectorLabels" . | nindent 4 }} diff --git a/lumigator/infra/mzai/helm/lumigator/charts/frontend/values.yaml b/lumigator/infra/mzai/helm/lumigator/charts/frontend/values.yaml new file mode 100644 index 00000000..de8c2cd6 --- /dev/null +++ b/lumigator/infra/mzai/helm/lumigator/charts/frontend/values.yaml @@ -0,0 +1,78 @@ +# Default values for frontend. +# 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 sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: mzdotai/lumigator-frontend + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +serviceAccountName: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: + {} + # fsGroup: 2000 + +securityContext: + {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 80 + +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 + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +nodeSelector: {} + +tolerations: [] + +affinity: {}