Skip to content

Commit ccf42c0

Browse files
regelregel
committed
docs: run helm-docs
1 parent 7e052a9 commit ccf42c0

1 file changed

Lines changed: 9 additions & 30 deletions

File tree

‎charts/cardano/README.md‎

Lines changed: 9 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
11
# cardano
22

3-
![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.33.1](https://img.shields.io/badge/AppVersion-1.33.1-informational?style=flat-square)
3+
![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.35.4](https://img.shields.io/badge/AppVersion-1.35.4-informational?style=flat-square)
44

55
A Cardano Helm chart for Kubernetes
66

77
## Requirements
88

99
| Repository | Name | Version |
1010
|------------|------|---------|
11-
| https://charts.bitnami.com/bitnami | common | 1.8.0 |
12-
| https://charts.bitnami.com/bitnami | redis | 16.4.0 |
11+
| https://charts.bitnami.com/bitnami | common | 1.17.1 |
1312

1413
## Values
1514

1615
| Key | Type | Default | Description |
1716
|-----|------|---------|-------------|
18-
| admin | object | `{"pullPolicy":"IfNotPresent","repository":"inputoutput/cardano-node","tag":"1.33.1"}` | The admin pod is a special pod. This pod is air-gapped (nothing in, nothing out) and mounts cold keys from a Vault. Use this pod for admin operations such as KES key signature and node certificate signature |
17+
| admin | object | `{"pullPolicy":"IfNotPresent","repository":"inputoutput/cardano-node","tag":"1.35.4"}` | The admin pod is a special pod. This pod is air-gapped (nothing in, nothing out) and mounts cold keys from a Vault. Use this pod for admin operations such as KES key signature and node certificate signature |
1918
| busybox.pullPolicy | string | `"IfNotPresent"` | |
2019
| busybox.repository | string | `"busybox"` | |
2120
| busybox.tag | string | `"1.35.0"` | |
2221
| curl.pullPolicy | string | `"IfNotPresent"` | |
23-
| curl.repository | string | `"curlimages/curl"` | |
24-
| curl.tag | string | `"7.80.0"` | |
22+
| curl.repository | string | `"ghcr.io/regel/lz4"` | |
23+
| curl.tag | string | `"0.0.3"` | |
2524
| environment.name | string | `"testnet"` | name of the Cardano network to use. Either 'testnet' or 'mainnet' |
2625
| fullnameOverride | string | `""` | |
27-
| global.redis.servicePort | int | `6379` | |
2826
| global.storageClass | string | `nil` | Global StorageClass for Persistent Volume(s) |
2927
| image.pullPolicy | string | `"IfNotPresent"` | |
3028
| image.repository | string | `"inputoutput/cardano-node"` | |
31-
| image.tag | string | `"1.33.1"` | Overrides the image tag whose default is the chart appVersion. See [here](https://hub.docker.com/r/inputoutput/cardano-node/tags?page=1&ordering=last_updated) the full list of tags. |
29+
| image.tag | string | `"1.35.4"` | Overrides the image tag whose default is the chart appVersion. See [here](https://hub.docker.com/r/inputoutput/cardano-node/tags?page=1&ordering=last_updated) the full list of tags. |
3230
| imagePullSecrets | list | `[]` | |
3331
| liveness.pullPolicy | string | `"IfNotPresent"` | |
3432
| liveness.repository | string | `"alpine"` | |
@@ -63,22 +61,8 @@ A Cardano Helm chart for Kubernetes
6361
| ogmios.service.port | int | `1337` | |
6462
| ogmios.service.type | string | `"ClusterIP"` | |
6563
| ogmios.tag | string | `"latest"` | |
66-
| p2p | object | `{"clioEnabled":true,"debug":false,"ekgTimeout":5,"enabled":true,"ipVersion":4,"livenessProbe":{"enabled":true,"failureThreshold":1,"initialDelaySeconds":60,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1},"maxPeers":10,"probeTimeout":"1s","pullPolicy":"IfNotPresent","readinessProbe":{"enabled":true,"failureThreshold":10,"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1},"replicaCount":1,"repository":"regel/cardano-p2p","service":{"annotations":{},"port":8080,"type":"ClusterIP"},"tag":"v0.1.5","topic":"p2p"}` | P2P discovery configuration ref: https://github.com/regel/cardano-p2p |
67-
| p2p.clioEnabled | bool | `true` | Use 'clio' to push blockNo to the CLIO service |
64+
| p2p | object | `{"enabled":true}` | P2P discovery configuration |
6865
| p2p.enabled | bool | `true` | Enable peer to peer Cardano node discovery |
69-
| p2p.livenessProbe.enabled | bool | `true` | Enable livenessProbe on p2p node |
70-
| p2p.livenessProbe.failureThreshold | int | `1` | Failure threshold for livenessProbe |
71-
| p2p.livenessProbe.initialDelaySeconds | int | `60` | Initial delay seconds for livenessProbe |
72-
| p2p.livenessProbe.periodSeconds | int | `10` | Period seconds for livenessProbe |
73-
| p2p.livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe |
74-
| p2p.livenessProbe.timeoutSeconds | int | `1` | Timeout seconds for livenessProbe |
75-
| p2p.readinessProbe.enabled | bool | `true` | Enable readinessProbe on p2p nginx node |
76-
| p2p.readinessProbe.failureThreshold | int | `10` | Failure threshold for readinessProbe |
77-
| p2p.readinessProbe.initialDelaySeconds | int | `10` | Initial delay seconds for readinessProbe |
78-
| p2p.readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe |
79-
| p2p.readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe |
80-
| p2p.readinessProbe.timeoutSeconds | int | `1` | Timeout seconds for readinessProbe |
81-
| p2p.repository | string | `"regel/cardano-p2p"` | Repository of the cardano-p2p image ref: https://hub.docker.com/r/regel/cardano-p2p |
8266
| persistence.accessModes | list | `["ReadWriteOnce"]` | PVC Access Mode for data volume |
8367
| persistence.annotations | object | `{}` | Annotations for the PVC |
8468
| persistence.enabled | bool | `true` | Enable persistence using PVC |
@@ -94,11 +78,13 @@ A Cardano Helm chart for Kubernetes
9478
| podAnnotations."prometheus.io/port" | string | `"12789"` | |
9579
| podAnnotations."prometheus.io/scrape" | string | `"true"` | |
9680
| podSecurityContext.fsGroup | int | `65532` | |
81+
| podSecurityContext.runAsGroup | int | `65532` | |
9782
| podSecurityContext.runAsNonRoot | bool | `true` | |
9883
| podSecurityContext.runAsUser | int | `65532` | |
9984
| podSecurityContext.seccompProfile.type | string | `"RuntimeDefault"` | |
10085
| producer.affinity | object | `{}` | Affinity for Cardano producer pods assignment ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity NOTE: `master.podAffinityPreset`, `master.podAntiAffinityPreset`, and `master.nodeAffinityPreset` will be ignored when it's set |
10186
| producer.enabled | bool | `true` | |
87+
| producer.extraFlags | string | `""` | |
10288
| producer.livenessProbe | object | `{"enabled":true,"failureThreshold":1,"initialDelaySeconds":120,"periodSeconds":60,"successThreshold":1,"timeoutSeconds":5}` | Configure extra options for Cardano producer containers' liveness and readiness probes ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes |
10389
| producer.livenessProbe.enabled | bool | `true` | Enable livenessProbe on Cardano producer nodes |
10490
| producer.livenessProbe.failureThreshold | int | `1` | Failure threshold for livenessProbe |
@@ -134,13 +120,6 @@ A Cardano Helm chart for Kubernetes
134120
| producer.startupProbe.timeoutSeconds | int | `5` | Timeout seconds for startupProbe |
135121
| producer.terminationGracePeriodSeconds | int | `30` | Integer setting the termination grace period for the cardano-producer pods |
136122
| producer.tolerations | list | `[]` | master.tolerations Tolerations for Cardano producer pods assignment ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
137-
| redis.architecture | string | `"standalone"` | Single service exposed (redis-master) |
138-
| redis.auth.existingSecret | string | `"{{ .Release.Name }}-auth"` | name of an existing secret that contains all of the required secrets |
139-
| redis.master.persistence.enabled | bool | `false` | |
140-
| redis.networkPolicy.allowExternal | bool | `false` | |
141-
| redis.networkPolicy.enabled | bool | `true` | |
142-
| redis.replica.persistence.enabled | bool | `false` | |
143-
| redis.replica.replicaCount | int | `0` | |
144123
| relay.affinity | object | `{}` | Affinity for Cardano relay pods assignment ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity NOTE: `master.podAffinityPreset`, `master.podAntiAffinityPreset`, and `master.nodeAffinityPreset` will be ignored when it's set |
145124
| relay.extraFlags | string | `"+RTS -c -RTS"` | |
146125
| relay.livenessProbe | object | `{"enabled":true,"failureThreshold":5,"initialDelaySeconds":900,"periodSeconds":60,"successThreshold":1,"timeoutSeconds":1}` | Configure extra options for Cardano relay containers' liveness and readiness probes |

0 commit comments

Comments
 (0)