Skip to content

Commit 4764ce4

Browse files
committed
chore(docs): update README with Helm chart installation instructions and deployment modes
1 parent 1568ff4 commit 4764ce4

2 files changed

Lines changed: 26 additions & 5 deletions

File tree

.github/workflows/qa.yml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -270,16 +270,24 @@ jobs:
270270
${{ steps.secret-scan.outcome == 'success' && 'success' || 'failure'
271271
}}
272272

273-
- name: Publish Helm charts to GitHub Pages
273+
# Publish charts via Helm chart-releaser so gh-pages stays in sync with tagged releases
274+
- name: Configure git author for chart releaser
274275
if: |
275276
github.event_name == 'push' &&
276277
startsWith(github.ref, 'refs/tags/')
277-
uses: stefanprodan/helm-gh-pages@0ad2bb377311d61ac04ad9eb6f252fb68e207260 # v1.7.0
278+
run: |
279+
git config user.name "SettleMint Release Bot"
280+
git config user.email "support@settlemint.com"
281+
282+
- name: Publish Helm charts with chart-releaser
283+
if: |
284+
github.event_name == 'push' &&
285+
startsWith(github.ref, 'refs/tags/')
286+
uses: helm/chart-releaser-action@v1.7.0
287+
env:
288+
CR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
278289
with:
279-
token: ${{ secrets.GITHUB_TOKEN }}
280290
charts_dir: charts
281-
commit_username: SettleMint Release Bot
282-
commit_email: support@settlemint.com
283291

284292
# Check PR review status (PR and PR review events only)
285293
- name: Check PR review status

README.tpl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,19 @@ Generate node identities, configure consensus, and emit a Besu genesis.
66

77
The helm chart to run this on Kubernetes / OpenShift can be found [here](./charts/network-bootstrapper/README.md)
88

9+
### Install from GitHub Pages
10+
11+
The published chart repository lives at `https://settlemint.github.io/network-bootstrapper/`. Add it to Helm, sync indexes, and install the `network` chart:
12+
13+
```bash
14+
helm repo add network-bootstrapper https://settlemint.github.io/network-bootstrapper/
15+
helm repo update
16+
17+
helm upgrade --install besu-network network-bootstrapper/network \
18+
--namespace besu \
19+
--create-namespace
20+
```
21+
922
### Deployment modes
1023

1124
Two deployment paths are supported: fully auto-generated artefacts or supplying your own genesis/static peers while sourcing node keys from an external secret store such as Conjur.

0 commit comments

Comments
 (0)