From 4d21199960db111031fe0b0185782ab9b753d47b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20J=C4=99drzejewski?= Date: Thu, 17 Oct 2024 17:26:07 +0200 Subject: [PATCH 1/2] fix release of helm docs --- .github/workflows/helm-docs.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml index aca3e5f..62b65a8 100644 --- a/.github/workflows/helm-docs.yaml +++ b/.github/workflows/helm-docs.yaml @@ -14,14 +14,13 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 with: - persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token fetch-depth: 0 - name: Set up Docker uses: docker/setup-buildx-action@v2 - name: Run helm-docs - run: docker run --rm -v $(pwd):/helm-docs jnorwood/helm-docs:v1.14.2 --chart-search-root=. --template-files=./.github/helm-docs/_templates.gotmpl --template-files=README.md.gotmpl + run: docker run --rm -v $(pwd):/helm-docs jnorwood/helm-docs:v1.14.2 --chart-search-root=charts --template-files=./.github/helm-docs/_templates.gotmpl --template-files=README.md.gotmpl - name: Commit & Push changes uses: actions-js/push@master From a1044513dbcfb96a5593b1bc45c9a8ef76e72f18 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 17 Oct 2024 15:26:49 +0000 Subject: [PATCH 2/2] docs: auto-generate chart docs --- charts/jrpc-interceptor/README.md | 40 +++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 charts/jrpc-interceptor/README.md diff --git a/charts/jrpc-interceptor/README.md b/charts/jrpc-interceptor/README.md new file mode 100644 index 0000000..8e194a6 --- /dev/null +++ b/charts/jrpc-interceptor/README.md @@ -0,0 +1,40 @@ +# jrpc-interceptor + +![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) ![AppVersion: main](https://img.shields.io/badge/AppVersion-main-informational?style=flat-square) + +A Helm chart for the JRPC Interceptor application + +## Maintainers + +| Name | Email | Url | +| ---- | ------ | --- | +| Nethermind | | | + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env.LOG_SERVER_DEBUG | string | `"true"` | | +| env.SERVICE_TO_PROXY | string | `"op-fullnode-op-execution:8545"` | | +| env.USE_PROMETHEUS | string | `"true"` | | +| host | string | `"0.0.0.0"` | | +| image.pullPolicy | string | `"Always"` | | +| image.repository | string | `"ghcr.io/nethermindeth/jrpc-interceptor"` | | +| image.tag | string | `"main"` | | +| ports.http | int | `8081` | | +| ports.logServer | int | `514` | | +| ports.metrics | int | `9120` | | +| replicaCount | int | `1` | | +| resources.limits.cpu | string | `"100m"` | | +| resources.limits.memory | string | `"128Mi"` | | +| resources.requests.cpu | string | `"100m"` | | +| resources.requests.memory | string | `"128Mi"` | | +| service.type | string | `"ClusterIP"` | | +| serviceMonitor.additionalLabels | object | `{}` | | +| serviceMonitor.enabled | bool | `true` | | +| serviceMonitor.interval | string | `"15s"` | | +| serviceMonitor.namespace | string | `""` | | +| serviceMonitor.scrapeTimeout | string | `"10s"` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)