Skip to content

Commit

Permalink
initial agave chart (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
@VladStarr
VladStarr authored Nov 29, 2024
1 parent 24f4f74 commit 30d716a
Show file tree
Hide file tree
Showing 19 changed files with 1,447 additions and 0 deletions.
23 changes: 23 additions & 0 deletions dysnix/agave/.helmignore
View file
Original file line number Diff line number Diff line change
@@ -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/
25 changes: 25 additions & 0 deletions dysnix/agave/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
apiVersion: v2
name: agave
description: Agave (previously Solana) blockchain node Helm chart
type: application

version: 0.1.0
appVersion: v2.0.18

keywords:
- agave
- solana
- crypto
- web3
- cryptocurrency
- blockchain

sources:
- https://github.com/dysnix/charts
- https://github.com/dysnix/docker-agave
- https://github.com/anza-xyz/agave
- https://github.com/solana-labs/solana

maintainers:
- name: VladStarr
email: [email protected]
123 changes: 123 additions & 0 deletions dysnix/agave/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Agave helm chart

A Helm chart to deploy Agave node inside Kubernetes cluster.

## Parameters

### Global parameters

| Name | Description | Value |
| ---------------------------- | ---------------------------------------------------- | ----------------------------- |
| `replicaCount` | Number of pods to deploy in the Stateful Set | `1` |
| `image.repository` | Agave image repository | `ghcr.io/dysnix/docker-agave` |
| `image.tag` | Agave image tag | `""` |
| `image.pullPolicy` | Agave image pull policy | `IfNotPresent` |
| `imagePullSecrets` | Agave image pull secrets | `[]` |
| `nameOverride` | String to partially override release name | `""` |
| `fullnameOverride` | String to fully override release name | `""` |
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` |
| `serviceAccount.name` | The name of the ServiceAccount to use | `""` |
| `serviceAccount.automount` | Whether to auto mount the service account token | `true` |
| `serviceAccount.annotations` | Additional custom annotations for the ServiceAccount | `{}` |
| `podLabels` | Extra labels for pods | `{}` |
| `podAnnotations` | Annotations for pods | `{}` |
| `extraContainerPorts` | Additional ports to expose on Agave container | `[]` |
| `podSecurityContext` | Configure securityContext for entire pod | `{}` |
| `securityContext` | Configure securityContext for Agave container | `{}` |
| `resources` | Set container requests and limits for CPU or memory | `{}` |
| `livenessProbe` | Agave container livenessProbe | `{}` |
| `startupProbe` | Agave container startupProbe | `{}` |
| `readinessProbe` | Agave container readinessProbe | `{}` |
| `affinity` | Affinity for pod assignment | `{}` |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `tolerations` | Tolerations for pod assignment | `[]` |
| `volumes` | Pod extra volumes | `[]` |
| `volumeMounts` | Container extra volumeMounts | `[]` |

### Services configuration

| Name | Description | Value |
| ------------------------------------------- | ------------------------------------------- | ----------- |
| `services.rpc.enabled` | Enable Agave RPC service | `true` |
| `services.rpc.type` | Agave RPC service type | `ClusterIP` |
| `services.rpc.port` | Agave RPC service port (+1 for websocket) | `8899` |
| `services.rpc.extraPorts` | Agave RPC service extra ports to expose | `[]` |
| `services.rpc.publishNotReadyAddresses` | Route trafic even when pod is not ready | `false` |
| `services.metrics.enabled` | Enable Agave metrics service | `false` |
| `services.metrics.type` | Agave metrics service type | `ClusterIP` |
| `services.metrics.port` | Agave metrics service port | `9122` |
| `services.metrics.extraPorts` | Agave metrics service extra ports to expose | `[]` |
| `services.metrics.publishNotReadyAddresses` | Route trafic even when pod is not ready | `true` |

### Ingress configuration

| Name | Description | Value |
| -------------- | ------------------------------------------------------ | ----- |
| `ingress.http` | Ingress configuration for Agave RPC HTTP endpoint | `{}` |
| `ingress.ws` | Ingress configuration for Agave RPC WebSocket endpoint | `{}` |

### Metrics configuration

| Name | Description | Value |
| -------------------------------------- | ---------------------------------------------- | ---------------------- |
| `metrics.enabled` | Enable Agave node metrics collection | `false` |
| `metrics.target` | Where to push Agave metrics | `exporter` |
| `metrics.exporter` | influxdb-exporter configuration | `{}` |
| `metrics.serviceMonitor.enabled` | Enable Prometheus ServiceMonitor | `false` |
| `metrics.influxdb.existingSecret.name` | Name of secret containing InfluxDB credentials | `agave-metrics-config` |
| `metrics.influxdb.existingSecret.key` | Key name inside the secret | `config` |

### Agave node configuration

| Name | Description | Value |
| -------------------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| `agaveArgs` | `agave-validator` arguments | `{}` |
| `gracefulShutdown.timeout` | Seconds to wait for graceful shutdown | `120` |
| `gracefulShutdown.options` | `agave-validator exit` arguments | `{}` |
| `gracefulShutdown.options.force` | Do not wait for restart-window, useful for non-validators | `false` |
| `gracefulShutdown.options.skip-health-check` | Skip health check before exit | `false` |
| `gracefulShutdown.options.skip-health-check` | Skip check for a new snapshot before exit | `false` |
| `rustLog` | Logging configuration | `agave=info,solana_metrics=warn` |
| `plugins.enabled` | Enable download of Geyser plugins | `false` |
| `plugins.containerPorts` | Extra container ports for added plugins | `[]` |
| `plugins.servicePorts` | Extra service ports for added plugins | `[]` |
| `plugins.yellowstoneGRPC.enabled` | Enable download of Yellowstone gRPC | `false` |
| `plugins.yellowstoneGRPC.version` | Yellowstone gRPC version | `v3.0.0+solana.2.0.17` |
| `plugins.yellowstoneGRPC.downloadURL` | From where the plugin needs to be downloaded | `https://github.com/rpcpool/yellowstone-grpc/releases/download/` |
| `plugins.yellowstoneGRPC.listenIP` | Yellowstone gRPC listen IP address, without port | `$(MY_POD_IP)` |
| `plugins.yellowstoneGRPC.config` | Yellowstone gRPC config.json file | `look in values.yaml` |
| `plugins.jitoGRPC.enabled` | Enable download of Jito gRPC | `false` |
| `plugins.jitoGRPC.version` | Jito gRPC version | `v1.17.20` |
| `plugins.jitoGRPC.downloadURL` | From where the plugin needs to be downloaded | `https://github.com/jito-foundation/geyser-grpc-plugin/releases/download/v2.0.51/libgeyser_grpc_plugin_server.so` |
| `plugins.jitoGRPC.listenIP` | Jito gRPC listen IP address, without port | `$(MY_POD_IP)` |
| `plugins.jitoGRPC.config` | Jito gRPC config.json file | `look in values.yaml` |
| `identity.validatorKeypair` | Validator keypair string (required) | `""` |
| `identity.voteKeypair` | Vote keypair string (required only for validator) | `""` |
| `identity.existingSecret` | Use existing secret with keypairs instead of specifying them above | `""` |
| `identity.mountPath` | Keypair files mount path | `/secrets` |

### Agave ledger db persistence config

| Name | Description | Value |
| --------------------------------------- | ------------------------------- | -------------------------- |
| `persistence.ledger.type` | Ledger persistence type | `pvc` |
| `persistence.ledger.pvc.annotations` | PVC volume annotations | `{}` |
| `persistence.ledger.pvc.accessMode` | PVC volume access mode | `ReadWriteOnce` |
| `persistence.ledger.pvc.storageClass` | PVC volume storage class name | `""` |
| `persistence.ledger.pvc.size` | PVC volume size | `2Ti` |
| `persistence.ledger.existingClaim.name` | Existing PVC configuration | `agave-ledger-volume` |
| `persistence.ledger.hostPath.type` | hostPath volume type | `Directory` |
| `persistence.ledger.hostPath.path` | hostPath directory on host node | `/blockchain/agave-ledger` |

### Agave accounts db persistence config

| Name | Description | Value |
| ----------------------------------------- | ------------------------------- | ---------------------------- |
| `persistence.accounts.type` | Accounts persistence type | `pvc` |
| `persistence.accounts.pvc.annotations` | PVC volume annotations | `{}` |
| `persistence.accounts.pvc.accessMode` | PVC volume access mode | `ReadWriteOnce` |
| `persistence.accounts.pvc.storageClass` | PVC volume storage class name | `""` |
| `persistence.accounts.pvc.size` | PVC volume size | `2Ti` |
| `persistence.accounts.existingClaim.name` | Existing PVC configuration | `agave-accounts-volume` |
| `persistence.accounts.hostPath.type` | hostPath volume type | `Directory` |
| `persistence.accounts.hostPath.path` | hostPath directory on host node | `/blockchain/agave-accounts` |
14 changes: 14 additions & 0 deletions dysnix/agave/ci/ct-values.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
identity:
validatorKeypair: "[83,14,17,234,154,118,131,15,148,222,164,240,217,177,178,62,27,15,138,43,9,91,110,197,8,2,78,43,207,188,61,233,43,161,169,18,238,213,255,243,237,121,111,151,144,122,230,225,113,224,121,179,4,232,179,183,82,60,135,13,4,52,66,199]"

readinessProbe:
enabled: false

startupProbe:
enabled: false

gracefulShutdown:
options:
force: true
skip-health-check: true
skip-new-snapshot-check: true
62 changes: 62 additions & 0 deletions dysnix/agave/templates/_helpers.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{{/*
Expand the name of the chart.
*/}}
{{- define "agave.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 "agave.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 "agave.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Common labels
*/}}
{{- define "agave.labels" -}}
helm.sh/chart: {{ include "agave.chart" . }}
{{ include "agave.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "agave.selectorLabels" -}}
app.kubernetes.io/name: {{ include "agave.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Create the name of the service account to use
*/}}
{{- define "agave.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "agave.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}
17 changes: 17 additions & 0 deletions dysnix/agave/templates/configmap-plugins.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{{- if .Values.plugins.enabled }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "agave.fullname" $ }}-plugins-config
labels:
{{- include "agave.labels" . | nindent 4 }}
data:
{{- if .Values.plugins.yellowstoneGRPC.enabled }}
yellowstone-grpc-config.json: |-
{{- .Values.plugins.yellowstoneGRPC.config | nindent 4 }}
{{- end }}
{{- if .Values.plugins.jitoGRPC.enabled }}
jitogrpc-config.json: |-
{{- .Values.plugins.jitoGRPC.config | nindent 4 }}
{{- end }}
{{- end }}
46 changes: 46 additions & 0 deletions dysnix/agave/templates/ingress-http.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{{- if .Values.ingress.http.enabled -}}
{{- $fullName := include "agave.fullname" . -}}
{{- $svcPort := .Values.services.rpc.port -}}
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: {{ $fullName }}-http
labels:
{{- include "agave.labels" . | nindent 4 }}
type: http
{{- with .Values.ingress.http.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
spec:
{{- if .Values.ingress.http.className }}
ingressClassName: {{ .Values.ingress.http.className }}
{{- end }}
{{- if .Values.ingress.http.tls }}
tls:
{{- range .Values.ingress.http.tls }}
- hosts:
{{- range .hosts }}
- {{ . | quote }}
{{- end }}
secretName: {{ .secretName }}
{{- end }}
{{- end }}
rules:
{{- range .Values.ingress.http.hosts }}
- host: {{ .host | quote }}
http:
paths:
{{- range .paths }}
- path: {{ .path }}
{{- if .pathType }}
pathType: {{ .pathType }}
{{- end }}
backend:
service:
name: {{ $fullName }}
port:
number: {{ $svcPort }}
{{- end }}
{{- end }}
{{- end }}
Loading

0 comments on commit 30d716a

Please sign in to comment.