Skip to content

Commit 84e468b

Browse files
committed
chore(docs): update README and template to reflect changes in Helm chart installation from GitHub Pages to GHCR
1 parent d2e4b6d commit 84e468b

2 files changed

Lines changed: 16 additions & 10 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,22 @@ Generate node identities, configure consensus, and emit a Besu genesis. Then use
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
9+
### Install from GHCR
1010

11-
The published chart repository lives at `https://settlemint.github.io/network-bootstrapper/`. Add it to Helm, sync indexes, and install the `network` chart:
11+
Charts are published as OCI artifacts at `oci://ghcr.io/settlemint/network-bootstrapper`. Install directly from the registry by referencing the desired release tag:
1212

1313
```bash
14-
helm repo add network-bootstrapper https://settlemint.github.io/network-bootstrapper/
15-
helm repo update
14+
VERSION="0.1.0" # replace with the release you need
1615

17-
helm upgrade --install besu-network network-bootstrapper/network \
16+
helm upgrade --install besu-network \
17+
oci://ghcr.io/settlemint/network-bootstrapper/network \
18+
--version "${VERSION}" \
1819
--namespace besu \
1920
--create-namespace
2021
```
2122

23+
Use `helm show chart oci://ghcr.io/settlemint/network-bootstrapper/network --version <tag>` to inspect metadata before installing.
24+
2225
### Deployment modes
2326

2427
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.

README.tpl

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,22 @@ Generate node identities, configure consensus, and emit a Besu genesis. Then use
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
9+
### Install from GHCR
1010

11-
The published chart repository lives at `https://settlemint.github.io/network-bootstrapper/`. Add it to Helm, sync indexes, and install the `network` chart:
11+
Charts are published as OCI artifacts at `oci://ghcr.io/settlemint/network-bootstrapper`. Install directly from the registry by referencing the desired release tag:
1212

1313
```bash
14-
helm repo add network-bootstrapper https://settlemint.github.io/network-bootstrapper/
15-
helm repo update
14+
VERSION="0.1.0" # replace with the release you need
1615

17-
helm upgrade --install besu-network network-bootstrapper/network \
16+
helm upgrade --install besu-network \
17+
oci://ghcr.io/settlemint/network-bootstrapper/network \
18+
--version "${VERSION}" \
1819
--namespace besu \
1920
--create-namespace
2021
```
2122

23+
Use `helm show chart oci://ghcr.io/settlemint/network-bootstrapper/network --version <tag>` to inspect metadata before installing.
24+
2225
### Deployment modes
2326

2427
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)