From 8f849741569355a80883f77ebcbc644b18eed0f1 Mon Sep 17 00:00:00 2001 From: Liviu Damian Date: Tue, 26 Sep 2023 23:02:29 +0300 Subject: [PATCH] feat: add Helm Chart for new infrastructure (#52) --- .dockerignore | 1 + .github/workflows/helm-publish.yml | 36 ++++++++ helm/fuel-explorer/.helmignore | 23 ++++++ helm/fuel-explorer/Chart.yaml | 24 ++++++ helm/fuel-explorer/templates/NOTES.txt | 22 +++++ helm/fuel-explorer/templates/_helpers.tpl | 62 ++++++++++++++ helm/fuel-explorer/templates/deployment.yaml | 56 +++++++++++++ helm/fuel-explorer/templates/hpa.yaml | 32 ++++++++ helm/fuel-explorer/templates/ingress.yaml | 61 ++++++++++++++ helm/fuel-explorer/templates/service.yaml | 15 ++++ .../templates/serviceaccount.yaml | 12 +++ .../templates/tests/test-connection.yaml | 15 ++++ helm/fuel-explorer/values.yaml | 82 +++++++++++++++++++ 13 files changed, 441 insertions(+) create mode 100644 .github/workflows/helm-publish.yml create mode 100644 helm/fuel-explorer/.helmignore create mode 100644 helm/fuel-explorer/Chart.yaml create mode 100644 helm/fuel-explorer/templates/NOTES.txt create mode 100644 helm/fuel-explorer/templates/_helpers.tpl create mode 100644 helm/fuel-explorer/templates/deployment.yaml create mode 100644 helm/fuel-explorer/templates/hpa.yaml create mode 100644 helm/fuel-explorer/templates/ingress.yaml create mode 100644 helm/fuel-explorer/templates/service.yaml create mode 100644 helm/fuel-explorer/templates/serviceaccount.yaml create mode 100644 helm/fuel-explorer/templates/tests/test-connection.yaml create mode 100644 helm/fuel-explorer/values.yaml diff --git a/.dockerignore b/.dockerignore index f173399b2..0c33aab5c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -3,3 +3,4 @@ node_modules .vercel .turbo dist +.git \ No newline at end of file diff --git a/.github/workflows/helm-publish.yml b/.github/workflows/helm-publish.yml new file mode 100644 index 000000000..52b84c569 --- /dev/null +++ b/.github/workflows/helm-publish.yml @@ -0,0 +1,36 @@ +name: Build and publish Helm Chart + +on: + push: + branches: + - main + paths: + - "helm/fuel-explorer/Chart.yaml" + +permissions: + contents: read + +jobs: + helm-release: + name: Build Helm Chart + runs-on: buildjet-4vcpu-ubuntu-2204 + if: | + (github.event_name == 'release' && github.event.action == 'published') || + github.ref == 'refs/heads/main' || github.event_name == 'pull_request' + permissions: + contents: read + packages: write + + steps: + - name: Check out code + uses: actions/checkout@v3 + + - name: Package and Push Charts + uses: bsord/helm-push@v4.1.0 + with: + useOCIRegistry: true + registry-url: oci://ghcr.io/fuellabs/helmrelease + username: ${{ github.repository_owner }} + access-token: ${{ secrets.GITHUB_TOKEN }} + force: true + chart-folder: ./helm/fuel-explorer \ No newline at end of file diff --git a/helm/fuel-explorer/.helmignore b/helm/fuel-explorer/.helmignore new file mode 100644 index 000000000..0e8a0eb36 --- /dev/null +++ b/helm/fuel-explorer/.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/helm/fuel-explorer/Chart.yaml b/helm/fuel-explorer/Chart.yaml new file mode 100644 index 000000000..20d5d345f --- /dev/null +++ b/helm/fuel-explorer/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: fuel-explorer +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.1.0" diff --git a/helm/fuel-explorer/templates/NOTES.txt b/helm/fuel-explorer/templates/NOTES.txt new file mode 100644 index 000000000..93a81058e --- /dev/null +++ b/helm/fuel-explorer/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 "fuel-explorer.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 "fuel-explorer.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "fuel-explorer.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 "fuel-explorer.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/helm/fuel-explorer/templates/_helpers.tpl b/helm/fuel-explorer/templates/_helpers.tpl new file mode 100644 index 000000000..32fe6abaf --- /dev/null +++ b/helm/fuel-explorer/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "fuel-explorer.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 "fuel-explorer.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 "fuel-explorer.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "fuel-explorer.labels" -}} +helm.sh/chart: {{ include "fuel-explorer.chart" . }} +{{ include "fuel-explorer.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "fuel-explorer.selectorLabels" -}} +app.kubernetes.io/name: {{ include "fuel-explorer.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "fuel-explorer.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "fuel-explorer.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/helm/fuel-explorer/templates/deployment.yaml b/helm/fuel-explorer/templates/deployment.yaml new file mode 100644 index 000000000..3eaa52cf3 --- /dev/null +++ b/helm/fuel-explorer/templates/deployment.yaml @@ -0,0 +1,56 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "fuel-explorer.fullname" . }} + labels: + {{- include "fuel-explorer.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "fuel-explorer.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "fuel-explorer.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "fuel-explorer.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 }} + envFrom: + - configMapRef: + name: fuel-explorer + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + 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/helm/fuel-explorer/templates/hpa.yaml b/helm/fuel-explorer/templates/hpa.yaml new file mode 100644 index 000000000..310daa4e6 --- /dev/null +++ b/helm/fuel-explorer/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "fuel-explorer.fullname" . }} + labels: + {{- include "fuel-explorer.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "fuel-explorer.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/helm/fuel-explorer/templates/ingress.yaml b/helm/fuel-explorer/templates/ingress.yaml new file mode 100644 index 000000000..b312a48ec --- /dev/null +++ b/helm/fuel-explorer/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "fuel-explorer.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 "fuel-explorer.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 }} diff --git a/helm/fuel-explorer/templates/service.yaml b/helm/fuel-explorer/templates/service.yaml new file mode 100644 index 000000000..fd9c379c2 --- /dev/null +++ b/helm/fuel-explorer/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "fuel-explorer.fullname" . }} + labels: + {{- include "fuel-explorer.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "fuel-explorer.selectorLabels" . | nindent 4 }} diff --git a/helm/fuel-explorer/templates/serviceaccount.yaml b/helm/fuel-explorer/templates/serviceaccount.yaml new file mode 100644 index 000000000..a86ae0d0c --- /dev/null +++ b/helm/fuel-explorer/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "fuel-explorer.serviceAccountName" . }} + labels: + {{- include "fuel-explorer.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/helm/fuel-explorer/templates/tests/test-connection.yaml b/helm/fuel-explorer/templates/tests/test-connection.yaml new file mode 100644 index 000000000..3a0c5d704 --- /dev/null +++ b/helm/fuel-explorer/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "fuel-explorer.fullname" . }}-test-connection" + labels: + {{- include "fuel-explorer.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "fuel-explorer.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/helm/fuel-explorer/values.yaml b/helm/fuel-explorer/values.yaml new file mode 100644 index 000000000..6f4434750 --- /dev/null +++ b/helm/fuel-explorer/values.yaml @@ -0,0 +1,82 @@ +# Default values for fuel-explorer. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: ghcr.io/fuellabs/fuel-explorer + pullPolicy: Always + # Overrides the image tag whose default is the chart appVersion. + tag: "af1e196" + +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: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: + capabilities: + drop: + - ALL + readOnlyRootFilesystem: true + runAsNonRoot: true + runAsUser: 1000 + +service: + type: ClusterIP + port: 3000 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + 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 + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {}