feat(charts/tracoor-single): init (#325)

.github/workflows/test-charts.yaml

@@ -66,4 +66,5 @@ jobs:
           --excluded-charts beacon-metrics-gazer
           --excluded-charts tracoor-server
           --excluded-charts tracoor-agent
+          --excluded-charts tracoor-single
           --excluded-charts xatu-cl-mimicry

README.md

@@ -93,6 +93,9 @@ Tooling
 - [`stubbies`](charts/stubbies) - Ethereum execution client stub for consensus layer clients.
 - [`testnet-faucet`](charts/testnet-faucet) - Web faucet that can be used to distribute testnet ETH to users.
 - [`testnet-homepage`](charts/testnet-homepage) - Simple website that can be used to display useful information about your testnet.
+- [`tracoor-single`](charts/tracoor-single) - An Ethereum beacon data and execution trace explorer in single mode.
+- [`tracoor-server`](charts/tracoor-server) - An Ethereum beacon data and execution trace explorer in server mode.
+- [`tracoor-agent`](charts/tracoor-agent) - An Ethereum beacon data and execution trace explorer in agent mode.
 - [`web3signer`](charts/web3signer) - An open-source remote signing service.
 - [`xatu-discovery`](charts/xatu-discovery) - Ethereum p2p monitoring tool that discovers node records.
 - [`xatu-mimicry`](charts/xatu-mimicry) - Ethereum p2p monitoring tool that collects data from the execution layer.

charts/tracoor-single/.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/tracoor-single/Chart.yaml

@@ -0,0 +1,11 @@
+apiVersion: v2
+name: tracoor-single
+description: Ethereum debug data capture and indexer
+home: https://github.com/ethpandaops/tracoor
+type: application
+version: 0.0.1
+maintainers:
+  - name: samcm
+    email: sam.calder-mason@ethereum.org
+  - name: savid
+    email: andrew.davis@ethereum.org

charts/tracoor-single/README.md

@@ -0,0 +1,97 @@
+
+# tracoor-single
+
+![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+
+Ethereum debug data capture and indexer
+
+**Homepage:** <https://github.com/ethpandaops/tracoor>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | Affinity configuration for pods |
+| annotations | object | `{}` | Annotations for the Deployment |
+| args | list | `[]` | Command arguments |
+| autoscaling.enabled | bool | `false` | Autoscaling configuration |
+| autoscaling.maxReplicas | int | `3` | Maximum number of replicas |
+| autoscaling.minReplicas | int | `2` | Minimum number of replicas |
+| autoscaling.targetCPUUtilizationPercentage | int | `85` | Target CPU utilization percentage |
+| config.agents[0].ethereum.beacon.nodeAddress | string | `"http://localhost:5052"` |  |
+| config.agents[0].ethereum.execution.nodeAddress | string | `"http://localhost:8545"` |  |
+| config.agents[0].ethereum.execution.traceDisableMemory | bool | `true` |  |
+| config.agents[0].ethereum.execution.traceDisableStack | bool | `true` |  |
+| config.agents[0].ethereum.execution.traceDisableStorage | bool | `true` |  |
+| config.agents[0].ethereum.overrideNetworkName | string | `"mainnet"` |  |
+| config.agents[0].name | string | `"instance-1"` |  |
+| config.server.addr | string | `":8081"` |  |
+| config.server.gatewayAddr | string | `":8080"` |  |
+| config.server.ntpServer | string | `"time.google.com"` |  |
+| config.server.persistence.driver_name | string | `"sqlite"` |  |
+| config.server.persistence.dsn | string | `"file:/tmp/tracoor.db"` |  |
+| config.server.pprofAddr | string | `":6060"` |  |
+| config.server.preStopSleepSeconds | int | `1` |  |
+| config.server.services.indexer.retention.beaconBlocks | string | `"30m"` |  |
+| config.server.services.indexer.retention.beaconStates | string | `"30m"` |  |
+| config.server.services.indexer.retention.executionBlockTraces | string | `"30m"` |  |
+| config.shared.indexer.address | string | `"localhost:8081"` |  |
+| config.shared.logging | string | `"debug"` |  |
+| config.shared.metricsAddr | string | `":9091"` |  |
+| config.shared.store.config.base_path | string | `"/tmp/tracoor"` |  |
+| config.shared.store.type | string | `"fs"` |  |
+| containerSecurityContext | object | See `values.yaml` | The security context for containers |
+| customArgs | list | `[]` | Custom args for the tracoor container |
+| customCommand | list | `[]` | Command replacement for the tracoor container |
+| extraContainers | list | `[]` | Additional containers |
+| extraEnv | list | `[]` | Additional env variables |
+| extraPodPorts | list | `[]` | Extra Pod ports |
+| 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"` | tracoor container pull policy |
+| image.repository | string | `"ethpandaops/tracoor"` | tracoor container image repository |
+| image.tag | string | `"latest"` | tracoor container image tag |
+| imagePullSecrets | list | `[]` | Image pull secrets for Docker images |
+| ingress.grpc.annotations | object | `{}` | Annotations for Ingress |
+| ingress.grpc.enabled | bool | `false` | Ingress resource for GRPC |
+| ingress.grpc.hosts[0].host | string | `"chart-example.local"` |  |
+| ingress.grpc.hosts[0].paths | list | `[]` |  |
+| ingress.grpc.tls | list | `[]` | Ingress TLS |
+| ingress.http.annotations | object | `{}` | Annotations for Ingress |
+| ingress.http.enabled | bool | `false` | Ingress resource for the HTTP API |
+| ingress.http.hosts[0].host | string | `"chart-example.local"` |  |
+| ingress.http.hosts[0].paths | list | `[]` |  |
+| ingress.http.tls | list | `[]` | Ingress TLS |
+| initContainers | list | `[]` | Additional init containers |
+| lifecycle | object | See `values.yaml` | Lifecycle hooks |
+| 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 |
+| replicas | int | `1` | Number of replicas |
+| resources | object | `{}` | Resource requests and limits |
+| secretEnv | object | `{}` | 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 | `false` | 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 |
+| serviceMonitor.annotations | object | `{}` | Additional ServiceMonitor annotations |
+| serviceMonitor.enabled | bool | `false` | If true, a ServiceMonitor CRD is created for a prometheus operator https://github.com/coreos/prometheus-operator |
+| serviceMonitor.interval | string | `"15s"` | ServiceMonitor scrape interval |
+| serviceMonitor.labels | object | `{}` | Additional ServiceMonitor labels |
+| serviceMonitor.namespace | string | `nil` | Alternative namespace for ServiceMonitor |
+| serviceMonitor.path | string | `"/metrics"` | Path to scrape |
+| serviceMonitor.relabelings | list | `[]` | ServiceMonitor relabelings |
+| serviceMonitor.scheme | string | `"http"` | ServiceMonitor scheme |
+| serviceMonitor.scrapeTimeout | string | `"30s"` | ServiceMonitor scrape timeout |
+| serviceMonitor.tlsConfig | object | `{}` | ServiceMonitor TLS configuration |
+| terminationGracePeriodSeconds | int | `90` | How long to wait until the pod is forcefully terminated |
+| tolerations | list | `[]` | Tolerations for pods |
+| topologySpreadConstraints | list | `[]` | Topology Spread Constraints for pods |

charts/tracoor-single/README.md.gotmpl

@@ -0,0 +1,15 @@
+
+{{ 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" . }}

charts/tracoor-single/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 "tracoor-single.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 "tracoor-single.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "tracoor-single.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ include "tracoor-single.httpPort" . }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "tracoor-single.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/tracoor-single/templates/_helpers.tpl

@@ -0,0 +1,80 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "tracoor-single.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 "tracoor-single.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 "tracoor-single.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "tracoor-single.labels" -}}
+helm.sh/chart: {{ include "tracoor-single.chart" . }}
+{{ include "tracoor-single.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "tracoor-single.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "tracoor-single.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "tracoor-single.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "tracoor-single.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{- define "tracoor-single.httpPort" -}}
+{{ (split ":" .Values.config.server.gatewayAddr)._1 | default "8080" }}
+{{- end }}
+
+{{- define "tracoor-single.grpcPort" -}}
+{{ (split ":" .Values.config.server.addr)._1 | default "8081" }}
+{{- end }}
+
+{{- define "tracoor-single.metricsPort" -}}
+{{ (split ":" .Values.config.shared.metricsAddr)._1 | default "9090" }}
+{{- end -}}
+
+{{- define "tracoor-single.pprofPort" -}}
+{{- if .Values.config.server.pprofAddr -}}
+{{ (split ":" .Values.config.server.pprofAddr)._1 | default "6060" }}
+{{- end -}}
+{{- end -}}

charts/tracoor-single/templates/configmap.yaml

@@ -0,0 +1,9 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "tracoor-single.fullname" . }}
+  labels:
+    {{- include "tracoor-single.labels" . | nindent 4 }}
+data:
+  config.yaml: |-
+    {{ toYaml .Values.config | nindent 4 }}