From cf3b8276bc5c51bff114fc9412243b58e60de4db Mon Sep 17 00:00:00 2001 From: Nick Zenchik Date: Wed, 28 Aug 2024 12:23:12 +0400 Subject: [PATCH] Adding points helm chart --- charts/blockscout-points/.helmignore | 23 +++ charts/blockscout-points/Chart.yaml | 24 +++ .../blockscout-points/templates/_helpers.tpl | 62 ++++++++ .../templates/deployment.yaml | 147 ++++++++++++++++++ .../blockscout-points/templates/ingress.yaml | 61 ++++++++ .../blockscout-points/templates/secret.yaml | 28 ++++ .../blockscout-points/templates/service.yaml | 27 ++++ .../templates/serviceaccount.yaml | 13 ++ .../templates/servicemonitor.yaml | 16 ++ charts/blockscout-points/values.yaml | 127 +++++++++++++++ 10 files changed, 528 insertions(+) create mode 100644 charts/blockscout-points/.helmignore create mode 100644 charts/blockscout-points/Chart.yaml create mode 100644 charts/blockscout-points/templates/_helpers.tpl create mode 100644 charts/blockscout-points/templates/deployment.yaml create mode 100644 charts/blockscout-points/templates/ingress.yaml create mode 100644 charts/blockscout-points/templates/secret.yaml create mode 100644 charts/blockscout-points/templates/service.yaml create mode 100644 charts/blockscout-points/templates/serviceaccount.yaml create mode 100644 charts/blockscout-points/templates/servicemonitor.yaml create mode 100644 charts/blockscout-points/values.yaml diff --git a/charts/blockscout-points/.helmignore b/charts/blockscout-points/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/blockscout-points/.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/blockscout-points/Chart.yaml b/charts/blockscout-points/Chart.yaml new file mode 100644 index 0000000..37b7bf2 --- /dev/null +++ b/charts/blockscout-points/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: blockscout-points +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/charts/blockscout-points/templates/_helpers.tpl b/charts/blockscout-points/templates/_helpers.tpl new file mode 100644 index 0000000..06e3042 --- /dev/null +++ b/charts/blockscout-points/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "blockscout-points.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 "blockscout-points.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 "blockscout-points.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "blockscout-points.labels" -}} +helm.sh/chart: {{ include "blockscout-points.chart" . }} +{{ include "blockscout-points.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "blockscout-points.selectorLabels" -}} +app.kubernetes.io/name: {{ include "blockscout-points.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "blockscout-points.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "blockscout-points.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/blockscout-points/templates/deployment.yaml b/charts/blockscout-points/templates/deployment.yaml new file mode 100644 index 0000000..49f3d59 --- /dev/null +++ b/charts/blockscout-points/templates/deployment.yaml @@ -0,0 +1,147 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "blockscout-points.fullname" . }} + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "blockscout-points.selectorLabels" . | nindent 6 }} + template: + metadata: + annotations: + {{- if eq .Values.image.pullPolicy "Always" }} + rollme: {{ randAlphaNum 5 | quote }} + {{- end }} + checksum/config: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }} + {{- with .Values.podAnnotations }} + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "blockscout-points.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "blockscout-points.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + - name: POINTS_BACKEND__SERVER__HTTP__ENABLED + value: 'true' + - name: POINTS_BACKEND__SERVER__HTTP__ADDR + value: "0.0.0.0:{{ .Values.service.port }}" + - name: POINTS_BACKEND__DATABASE__CREATE_DATABASE + value: {{ .Values.config.database.createDatabase | quote }} + - name: POINTS_BACKEND__DATABASE__RUN_MIGRATIONS + value: {{ .Values.config.database.runMigrations | quote }} + - name: POINTS_BACKEND__AUTH__ADMIN_API_KEY + valueFrom: + secretKeyRef: + name: {{ include "blockscout-points.fullname" . }}-config + key: adminApiKey + - name: POINTS_BACKEND__AUTH__SECRET + valueFrom: + secretKeyRef: + name: {{ include "blockscout-points.fullname" . }}-config + key: jwtSecret + {{- if .Values.config.grpc.enabled }} + - name: POINTS_BACKEND__SERVER__GRPC__ENABLED + value: 'true' + - name: POINTS_BACKEND__SERVER__GRPC__ADDR + value: 0.0.0.0:{{ .Values.config.grpc.port }} + {{- end }} + {{- if .Values.metrics.enabled }} + - name: POINTS_BACKEND__METRICS__ENABLED + value: 'true' + {{- end }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__HOST + value: {{ .Values.config.database.host | quote }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__PORT + value: {{ .Values.config.database.port | quote }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__DBNAME + value: {{ .Values.config.database.db | quote }} + {{- if not .Values.config.database.existingSecret }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__USER + valueFrom: + secretKeyRef: + name: {{ include "blockscout-points.fullname" . }}-config + key: username + - name: postgres_pass + valueFrom: + secretKeyRef: + name: {{ include "blockscout-points.fullname" . }}-config + key: password + {{- else }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__USER + valueFrom: + secretKeyRef: + name: {{ .Values.config.database.existingSecret }} + key: {{ .Values.config.database.existingSecretUsernameKey }} + - name: POINTS_BACKEND__DATABASE__CONNECT__KV__PASSWORD + valueFrom: + secretKeyRef: + name: {{ .Values.config.database.existingSecret }} + key: {{ .Values.config.database.existingSecretPasswordKey }} + {{- end }} + {{- range $key, $value := .Values.env }} + - name: {{ $key }} + value: {{ $value | quote }} + {{- end }} + {{- if .Values.envFromSecret }} + envFrom: + - secretRef: + name: {{ include "blockscout-points.fullname" . }}-env + {{- end }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + {{- if .Values.config.grpc.enabled }} + - name: grpc + containerPort: {{ .Values.config.grpc.port }} + protocol: TCP + {{- end}} + {{- if .Values.metrics.enabled }} + - name: metrics + containerPort: {{ .Values.metrics.port }} + protocol: TCP + {{- end }} + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- 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/blockscout-points/templates/ingress.yaml b/charts/blockscout-points/templates/ingress.yaml new file mode 100644 index 0000000..c70a5a6 --- /dev/null +++ b/charts/blockscout-points/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "blockscout-points.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 "blockscout-points.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/charts/blockscout-points/templates/secret.yaml b/charts/blockscout-points/templates/secret.yaml new file mode 100644 index 0000000..6fc3aff --- /dev/null +++ b/charts/blockscout-points/templates/secret.yaml @@ -0,0 +1,28 @@ +{{- if .Values.envFromSecret }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "blockscout-points.fullname" . }}-env + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} +type: Opaque +data: +{{- range $key, $value := .Values.envFromSecret }} + {{ $key }}: {{ $value | b64enc }} +{{- end }} +{{- end }} +--- +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "blockscout-points.fullname" . }}-config + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} +type: Opaque +data: + adminApiKey: {{ .Values.config.auth.adminApiKey | b64enc | quote }} + jwtSecret: {{ .Values.config.auth.jwtSecret | b64enc | quote }} +{{- if not .Values.config.database.existingSecret }} + username: {{ .Values.config.database.user | b64enc | quote }} + password: {{ .Values.config.database.pass | b64enc | quote }} +{{- end }} \ No newline at end of file diff --git a/charts/blockscout-points/templates/service.yaml b/charts/blockscout-points/templates/service.yaml new file mode 100644 index 0000000..72c4691 --- /dev/null +++ b/charts/blockscout-points/templates/service.yaml @@ -0,0 +1,27 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "blockscout-points.fullname" . }} + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + {{- if .Values.config.grpc.enabled }} + - port: {{ .Values.config.grpc.port }} + targetPort: grpc + protocol: TCP + name: grpc + {{- end}} + {{- if .Values.metrics.enabled }} + - port: {{ .Values.metrics.port }} + targetPort: metrics + protocol: TCP + name: metrics + {{- end }} + selector: + {{- include "blockscout-points.selectorLabels" . | nindent 4 }} diff --git a/charts/blockscout-points/templates/serviceaccount.yaml b/charts/blockscout-points/templates/serviceaccount.yaml new file mode 100644 index 0000000..658be40 --- /dev/null +++ b/charts/blockscout-points/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "blockscout-points.serviceAccountName" . }} + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/blockscout-points/templates/servicemonitor.yaml b/charts/blockscout-points/templates/servicemonitor.yaml new file mode 100644 index 0000000..f82dcd6 --- /dev/null +++ b/charts/blockscout-points/templates/servicemonitor.yaml @@ -0,0 +1,16 @@ +{{- if and .Values.metrics.enabled .Values.metrics.prometheus.enabled }} +apiVersion: monitoring.coreos.com/v1 +kind: ServiceMonitor +metadata: + name: {{ include "blockscout-points.fullname" . }} + labels: + {{- include "blockscout-points.labels" . | nindent 4 }} +spec: + endpoints: + - scrapeTimeout: 30s + port: metrics + path: /metrics + selector: + matchLabels: + app.kubernetes.io/name: {{ include "blockscout-points.fullname" . }} +{{- end }} \ No newline at end of file diff --git a/charts/blockscout-points/values.yaml b/charts/blockscout-points/values.yaml new file mode 100644 index 0000000..5649fbb --- /dev/null +++ b/charts/blockscout-points/values.yaml @@ -0,0 +1,127 @@ +# Default values for blockscout-points. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: ghcr.io/blockscout/points + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "latest" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Automatically mount a ServiceAccount's API credentials? + automount: 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: {} +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 8050 + +config: + auth: + adminApiKey: key + jwtSecret: secret + database: + host: postgres + user: username + pass: password + db: points + port: 5432 + # if DB credentials are stored in existing secret + existingSecret: + existingSecretUsernameKey: + existingSecretPasswordKey: + createDatabase: true + runMigrations: true + grpc: + enabled: false + port: 8051 + +env: [] + # NAME: VALUE +envFromSecret: [] + # NAME: VALUE + +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: + limits: + cpu: 500m + memory: 1Gi + requests: + cpu: 200m + memory: 256Mi + +livenessProbe: + httpGet: + path: /health?service= + port: http +readinessProbe: + httpGet: + path: /health?service= + port: http + +metrics: + enabled: false + port: 6060 + prometheus: + enabled: false + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {}