Skip to content

Commit

Permalink
DOC: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
omidasadpour committed Mar 14, 2024
1 parent 4270e31 commit 90f8262
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions charts/rollups-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Package for Cartesi Rollups Nodes

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

Refer to the [official documentation](https://docs.cartesi.io/cartesi-rollups/overview/) for more information about Cartesi Rollups.

Expand Down Expand Up @@ -70,7 +70,7 @@ The command removes all the Kubernetes components associated with the chart and
| extraDeploy | list | `[]` | Array of extra objects to deploy with the release |
| fullnameOverride | string | `""` | String to fully override name |
| global.image.registry | string | `"docker.io"` | Global Docker image registry |
| global.image.tag | string | `"1.3.0"` | Global Docker Image tag |
| global.image.tag | string | `"1.3.1"` | Global Docker Image tag |
| image.pullPolicy | string | `"Always"` | Pullpolicy for Docker Images |
| image.pullSecrets | list | `[]` | Cartesi Rollups Validator Nodes pull secrets |
| ingress.addReleaseNameAsHost | bool | `false` | dditional rules[].host |
Expand Down Expand Up @@ -104,6 +104,8 @@ The command removes all the Kubernetes components associated with the chart and
| validator.config.CARTESI_CONTRACTS_INPUT_BOX_ADDRESS | string | `""` | Address of the InputBox contract. |
| validator.config.CARTESI_CONTRACTS_INPUT_BOX_DEPLOYMENT_BLOCK_NUMBER | string | `""` | The deployment block for the input box contract. The node will begin to read blockchain events from this block. |
| validator.config.CARTESI_EPOCH_DURATION | string | `"86400"` | Duration of a rollups epoch in seconds. At the end of each epoch, the node will send claims to the blockchain. |
| validator.config.CARTESI_EXPERIMENTAL_DISABLE_CONFIG_LOG | string | `"false"` | Disables all log entries related to the node's configuration |
| validator.config.CARTESI_EXPERIMENTAL_SERVER_MANAGER_BYPASS_LOG | string | `"false"` | When enabled, prints server-manager output to stdout and stderr directly. All other log configurations are ignored. |
| validator.config.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_ENABLED | string | `"false"` | When enabled, the node does not start the authority-claimer service and the Redis server. |
| validator.config.CARTESI_EXPERIMENTAL_SUNODO_VALIDATOR_REDIS_ENDPOINT | string | `""` | External Redis endpoint for the node when running in the experimental sunodo validator mode. |
| validator.config.CARTESI_FEATURE_DISABLE_CLAIMER | string | `"false"` | If set to true, the node will not make claims. |
Expand Down Expand Up @@ -160,4 +162,4 @@ Cartesi will release a new chart updating its containers if a new version of the
This chart allows you to set your custom affinity. Find more information about Pod's affinity in the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity).

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

0 comments on commit 90f8262

Please sign in to comment.