Skip to content

Commit

Permalink
[aztec-prover] feat: add aztec prover (#142)
Browse files Browse the repository at this point in the history
* feat: add aztec-prover node and agent chart

* feat: add maintainers

* feat: add CODEOWNERS
  • Loading branch information
0xDones authored Aug 27, 2024
1 parent 5794731 commit 3992ec9
Show file tree
Hide file tree
Showing 14 changed files with 632 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/.github/workflows/ @NethermindEth/angkor-validator-operators @AntiD2ta @aivarasko @matilote

/charts/aztec-prover/ @0xDones
/charts/cert-manager/ @gehlotanish @Manjeet-Nethermind
/charts/common/ @aivarasko @matilote
/charts/dirk/ @aivarasko @matilote
Expand Down
23 changes: 23 additions & 0 deletions charts/aztec-prover/.helmignore
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/
20 changes: 20 additions & 0 deletions charts/aztec-prover/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
apiVersion: v2
name: aztec-prover
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
maintainers:
- name: 0xDones
81 changes: 81 additions & 0 deletions charts/aztec-prover/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# aztec-prover

![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)

A Helm chart for Kubernetes

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| autoscaling.enabled | bool | `false` | |
| autoscaling.maxReplicas | int | `100` | |
| autoscaling.minReplicas | int | `1` | |
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
| envFrom | list | `[]` | |
| extraObjects | list | `[]` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"aztecprotocol/aztec"` | |
| image.tag | string | `"provernet"` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| livenessProbe.httpGet.path | string | `"/status"` | |
| livenessProbe.httpGet.port | string | `"http"` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| persistence.accessModes[0] | string | `"ReadWriteOnce"` | |
| persistence.enabled | bool | `false` | |
| persistence.mountPath | string | `"/data"` | |
| persistence.size | string | `"50Gi"` | |
| persistence.storageClass | string | `""` | |
| podAnnotations | object | `{}` | |
| podLabels | object | `{}` | |
| podSecurityContext | object | `{}` | |
| proverAgent.args[0] | string | `"start --prover"` | |
| proverAgent.enabled | bool | `false` | |
| proverAgent.env.AZTEC_NODE_URL | string | `"http://aztec-prover-node:8080"` | |
| proverAgent.env.IS_DEV_NET | string | `"true"` | |
| proverAgent.env.LOG_JSON | string | `"false"` | |
| proverAgent.env.LOG_LEVEL | string | `"debug"` | |
| proverAgent.env.OTEL_EXPORTER_OTLP_ENDPOINT | string | `""` | |
| proverAgent.env.PROVER_AGENTS | string | `"1"` | |
| proverAgent.env.PROVER_REAL_PROOFS | string | `"true"` | |
| proverAgent.name | string | `"agent"` | |
| proverNode.args[0] | string | `"start --prover-node --archiver"` | |
| proverNode.enabled | bool | `true` | |
| proverNode.env.AZTEC_PORT | string | `"8080"` | |
| proverNode.env.DATA_DIRECTORY | string | `"/data"` | |
| proverNode.env.ETHEREUM_HOST | string | `"https://provernet-mainnet-fork.aztec.network:8545/$APIKEY"` | |
| proverNode.env.IS_DEV_NET | string | `"true"` | |
| proverNode.env.L1_CHAIN_ID | string | `"677692"` | |
| proverNode.env.LOG_JSON | string | `"false"` | |
| proverNode.env.LOG_LEVEL | string | `"debug"` | |
| proverNode.env.OTEL_EXPORTER_OTLP_ENDPOINT | string | `""` | |
| proverNode.env.PROVER_REAL_PROOFS | string | `"true"` | |
| proverNode.env.TX_PROVIDER_NODE_URL | string | `"https://api.aztec.network/provernet/aztec-node-1/$APIKEY"` | |
| proverNode.name | string | `"node"` | |
| readinessProbe.httpGet.path | string | `"/status"` | |
| readinessProbe.httpGet.port | string | `"http"` | |
| replicaCount | int | `1` | |
| resources | object | `{}` | |
| securityContext | object | `{}` | |
| service.port | int | `8080` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | |
| serviceAccount.automount | bool | `true` | |
| serviceAccount.create | bool | `true` | |
| serviceAccount.name | string | `""` | |
| tolerations | list | `[]` | |
| volumeMounts | list | `[]` | |
| volumes | list | `[]` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
70 changes: 70 additions & 0 deletions charts/aztec-prover/templates/_helpers.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{{/*
Expand the name of the chart.
*/}}
{{- define "aztec-prover.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 "aztec-prover.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 "aztec-prover.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

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

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

{{/*
Create the name of the service account to use
*/}}
{{- define "aztec-prover.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "aztec-prover.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}

{{- define "aztec-prover.config" -}}
{{- if .Values.proverNode.enabled }}
{{- .Values.proverNode | toYaml }}
{{- else if .Values.proverAgent.enabled }}
{{- .Values.proverAgent | toYaml }}
{{- end }}
{{- end }}
11 changes: 11 additions & 0 deletions charts/aztec-prover/templates/configmap.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "aztec-prover.fullname" . }}
labels:
{{- include "aztec-prover.labels" . | nindent 4 }}
data:
{{- with include "aztec-prover.config" . | fromYaml }}
{{- .env | toYaml | nindent 2 }}
{{- end }}
8 changes: 8 additions & 0 deletions charts/aztec-prover/templates/extra-manifests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{{- range .Values.extraObjects }}
---
{{- if kindIs "map" . }}
{{ tpl (toYaml .) $ }}
{{- else }}
{{ tpl . $ }}
{{- end }}
{{- end }}
32 changes: 32 additions & 0 deletions charts/aztec-prover/templates/hpa.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{- if .Values.autoscaling.enabled }}
apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
name: {{ include "aztec-prover.fullname" . }}
labels:
{{- include "aztec-prover.labels" . | nindent 4 }}
spec:
scaleTargetRef:
apiVersion: apps/v1
kind: Deployment
name: {{ include "aztec-prover.fullname" . }}
minReplicas: {{ .Values.autoscaling.minReplicas }}
maxReplicas: {{ .Values.autoscaling.maxReplicas }}
metrics:
{{- if .Values.autoscaling.targetCPUUtilizationPercentage }}
- type: Resource
resource:
name: cpu
target:
type: Utilization
averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
{{- end }}
{{- if .Values.autoscaling.targetMemoryUtilizationPercentage }}
- type: Resource
resource:
name: memory
target:
type: Utilization
averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}
{{- end }}
{{- end }}
61 changes: 61 additions & 0 deletions charts/aztec-prover/templates/ingress.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{{- if .Values.ingress.enabled -}}
{{- $fullName := include "aztec-prover.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 "aztec-prover.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 }}
15 changes: 15 additions & 0 deletions charts/aztec-prover/templates/service.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: v1
kind: Service
metadata:
name: {{ include "aztec-prover.fullname" . }}
labels:
{{- include "aztec-prover.labels" . | nindent 4 }}
spec:
type: {{ .Values.service.type }}
ports:
- port: {{ .Values.service.port }}
targetPort: http
protocol: TCP
name: http
selector:
{{- include "aztec-prover.selectorLabels" . | nindent 4 }}
13 changes: 13 additions & 0 deletions charts/aztec-prover/templates/serviceaccount.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{{- if .Values.serviceAccount.create -}}
apiVersion: v1
kind: ServiceAccount
metadata:
name: {{ include "aztec-prover.serviceAccountName" . }}
labels:
{{- include "aztec-prover.labels" . | nindent 4 }}
{{- with .Values.serviceAccount.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
{{- end }}
automountServiceAccountToken: {{ .Values.serviceAccount.automount }}
{{- end }}
Loading

0 comments on commit 3992ec9

Please sign in to comment.