From 220b61cdfa90ba5fc1598948bbdde1fff61c8e06 Mon Sep 17 00:00:00 2001 From: Ahmad Wilson Date: Wed, 8 Feb 2023 16:49:20 -0500 Subject: [PATCH] otterscan: initial chart --- charts/otterscan/Chart.yaml | 15 ++ charts/otterscan/README.md | 64 ++++++++ charts/otterscan/README.md.gotmpl | 24 +++ charts/otterscan/templates/NOTES.txt | 22 +++ charts/otterscan/templates/_helpers.tpl | 66 ++++++++ charts/otterscan/templates/deployment.yaml | 93 +++++++++++ charts/otterscan/templates/ingress.yaml | 61 +++++++ charts/otterscan/templates/secret.yaml | 10 ++ charts/otterscan/templates/service.yaml | 18 +++ .../otterscan/templates/serviceaccount.yaml | 13 ++ .../templates/tests/test-connection.yaml | 16 ++ charts/otterscan/values.yaml | 151 ++++++++++++++++++ 12 files changed, 553 insertions(+) create mode 100644 charts/otterscan/Chart.yaml create mode 100644 charts/otterscan/README.md create mode 100644 charts/otterscan/README.md.gotmpl create mode 100644 charts/otterscan/templates/NOTES.txt create mode 100644 charts/otterscan/templates/_helpers.tpl create mode 100644 charts/otterscan/templates/deployment.yaml create mode 100644 charts/otterscan/templates/ingress.yaml create mode 100644 charts/otterscan/templates/secret.yaml create mode 100644 charts/otterscan/templates/service.yaml create mode 100644 charts/otterscan/templates/serviceaccount.yaml create mode 100644 charts/otterscan/templates/tests/test-connection.yaml create mode 100644 charts/otterscan/values.yaml diff --git a/charts/otterscan/Chart.yaml b/charts/otterscan/Chart.yaml new file mode 100644 index 00000000..4e19a97d --- /dev/null +++ b/charts/otterscan/Chart.yaml @@ -0,0 +1,15 @@ +apiVersion: v2 +name: otterscan +description: > + An open-source, fast, local, laptop-friendly Ethereum block explorer. + It is designed to be run locally with an archive node companion, more specifically, with Erigon. +home: https://github.com/wmitsuda/otterscan +sources: + - https://github.com/wmitsuda/otterscan +type: application +version: 0.1.0 +maintainers: + - name: skylenet + email: rafael@skyle.net + - name: 0x0I + email: zer0ne.io.x@gmail.com diff --git a/charts/otterscan/README.md b/charts/otterscan/README.md new file mode 100644 index 00000000..f4f2e768 --- /dev/null +++ b/charts/otterscan/README.md @@ -0,0 +1,64 @@ + +# otterscan + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) + +An open-source, fast, local, laptop-friendly Ethereum block explorer designed to be run locally with an archive node companion like Erigon. + +**Homepage:** https://github.com/wmitsuda/otterscan + +## Source Code + +* https://github.com/wmitsuda/otterscan + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | Affinity configuration for pods | +| annotations | object | `{}` | Annotations for the Deployment | +| containerSecurityContext | object | See `values.yaml` | The security context for containers | +| customArgs | list | `[]` | Custom args for the otterscan container | +| customCommand | list | `[]` | Command replacement for the otterscan container | +| extraContainers | list | `[]` | Additional containers | +| extraEnv | list | `[]` | Additional env variables | +| extraPorts | list | `[]` | Additional ports. Useful when using extraContainers | +| extraVolumeMounts | list | `[]` | Additional volume mounts | +| extraVolumes | list | `[]` | Additional volumes | +| fullnameOverride | string | `""` | Overrides the chart's computed fullname | +| image.pullPolicy | string | `"IfNotPresent"` | otterscan container pull policy | +| image.repository | string | `"otterscan/otterscan"` | otterscan container image repository | +| image.tag | string | `"latest"` | otterscan container image tag | +| imagePullSecrets | list | `[]` | Image pull secrets for Docker images | +| ingress.annotations | object | `{}` | Annotations for Ingress | +| ingress.enabled | bool | `false` | Ingress resource for the HTTP API | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths | list | `[]` | | +| ingress.tls | list | `[]` | Ingress TLS | +| initContainers | list | `[]` | Additional init containers | +| livenessProbe | object | See `values.yaml` | Liveness probe | +| nameOverride | string | `""` | Overrides the chart's name | +| nodeSelector | object | `{}` | Node selector for pods | +| podAnnotations | object | `{}` | Pod annotations | +| podDisruptionBudget | object | `{}` | Define the PodDisruptionBudget spec If not set then a PodDisruptionBudget will not be created | +| podLabels | object | `{}` | Pod labels | +| priorityClassName | string | `nil` | Pod priority class | +| readinessProbe | object | See `values.yaml` | Readiness probe | +| resources | object | `{}` | Resource requests and limits | +| secretEnv | object | `{"WS_SECRET":"PleaseChangeThisotterscanSecret"}` | Secret env variables injected via a created secret | +| securityContext | object | See `values.yaml` | The security context for pods | +| service.type | string | `"ClusterIP"` | Service type | +| serviceAccount.annotations | object | `{}` | Annotations to add to the service account | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| terminationGracePeriodSeconds | int | `30` | How long to wait until the pod is forcefully terminated | +| tolerations | list | `[]` | Tolerations for pods | + +# Examples + +## Setting the shared secret required for incoming websocket connections + +```yaml +secretEnv: + WS_SECRET: "SomeSuperSharedSecret" +``` diff --git a/charts/otterscan/README.md.gotmpl b/charts/otterscan/README.md.gotmpl new file mode 100644 index 00000000..7806f19e --- /dev/null +++ b/charts/otterscan/README.md.gotmpl @@ -0,0 +1,24 @@ + +{{ template "chart.header" . }} +{{ template "chart.deprecationWarning" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }} + +{{ template "chart.description" . }} + +{{ template "chart.homepageLine" . }} + +{{ template "chart.sourcesSection" . }} + +{{ template "chart.requirementsSection" . }} + +{{ template "chart.valuesSection" . }} + +# Examples + +## Setting the shared secret required for incoming websocket connections + +```yaml +secretEnv: + WS_SECRET: "SomeSuperSharedSecret" +``` diff --git a/charts/otterscan/templates/NOTES.txt b/charts/otterscan/templates/NOTES.txt new file mode 100644 index 00000000..9b35cdc7 --- /dev/null +++ b/charts/otterscan/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 "otterscan.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 "otterscan.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "otterscan.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ include "otterscan.httpPort" . }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "otterscan.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/charts/otterscan/templates/_helpers.tpl b/charts/otterscan/templates/_helpers.tpl new file mode 100644 index 00000000..282dab29 --- /dev/null +++ b/charts/otterscan/templates/_helpers.tpl @@ -0,0 +1,66 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "otterscan.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 "otterscan.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 "otterscan.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "otterscan.labels" -}} +helm.sh/chart: {{ include "otterscan.chart" . }} +{{ include "otterscan.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "otterscan.selectorLabels" -}} +app.kubernetes.io/name: {{ include "otterscan.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "otterscan.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "otterscan.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "otterscan.httpPort" -}} +{{- printf "80" -}} +{{- end -}} diff --git a/charts/otterscan/templates/deployment.yaml b/charts/otterscan/templates/deployment.yaml new file mode 100644 index 00000000..933b4684 --- /dev/null +++ b/charts/otterscan/templates/deployment.yaml @@ -0,0 +1,93 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "otterscan.fullname" . }} + labels: + {{- include "otterscan.labels" . | nindent 4 }} + annotations: + {{- toYaml .Values.annotations | nindent 4 }} +spec: + replicas: 1 + selector: + matchLabels: + {{- include "otterscan.selectorLabels" . | nindent 6 }} + template: + metadata: + labels: + {{- include "otterscan.selectorLabels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + annotations: + checksum/secrets: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }} + {{- with .Values.podAnnotations }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + serviceAccountName: {{ include "otterscan.serviceAccountName" . }} + {{- if .Values.priorityClassName }} + priorityClassName: {{ .Values.priorityClassName }} + {{- end }} + securityContext: + {{- toYaml .Values.securityContext | nindent 8 }} + initContainers: + {{- if .Values.initContainers }} + {{- toYaml .Values.initContainers | nindent 8 }} + {{- end }} + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- if gt (len .Values.customCommand) 0 }} + command: + {{- toYaml .Values.customCommand | nindent 12}} + {{- end }} + {{- if gt (len .Values.customArgs) 0 }} + args: + {{- toYaml .Values.customArgs | nindent 12}} + {{- end }} + securityContext: + {{- toYaml .Values.containerSecurityContext | nindent 12 }} + volumeMounts: + {{- if .Values.extraVolumeMounts }} + {{ toYaml .Values.extraVolumeMounts | nindent 12}} + {{- end }} + ports: + - name: http + containerPort: 80 + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + env: + {{- range $key, $value := .Values.secretEnv }} + - name: {{ $key }} + valueFrom: + secretKeyRef: + name: {{ include "otterscan.fullname" $ }}-env + key: {{ $key }} + {{- end }} + {{- if .Values.extraEnv }} + {{- toYaml .Values.extraEnv | nindent 12 }} + {{- end }} + {{- if .Values.extraContainers }} + {{ toYaml .Values.extraContainers | nindent 8}} + {{- end }} + nodeSelector: + {{- toYaml .Values.nodeSelector | nindent 8 }} + affinity: + {{- toYaml .Values.affinity | nindent 8 }} + tolerations: + {{- toYaml .Values.tolerations | nindent 8 }} + terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }} + volumes: + {{- if .Values.extraVolumes }} + {{ toYaml .Values.extraVolumes | nindent 8}} + {{- end }} diff --git a/charts/otterscan/templates/ingress.yaml b/charts/otterscan/templates/ingress.yaml new file mode 100644 index 00000000..4f4ef62b --- /dev/null +++ b/charts/otterscan/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "otterscan.fullname" . -}} +{{- $svcPort := include "otterscan.httpPort" . -}} +{{- 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 "otterscan.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/otterscan/templates/secret.yaml b/charts/otterscan/templates/secret.yaml new file mode 100644 index 00000000..ef1156ee --- /dev/null +++ b/charts/otterscan/templates/secret.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "otterscan.fullname" . }}-env + labels: + {{- include "otterscan.labels" . | nindent 4 }} +data: +{{- range $key, $value := .Values.secretEnv }} + {{ $key }}: {{ $value | b64enc }} +{{- end }} diff --git a/charts/otterscan/templates/service.yaml b/charts/otterscan/templates/service.yaml new file mode 100644 index 00000000..fd213c1c --- /dev/null +++ b/charts/otterscan/templates/service.yaml @@ -0,0 +1,18 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "otterscan.fullname" . }} + labels: + {{- include "otterscan.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ include "otterscan.httpPort" . }} + targetPort: http + protocol: TCP + name: http + {{- if .Values.extraPorts }} + {{ toYaml .Values.extraPorts | nindent 4}} + {{- end }} + selector: + {{- include "otterscan.selectorLabels" . | nindent 4 }} diff --git a/charts/otterscan/templates/serviceaccount.yaml b/charts/otterscan/templates/serviceaccount.yaml new file mode 100644 index 00000000..79c200eb --- /dev/null +++ b/charts/otterscan/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "otterscan.serviceAccountName" . }} + labels: + {{- include "otterscan.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} + namespace: {{ .Release.Namespace }} +{{- end }} diff --git a/charts/otterscan/templates/tests/test-connection.yaml b/charts/otterscan/templates/tests/test-connection.yaml new file mode 100644 index 00000000..616190b5 --- /dev/null +++ b/charts/otterscan/templates/tests/test-connection.yaml @@ -0,0 +1,16 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "otterscan.fullname" . }}-test-connection" + labels: + {{- include "otterscan.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: curl + image: curlimages/curl + command: ['curl'] + args: + - '{{ include "otterscan.fullname" . }}:{{ include "otterscan.httpPort" . }}/' + restartPolicy: Never diff --git a/charts/otterscan/values.yaml b/charts/otterscan/values.yaml new file mode 100644 index 00000000..af1698cb --- /dev/null +++ b/charts/otterscan/values.yaml @@ -0,0 +1,151 @@ +# -- Overrides the chart's name +nameOverride: "" + +# -- Overrides the chart's computed fullname +fullnameOverride: "" + +image: + # -- otterscan container image repository + repository: otterscan/otterscan + # -- otterscan container image tag + tag: latest + # -- otterscan container pull policy + pullPolicy: IfNotPresent + +# -- Secret env variables injected via a created secret +secretEnv: + WS_SECRET: "PleaseChangeThisotterscanSecret" + +ingress: + # -- Ingress resource for the HTTP API + enabled: false + # -- Annotations for Ingress + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + # -- Ingress host + hosts: + - host: chart-example.local + paths: [] + # -- Ingress TLS + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +# -- Custom args for the otterscan container +customArgs: [] + +# -- Command replacement for the otterscan container +customCommand: [] # Only change this if you need to change the default command + +service: + # -- Service type + type: ClusterIP + +# -- Affinity configuration for pods +affinity: {} + +# -- Image pull secrets for Docker images +imagePullSecrets: [] + +# -- Annotations for the Deployment +annotations: {} + +# -- Liveness probe +# @default -- See `values.yaml` +livenessProbe: + tcpSocket: + port: http + initialDelaySeconds: 60 + periodSeconds: 120 + +# -- Readiness probe +# @default -- See `values.yaml` +readinessProbe: + tcpSocket: + port: http + initialDelaySeconds: 10 + periodSeconds: 10 + +# -- Node selector for pods +nodeSelector: {} + +# -- Pod labels +podLabels: {} + +# -- Pod annotations +podAnnotations: {} + +# -- Pod priority class +priorityClassName: null + +# -- Resource requests and limits +resources: {} +# limits: +# cpu: 500m +# memory: 2Gi +# requests: +# cpu: 300m +# memory: 1Gi + +# -- The security context for pods +# @default -- See `values.yaml` +securityContext: + fsGroup: 10001 + runAsGroup: 10001 + runAsNonRoot: true + runAsUser: 10001 + +# -- The security context for containers +# @default -- See `values.yaml` +containerSecurityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +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: "" + +# -- How long to wait until the pod is forcefully terminated +terminationGracePeriodSeconds: 30 + +# -- Tolerations for pods +## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ +tolerations: [] + +# -- Define the PodDisruptionBudget spec +# If not set then a PodDisruptionBudget will not be created +podDisruptionBudget: {} +# minAvailable: 1 +# maxUnavailable: 1 + +# -- Additional init containers +initContainers: [] +# - name: my-init-container +# image: busybox:latest +# command: ['sh', '-c', 'echo hello'] + +# -- Additional containers +extraContainers: [] + +# -- Additional volumes +extraVolumes: [] + +# -- Additional volume mounts +extraVolumeMounts: [] + +# -- Additional ports. Useful when using extraContainers +extraPorts: [] + +# -- Additional env variables +extraEnv: []