set the default chainPath for common chains (kusama, westend, rococo)

Author: PierreBesson

charts/node/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: node
 description: A Helm chart to deploy Substrate/Polkadot nodes
 type: application
-version: 5.5.2
+version: 5.6.0
 maintainers:
   - name: Parity
     url: https://github.com/paritytech/helm-charts

charts/node/README.md.gotmpl

@@ -31,35 +31,6 @@ helm install polkadot-node parity/node
 
 This will deploy a single Polkadot node with the default configuration.
 
-### Public snapshots
-You can use the following public URLs to download chain snapshots:
-- https://snapshots.polkadot.io/polkadot-paritydb-prune
-- https://snapshots.polkadot.io/polkadot-rocksdb-prune
-- https://snapshots.polkadot.io/polkadot-rocksdb-archive
-- https://snapshots.polkadot.io/kusama-paritydb-prune
-- https://snapshots.polkadot.io/kusama-rocksdb-prune
-- https://snapshots.polkadot.io/kusama-rocksdb-archive
-- https://snapshots.polkadot.io/westend-paritydb-archive
-- https://snapshots.polkadot.io/westend-paritydb-prune
-- https://snapshots.polkadot.io/westend-rocksdb-prune
-- https://snapshots.polkadot.io/westend-rocksdb-archive
-- https://snapshots.polkadot.io/westend-collectives-rocksdb-archive
-
-For example, to restore Polkadot pruned snapshot running ParityDB, configure chart values like the following:
-```yaml
-node:
-  chain: polkadot
-  role: full
-  chainData:
-    chainSnapshot:
-      enabled: true
-      method: http-filelist
-      url: https://snapshots.polkadot.io/polkadot-paritydb-prune
-    pruning: 256
-```
-
-Polkadot and Kusama backups are pruned at 256 blocks. Westend backups are pruned at 1000 blocks.
-
 ### Resizing the node disk
 
 To resize the node persistent volume, perform the following steps:

charts/node/templates/_helpers.tpl

@@ -37,7 +37,7 @@ Common labels
 helm.sh/chart: {{ include "node.chart" . }}
 {{ include "node.selectorLabels" . }}
 {{ include "node.serviceLabels" . }}
-app.kubernetes.io/version: {{ .Values.image.tag | quote }}
+app.kubernetes.io/version: {{ .Chart.Version | quote }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- if or .Values.node.chainData.pruning ( not ( kindIs "invalid" .Values.node.chainData.pruning ) ) }}
 {{- if ge ( int .Values.node.chainData.pruning ) 1 }}
@@ -94,6 +94,36 @@ Create the database path depending on the database backend in use (rocksdb or pa
 {{- end }}
 {{- end }}
 
+{{/*
+Set directory path for known chains
+*/}}
+{{- define "node.chainPath" -}}
+{{- if eq .Values.node.chain "kusama" -}}
+ksmcc3
+{{- else if eq .Values.node.chain "rococo" -}}
+rococo_v2_2
+{{- else if eq .Values.node.chain "westend" -}}
+westend2
+{{- else -}}
+{{- .Values.node.chain -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Set directory path for known relaychains
+*/}}
+{{- define "node.collatorRelayChainPath" -}}
+{{- if eq .Values.node.collatorRelayChain.chain "kusama" -}}
+ksmcc3
+{{- else if eq .Values.node.collatorRelayChain.chain "rococo" -}}
+rococo_v2_2
+{{- else if eq .Values.node.collatorRelayChain.chain "westend" -}}
+westend2
+{{- else -}}
+{{- .Values.node.collatorRelayChain.chain -}}
+{{- end -}}
+{{- end -}}
+
 {{/*
 Define a regex matcher to check if the passed node flags are managed by the chart already
 */}}

charts/node/templates/statefulset.yaml

@@ -2,6 +2,8 @@
 {{ $selectorLabels :=  include "node.selectorLabels" . }}
 {{ $serviceLabels :=  include "node.serviceLabels" .  }}
 {{ $serviceAccountName :=  include "node.serviceAccountName" . }}
+{{ $chainPath := include "node.chainPath" . }}
+{{ $collatorRelayChainPath := include "node.collatorRelayChainPath" . }}
 {{ $databasePath := include "node.databasePath" . }}
 {{ $chartManagedFlagsRegex := include "node.chartManagedFlagsRegex" . }}
 apiVersion: apps/v1
@@ -138,7 +140,7 @@ spec:
               fi
           env:
             - name: CHAIN_PATH
-              value: {{ default .Values.node.chain .Values.node.chainData.chainPath }}
+              value: {{ default $chainPath .Values.node.chainData.chainPath }}
             - name: METHOD
               value: {{ .Values.node.chainData.chainSnapshot.method }}
             {{- with .Values.initContainers.downloadChainSnapshot.extraEnvVars }}
@@ -207,7 +209,7 @@ spec:
               fi
           env:
             - name: RELAY_CHAIN_PATH
-              value: {{ default .Values.node.collatorRelayChain.chain .Values.node.collatorRelayChain.chainData.chainPath }}
+              value: {{ default $collatorRelayChainPath .Values.node.collatorRelayChain.chainData.chainPath }}
             - name: METHOD
               value: {{ .Values.node.collatorRelayChain.chainData.chainSnapshot.method }}
             {{- with .Values.initContainers.downloadChainSnapshot.extraEnvVars }}

charts/node/values.yaml

@@ -10,9 +10,9 @@ extraLabels: {}
 # -- Image of Polkadot Node.
 image:
   # -- Image repository
-  repository: parity/polkadot
+  repository:
   # -- Image tag
-  tag: latest
+  tag:
   # -- Image pull policy
   pullPolicy: Always
   # -- Adds `-x` shell option to container.
@@ -147,7 +147,6 @@ ingress:
   #    hosts:
   #      - chart-example.local
 
-
 # -- Deploy a substrate node.
 # ref: https://docs.substrate.io/tutorials/v3/private-network/
 node:
@@ -168,7 +167,6 @@ node:
     # -- Can be an int or a %
     maxUnavailable: 1
 
-
   # -- Node may require custom name for chainspec file.
   # ref:  moonbeam https://github.com/PureStake/moonbeam/issues/1104#issuecomment-996787548
   # Note: path should start with /chain-data/ since this folder mount in init container download-chainspec.
@@ -192,7 +190,7 @@ node:
     chainPath:
     # -- Storage class to use for persistent volume
     storageClass: ""
-    # -- Size of the volume for chain data
+    # -- Size of the chain data volume
     volumeSize: 100Gi
     # -- Annotations to add to the volumeClaimTemplates
     annotations: {}
@@ -202,7 +200,7 @@ node:
       # -- Enable chain snapshot restoration
       enabled: false
       # -- Restoration method. One of: gcs, s3, http-single-tar, http-single-tar-lz4, http-filelist
-      method: gcs
+      method: http-filelist
       # -- A URL to download chain backup
       url: ""
       # -- A remote file name containing names of DB file chunks. Appended to `url`
@@ -367,7 +365,7 @@ node:
       # secretName: existing-node-secret
       # secretKey: my-node-key
 
-  # -- Component to inject secrets via annotation of Hashicorp Vault
+  # -- Inject secrets via Hashicorp Vault annotations
   # ref: https://www.vaultproject.io/docs/platform/k8s/injector/annotations
   vault:
     # -- Configures the authentication path for the Kubernetes auth method
@@ -404,9 +402,9 @@ node:
       # vaultKey: key
       # vaultKeyAppendPodIndex: false
 
-  # -- If enabled, generate a persistent volume to use for the keys
+  # -- If enabled, generate and persist a node-key in the keystore volume
   persistGeneratedNodeKey: false
-  # -- Name of the secret containig the key
+  # -- Node key secret string (this option should be limited to development and testing as it will leak the node key secret in the helm config)
   customNodeKey:
 
   # -- Expose metrics via Prometheus format in /metrics endpoint.