Skip to content

Commit

Permalink
Add READMEs to charts
Browse files Browse the repository at this point in the history
  • Loading branch information
AntiD2ta committed Feb 5, 2024
1 parent de141b7 commit 56479f9
Show file tree
Hide file tree
Showing 33 changed files with 3,687 additions and 3,257 deletions.
455 changes: 186 additions & 269 deletions charts/cert-manager/README.md

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions charts/common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# common

![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)

A Library Helm Chart for grouping common logic between stakewise charts. This chart is not deployable by itself.

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| matilote | | |
| aivarasko | | |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| exampleValue | string | `"common-chart"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
92 changes: 92 additions & 0 deletions charts/dirk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# dirk

![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v22.10.0](https://img.shields.io/badge/AppVersion-v22.10.0-informational?style=flat-square)

A Helm chart for installing and configuring large scale ETH staking infrastructure on top of the Kubernetes

**Homepage:** <https://stakewise.io/>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| matilote | | |
| aivarasko | | |

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| file://../common | common | 1.0.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | Affinity for pod assignment ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity |
| cliImage | object | `{"pullPolicy":"IfNotPresent","repository":"nethermindeth/keystores-cli","tag":"v1.0.0"}` | CLI image is used to fetch private keys. |
| dirk.clientName | string | `"client1"` | |
| dirk.fetchKeysExtraFlags | list | `[]` | |
| dirk.loglevel | string | `"Debug"` | |
| dirk.tracing | string | `nil` | |
| externalSecrets.dataFrom.key | string | `"dirk"` | |
| externalSecrets.enabled | bool | `false` | |
| externalSecrets.secretStoreRef.kind | string | `"SecretStore"` | |
| externalSecrets.secretStoreRef.name | string | `"secretStoreRef"` | |
| fullnameOverride | string | `""` | Provide a name to substitute for the full names of resources |
| global.podSecurityContext | object | `{"fsGroup":10000,"runAsNonRoot":true,"runAsUser":10000}` | Pod Security Context ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| global.securityContext.capabilities.drop[0] | string | `"ALL"` | |
| global.securityContext.fsGroup | int | `10000` | |
| global.securityContext.readOnlyRootFilesystem | bool | `true` | |
| global.securityContext.runAsNonRoot | bool | `true` | |
| global.securityContext.runAsUser | int | `10000` | |
| global.serviceAccount.create | bool | `true` | |
| httpPort | int | `8881` | Port on which dirk HTTP listens. |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"attestant/dirk"` | |
| image.tag | string | `"1.2.0"` | Overrides the image tag whose default is the chart appVersion. |
| imagePullSecrets | list | `[]` | |
| initImage | object | `{"pullPolicy":"IfNotPresent","repository":"bash","tag":"5.2"}` | Init image is used to chown data volume, etc. |
| livenessProbe.exec.command[0] | string | `"/bin/bash"` | |
| livenessProbe.exec.command[1] | string | `"/scripts/liveness_probe.sh"` | |
| livenessProbe.failureThreshold | int | `1` | |
| livenessProbe.periodSeconds | int | `90` | |
| loggingLevel | string | `"INFO"` | Sets logging verbosity. Log levels are OFF, FATAL, WARN, INFO, DEBUG, TRACE, ALL. |
| metricsPort | int | `9000` | The port (TCP) on which Prometheus accesses metrics |
| minReadySeconds | int | `10` | |
| nameOverride | string | `""` | Provide a name in place of operator for `app:` labels |
| nodeSelector | object | `{}` | Node labels for pod assignment ref: https://kubernetes.io/docs/user-guide/node-selection/ |
| persistence.accessModes[0] | string | `"ReadWriteOnce"` | |
| persistence.annotations | object | `{}` | |
| persistence.size | string | `"1Gi"` | |
| persistence.storageClassName | string | `""` | |
| podAnnotations | object | `{}` | |
| readinessProbe.enabled | bool | `true` | |
| readinessProbe.failureThreshold | int | `3` | |
| readinessProbe.httpGet.path | string | `"/metrics"` | |
| readinessProbe.httpGet.port | string | `"metrics"` | |
| readinessProbe.httpGet.scheme | string | `"HTTP"` | |
| readinessProbe.initialDelaySeconds | int | `10` | |
| readinessProbe.periodSeconds | int | `1` | |
| readinessProbe.successThreshold | int | `3` | |
| readinessProbe.timeoutSeconds | int | `3` | |
| replicaCount | int | `3` | |
| resources | object | `{}` | Configure resource requests and limits. ref: http://kubernetes.io/docs/user-guide/compute-resources/ |
| service.httpPort | int | `8881` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount | object | `{"annotations":{},"name":""}` | ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| 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 | object | `{"additionalLabels":{},"enabled":false,"honorLabels":false,"interval":"30s","metricRelabelings":[],"namespace":"","relabellings":[],"scrapeTimeout":""}` | Prometheus Service Monitor ref: https://github.com/coreos/prometheus-operator https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint |
| serviceMonitor.additionalLabels | object | `{}` | Additional labels that can be used so ServiceMonitor resource(s) can be discovered by Prometheus |
| serviceMonitor.enabled | bool | `false` | Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator |
| serviceMonitor.honorLabels | bool | `false` | Specify honorLabels parameter to add the scrape endpoint |
| serviceMonitor.interval | string | `"30s"` | The interval at which metrics should be scraped |
| serviceMonitor.metricRelabelings | list | `[]` | Metrics RelabelConfigs to apply to samples before ingestion. |
| serviceMonitor.namespace | string | `""` | The namespace in which the ServiceMonitor will be created |
| serviceMonitor.relabellings | list | `[]` | RelabelConfigs to apply to samples before scraping. |
| serviceMonitor.scrapeTimeout | string | `""` | The timeout after which the scrape is ended |
| tolerations | object | `{}` | Tolerations for pod assignment ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
108 changes: 54 additions & 54 deletions charts/dirk/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
global:
serviceAccount:
create: true
## Pod Security Context
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
##
# -- Pod Security Context
# ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
#
podSecurityContext:
runAsNonRoot: true
runAsUser: 10000
Expand All @@ -27,18 +27,18 @@ replicaCount: 3
image:
repository: attestant/dirk
pullPolicy: IfNotPresent
# Overrides the image tag whose default is the chart appVersion.
# -- Overrides the image tag whose default is the chart appVersion.
tag: "1.2.0"

## Init image is used to chown data volume, etc.
##
# -- Init image is used to chown data volume, etc.
#
initImage:
repository: bash
tag: "5.2"
pullPolicy: IfNotPresent

## CLI image is used to fetch private keys.
##
# -- CLI image is used to fetch private keys.
#
cliImage:
repository: nethermindeth/keystores-cli
tag: "v1.0.0"
Expand All @@ -61,24 +61,24 @@ dirk:

imagePullSecrets: []

## Provide a name in place of operator for `app:` labels
##
# -- Provide a name in place of operator for `app:` labels
#
nameOverride: ""

## Provide a name to substitute for the full names of resources
##
# -- Provide a name to substitute for the full names of resources
#
fullnameOverride: ""

## Sets logging verbosity.
## Log levels are OFF, FATAL, WARN, INFO, DEBUG, TRACE, ALL.
# -- Sets logging verbosity.
# Log levels are OFF, FATAL, WARN, INFO, DEBUG, TRACE, ALL.
loggingLevel: "INFO"

## Port on which dirk HTTP listens.
##
# -- Port on which dirk HTTP listens.
#
httpPort: 8881

## The port (TCP) on which Prometheus accesses metrics
##
# -- The port (TCP) on which Prometheus accesses metrics
#
metricsPort: 9000

readinessProbe:
Expand Down Expand Up @@ -111,12 +111,12 @@ livenessProbe:
failureThreshold: 1


## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
##
# -- ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
#
serviceAccount:
# Annotations to add to the service account
# -- Annotations to add to the service account
annotations: {}
# The name of the service account to use.
# -- The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: ""

Expand All @@ -126,9 +126,9 @@ service:
type: ClusterIP
httpPort: 8881

## Configure resource requests and limits.
## ref: http://kubernetes.io/docs/user-guide/compute-resources/
##
# -- Configure resource requests and limits.
# ref: http://kubernetes.io/docs/user-guide/compute-resources/
#
resources: {}
# We usually recommend not to specify default resources and to leave this as a conscious
# choice for the user. This also increases chances charts run on environments with little
Expand All @@ -141,47 +141,47 @@ resources: {}
# cpu: 100m
# memory: 128Mi

## Node labels for pod assignment
## ref: https://kubernetes.io/docs/user-guide/node-selection/
##
# -- Node labels for pod assignment
# ref: https://kubernetes.io/docs/user-guide/node-selection/
#
nodeSelector: {}

## Tolerations for pod assignment
## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
##
# -- Tolerations for pod assignment
# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
#
tolerations: {}

## Affinity for pod assignment
## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
##
# -- Affinity for pod assignment
# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
#
affinity: {}

## Prometheus Service Monitor
## ref: https://github.com/coreos/prometheus-operator
## https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
##
# -- Prometheus Service Monitor
# ref: https://github.com/coreos/prometheus-operator
# https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint
#
serviceMonitor:
## @param metrics.serviceMonitor.enabled Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator
##
# -- Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator
#
enabled: false
## @param metrics.serviceMonitor.namespace The namespace in which the ServiceMonitor will be created
##
# -- The namespace in which the ServiceMonitor will be created
#
namespace: ""
## @param metrics.serviceMonitor.interval The interval at which metrics should be scraped
##
# -- The interval at which metrics should be scraped
#
interval: 30s
## @param metrics.serviceMonitor.scrapeTimeout The timeout after which the scrape is ended
##
# -- The timeout after which the scrape is ended
#
scrapeTimeout: ""
## @param metrics.serviceMonitor.relabellings Metrics RelabelConfigs to apply to samples before scraping.
##
# -- RelabelConfigs to apply to samples before scraping.
#
relabellings: []
## @param metrics.serviceMonitor.metricRelabelings Metrics RelabelConfigs to apply to samples before ingestion.
##
# -- Metrics RelabelConfigs to apply to samples before ingestion.
#
metricRelabelings: []
## @param metrics.serviceMonitor.honorLabels Specify honorLabels parameter to add the scrape endpoint
##
# -- Specify honorLabels parameter to add the scrape endpoint
#
honorLabels: false
## @param metrics.serviceMonitor.additionalLabels Additional labels that can be used so ServiceMonitor resource(s) can be discovered by Prometheus
##
# -- Additional labels that can be used so ServiceMonitor resource(s) can be discovered by Prometheus
#
additionalLabels: {}
90 changes: 90 additions & 0 deletions charts/ethereum-node/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# ethereum-node

![Version: 0.0.20](https://img.shields.io/badge/Version-0.0.20-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

This chart acts as an umbrella chart and allows to run a ethereum execution and consensus layer client. It's also able to deploy optional monitoring applications.

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Manjeet | <[email protected]> | |
| Anish | <[email protected]> | |

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| https://ethpandaops.github.io/ethereum-helm-charts | nethermind | 1.0.9 |
| https://ethpandaops.github.io/ethereum-helm-charts | prysm | 1.1.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| ethereum-metrics-exporter.config.consensus.enabled | bool | `true` | |
| ethereum-metrics-exporter.config.consensus.name | string | `"consensus-client"` | |
| ethereum-metrics-exporter.config.consensus.url | string | `"{{ tpl .Values.global.main.beaconEndpoint . }}"` | |
| ethereum-metrics-exporter.config.execution.enabled | bool | `true` | |
| ethereum-metrics-exporter.config.execution.modules[0] | string | `"eth"` | |
| ethereum-metrics-exporter.config.execution.modules[1] | string | `"net"` | |
| ethereum-metrics-exporter.config.execution.modules[2] | string | `"web3"` | |
| ethereum-metrics-exporter.config.execution.name | string | `"execution-client"` | |
| ethereum-metrics-exporter.config.execution.url | string | `"{{ tpl .Values.global.main.rpcEndpoint . }}"` | |
| ethereum-metrics-exporter.enabled | bool | `false` | |
| ethereum-metrics-exporter.nameOverride | string | `"metrics-exporter"` | |
| global.checkpointSync.addresses.goerli | string | `"https://checkpoint-sync.goerli.ethpandaops.io"` | |
| global.checkpointSync.addresses.mainnet | string | `"https://mainnet-checkpoint-sync.attestant.io"` | |
| global.checkpointSync.addresses.sepolia | string | `"https://checkpoint-sync.sepolia.ethpandaops.io"` | |
| global.checkpointSync.enabled | bool | `true` | |
| global.clientArgs.networks.goerli.consensus.prysm[0] | string | `"--goerli"` | |
| global.clientArgs.networks.goerli.execution.nethermind[0] | string | `"--config=goerli"` | |
| global.clientArgs.networks.mainnet.consensus.prysm | list | `[]` | |
| global.clientArgs.networks.mainnet.execution.nethermind[0] | string | `"--Pruning.Mode=Hybrid"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[1] | string | `"--Pruning.FullPruningTrigger=VolumeFreeSpace"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[2] | string | `"--Pruning.FullPruningThresholdMb=256000"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[3] | string | `"--Pruning.AvailableSpaceCheckEnabled=false"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[4] | string | `"--Sync.NonValidatorNode=true"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[5] | string | `"--Sync.DownloadBodiesInFastSync=false"` | |
| global.clientArgs.networks.mainnet.execution.nethermind[6] | string | `"--Sync.DownloadReceiptsInFastSync=false"` | |
| global.clientArgs.networks.sepolia.consensus.prysm[0] | string | `"--sepolia"` | |
| global.clientArgs.networks.sepolia.execution.nethermind[0] | string | `"--config=sepolia"` | |
| global.main.beaconEndpoint | string | `"http://{{ .Release.Name }}-beacon:5052"` | |
| global.main.engineEndpoint | string | `"http://{{ .Release.Name }}-execution:8551"` | |
| global.main.env | string | `"staging"` | |
| global.main.network | string | `"mainnet"` | |
| global.main.rpcEndpoint | string | `"http://{{ .Release.Name }}-execution:8545"` | |
| global.secretStore.gcp.clusterLocation | string | `"dummy-cluster-location"` | |
| global.secretStore.gcp.clusterName | string | `"dummy-cluster-name"` | |
| global.secretStore.gcp.projectID | string | `"dummy-project-id"` | |
| global.secretStore.gcp.serviceAccountRef.name | string | `"dummy-service-account"` | |
| global.secretStore.gcp.serviceAccountRef.namespace | string | `"dummy-namespace"` | |
| global.secretStore.refreshInterval | string | `"10m"` | |
| global.secretStore.remoteRef.key | string | `"dummy-key"` | |
| global.secretStore.remoteRef.property | string | `"dummy-property"` | |
| global.secretStore.remoteRef.version | string | `"1"` | |
| nethermind.enabled | bool | `true` | |
| nethermind.extraArgs[0] | string | `"{{- with( index .Values.global.clientArgs.networks .Values.global.main.network ) }}\n {{- range $i, $v := .execution.nethermind }}\n {{- if (eq $i 0) }}\n {{- $v }}\n {{- else }}\n {{ $v }}\n {{- end }}\n {{- end -}}\n{{- end }}"` | |
| nethermind.httpPort | int | `8545` | |
| nethermind.nameOverride | string | `"execution"` | |
| nethermind.p2pPort | int | `30303` | |
| prysm.checkpointSync.enabled | string | `"{{ default .Values.global.checkpointSync.enabled false }}"` | |
| prysm.checkpointSync.url | string | `"{{ index .Values.global.checkpointSync.addresses .Values.global.main.network }}"` | |
| prysm.enabled | bool | `true` | |
| prysm.extraArgs[0] | string | `"--execution-endpoint={{ tpl .Values.global.main.engineEndpoint . }} {{- with( index .Values.global.clientArgs.networks .Values.global.main.network ) }}\n {{- range .consensus.prysm }}\n {{ . }}\n {{- end -}}\n{{- end -}}"` | |
| prysm.httpPort | int | `5052` | |
| prysm.nameOverride | string | `"beacon"` | |
| prysm.p2pPort | int | `9000` | |
| prysm.persistence.accessModes | list | `["ReadWriteOnce"]` | Use an existing PVC when persistence.enabled |
| prysm.persistence.annotations | object | `{}` | Annotations for volume claim template |
| prysm.persistence.enabled | bool | `true` | Uses an EmptyDir when not enabled |
| prysm.persistence.selector | object | `{}` | Selector for volume claim template |
| prysm.persistence.size | string | `"100Gi"` | Requested size for volume claim template |
| prysm.persistence.storageClassName | string | `"standard-rwo"` | Use a specific storage class E.g 'local-path' for local storage to achieve best performance Read more (https://github.com/rancher/local-path-provisioner) |
| prysm.resources.limits.cpu | int | `4` | |
| prysm.resources.limits.memory | string | `"4Gi"` | |
| prysm.resources.requests.cpu | int | `2` | |
| prysm.resources.requests.memory | string | `"2Gi"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
Loading

0 comments on commit 56479f9

Please sign in to comment.