Initial set of templates for Block Node server k8 Helm Chart

Signed-off-by: Alfredo Gutierrez <[email protected]>

charts/.gitignore

@@ -0,0 +1,2 @@
+*/out
+out

charts/README.md

@@ -0,0 +1,37 @@
+# Helm Chart
+Installs the Hedera Block Node on a Kubernetes cluster.
+
+## Prerequisites
+- Helm 3+
+- Kubernetes 1.29+
+
+Set environment variables that will be used for the remainder of the document:
+
+```bash
+export RELEASE="bn1"
+```
+
+## Template
+To generate the K8 manifest files without installing the chart:
+```bash
+helm template --name-template my-bn hedera-block-node/ --dry-run --output-dir out
+```
+
+## Install
+To install the chart:
+```bash
+helm repo add hedera-block-node https://hashgraph.github.io/hedera-block-node/charts
+helm upgrade --install "${RELEASE}" hedera-block-node/hedera-block-node
+```
+
+
+## Configure
+
+## Testing
+
+## Using
+
+## Uninstall
+
+## Troubleshooting
+

charts/hedera-block-node/.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/

charts/hedera-block-node/Chart.yaml

@@ -0,0 +1,16 @@
+apiVersion: v2
+appVersion: "0.1.0-SNAPSHOT"
+description: A Helm chart for Hedera Block Node
+home: https://github.com/hashgraph/hedera-block-node
+keywords:
+  - blocknode
+  - dlt
+  - hedera
+  - hashgraph
+maintainers:
+  - name: Hedera Block Node Team
+    email: [email protected]
+name: hedera-block-node
+sources:
+  - https://github.com/hashgraph/hedera-block-node
+version: 0.1.0-SNAPSHOT

charts/hedera-block-node/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 "hedera-block-node.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 "hedera-block-node.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "hedera-block-node.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 "hedera-block-node.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 }}

charts/hedera-block-node/templates/_helpers.tpl

@@ -0,0 +1,80 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "hedera-block-node.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 "hedera-block-node.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 "hedera-block-node.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "hedera-block-node.labels" -}}
+helm.sh/chart: {{ include "hedera-block-node.chart" . }}
+{{ include "hedera-block-node.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "hedera-block-node.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "hedera-block-node.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "hedera-block-node.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "hedera-block-node.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+This function returns the image tag from the values.yaml file if provided.
+If the tag is not provided, it defaults to the AppVersion specified in the Chart.yaml file.
+Usage: {{ include "image.AppVersion" . }}
+*/}}
+{{- define "hedera-block-node.image.tag" -}}
+{{- default .Chart.AppVersion .Values.image.tag -}}
+{{- end -}}
+
+{{/*
+This function returns the image tag from the values.yaml file if provided.
+If the tag is not provided, it defaults to the AppVersion specified in the Chart.yaml file.
+Usage: {{ include "hedera-block-node.app.version" . }}
+*/}}
+{{- define "hedera-block-node.appVersion" -}}
+{{- default .Chart.AppVersion .Values.blockNode.version -}}
+{{- end -}}

charts/hedera-block-node/templates/configmap.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "hedera-block-node.fullname" . }}-config
+data:
+  VERSION: {{ include "hedera-block-node.appVersion" .  | quote }}
+  BLOCKNODE_STORAGE_ROOT_PATH: {{ .Values.blockNode.storageRootPath | quote }}

charts/hedera-block-node/templates/deployment.yaml

@@ -0,0 +1,64 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "hedera-block-node.fullname" . }}
+  labels:
+    {{- include "hedera-block-node.labels" . | nindent 4 }}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      {{- include "hedera-block-node.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "hedera-block-node.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "hedera-block-node.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
+        envFrom:
+          - configMapRef:
+              name: {{ include "hedera-block-node.fullname" . }}-config
+          - secretRef:
+              name: {{ include "hedera-block-node.fullname" . }}-secret
+        # TODO: Uncomment them once we have the health and readiness probes in our application
+        #livenessProbe:
+        #  httpGet:
+        #    path: /health # we need to define this in our application
+        #    port: 8080 # will be the same as server port?
+        #readinessProbe:
+        #    httpGet:
+        #      path: /ready # we need to define this in our application
+        #      port: 8080 # will be the same as server port?
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+

charts/hedera-block-node/templates/ingress.yaml

@@ -0,0 +1,61 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "hedera-block-node.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 "hedera-block-node.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 }}

charts/hedera-block-node/templates/secret.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "hedera-block-node.fullname" . }}-secret
+type: Opaque
+data:
+  PRIVATE_KEY_TYPE: {{ .Values.blockNode.consumer.privateKeyType | quote | b64enc }}
+  PRIVATE_KEY_ENCODING: {{ .Values.blockNode.consumer.privateKeyEncoding | quote | b64enc }}
+  PRIVATE_KEY_ACCOUNT_ID: {{ .Values.blockNode.consumer.privateKeyAccountId | quote | b64enc }}
+  PRIVATE_KEY: {{ .Values.blockNode.consumer.privateKey | quote | b64enc }}
+  HEDERA_NETWORK: {{ .Values.blockNode.consumer.hederaNetwork | quote | b64enc }}

charts/hedera-block-node/templates/service.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "hedera-block-node.fullname" . }}
+  labels:
+    {{- include "hedera-block-node.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: http
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "hedera-block-node.selectorLabels" . | nindent 4 }}

charts/hedera-block-node/templates/serviceaccount.yaml

@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "hedera-block-node.serviceAccountName" . }}
+  labels:
+    {{- include "hedera-block-node.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}

charts/hedera-block-node/values-overrides/local.yaml

@@ -0,0 +1,5 @@
+image:
+  repository: localhost
+  tag: "0.1.0-SNAPSHOT"
+  pullPolicy: always
+