Skip to content

Commit 9cc805e

Browse files
docs(README): Fix StyleCheck CI Gate check.
Signed-off-by: Pranali Deshmukh <pranali.deshmukh@swirldslabs.com>
1 parent 196a25e commit 9cc805e

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

charts/block-node-server/README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ Installs the Hiero Block Node on a Kubernetes cluster.
1212
For development and test environments, it is recommended to use [minikube](https://minikube.sigs.k8s.io/docs/start/).
1313

1414
### Basic minikube setup
15+
1516
```bash
1617
minikube delete && minikube start --kubernetes-version=v1.29.0
1718
```
1819

1920
### minikube setup with monitoring support
2021

2122
If you want to deploy the `kube-prometheus-stack` for metrics visualization:
23+
2224
```bash
2325
minikube delete && minikube start \
2426
--kubernetes-version=v1.29.0 \
@@ -33,10 +35,12 @@ minikube delete && minikube start \
3335
## Configuration
3436

3537
Set environment variables that will be used throughout this guide. Replace the values with appropriate values for your environment:
38+
3639
```bash
3740
export RELEASE="bn-release" # bn-release is short for block-node-release
3841
export VERSION="0.24.0-SNAPSHOT"
3942
```
43+
4044
## Installation Options
4145

4246
### Option 1: Template (without installing)
@@ -46,23 +50,27 @@ To generate Kubernetes manifest files without installing the chart:
4650
1. Clone this repository
4751
2. Navigate to the `/charts` folder
4852
3. Run the following command:
53+
4954
```bash
5055
helm template --name-template bn-release block-node-server/ --dry-run --output-dir out
5156
```
5257

5358
### Option 2: Install using a published chart
5459

5560
#### Pull the packaged chart
61+
5662
```bash
5763
helm pull oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server --version "${VERSION}"
5864
```
5965

6066
#### Install with default values
67+
6168
```bash
6269
helm install "${RELEASE}" block-node-server-$VERSION.tgz
6370
```
6471

6572
#### Install with custom values
73+
6674
```bash
6775
helm install "${RELEASE}" block-node-server-$VERSION.tgz -f <path-to-custom-values-file>
6876
```
@@ -72,11 +80,13 @@ helm install "${RELEASE}" block-node-server-$VERSION.tgz -f <path-to-custom-valu
7280
*Note:* There is no need to add the repo, If using the chart directly after cloning the GitHub repository. Assuming you are at the root folder of the repository:
7381

7482
1. Build dependencies:
83+
7584
```bash
7685
helm dependency build charts/block-node-server
7786
```
7887

7988
2. Install the chart:
89+
8090
```bash
8191
helm install "${RELEASE}" charts/block-node-server -f <path-to-custom-values-file>
8292
```
@@ -149,55 +159,58 @@ Follow the `NOTES` instructions after installing the chart to perform `port-forw
149159
To upgrade the chart to a new version from the OCI registry:
150160

151161
1. Set the new version:
162+
152163
```bash
153-
export VERSION="<new-version>"
164+
export VERSION="<new-version>"
154165
```
155166

156167
2. Save your current configuration:
168+
157169
```bash
158-
helm get values "${RELEASE}" > user-values.yaml
170+
helm get values "${RELEASE}" > user-values.yaml
159171
```
160172

161173
3. Upgrade the release directly from OCI registry:
174+
162175
```bash
163-
helm upgrade "${RELEASE}" oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server --version "${VERSION}" -f user-values.yaml
176+
helm upgrade "${RELEASE}" oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server --version "${VERSION}" -f user-values.yaml
164177
```
165178

166179
### Upgrade using a local chart
167180

168181
To upgrade the chart from a local `.tgz` file or cloned repository:
169182

170183
1. If using a downloaded `.tgz` file, ensure you have the new version locally. If using a cloned repository, pull the latest changes:
184+
171185
```bash
172-
git pull origin main
173-
helm dependency build charts/block-node-server
186+
git pull origin main
187+
helm dependency build charts/block-node-server
174188
```
175189

176190
2. Save your current configuration:
191+
177192
```bash
178-
helm get values "${RELEASE}" > user-values.yaml
193+
helm get values "${RELEASE}" > user-values.yaml
179194
```
180195

181196
3. Upgrade the release from local chart:
197+
182198
```bash
183-
# If using a .tgz file:
184-
helm upgrade "${RELEASE}" block-node-server-$VERSION.tgz -f user-values.yaml
185-
186-
# If using cloned repository:
187-
helm upgrade "${RELEASE}" charts/block-node-server -f user-values.yaml
199+
# If using a .tgz file:
200+
helm upgrade "${RELEASE}" block-node-server-$VERSION.tgz -f user-values.yaml
201+
# If using cloned repository:
202+
helm upgrade "${RELEASE}" charts/block-node-server -f user-values.yaml
188203
```
189204

190-
191-
192205
## Uninstall
193206

194207
To uninstall the chart:
195208

196209
```bash
197210
helm uninstall "${RELEASE}"
198211
```
199-
This will remove all Kubernetes resources associated with the release.
200212

213+
This will remove all Kubernetes resources associated with the release.
201214

202215
## Troubleshooting
203216

@@ -206,11 +219,13 @@ This section covers common issues you may encounter when working with the Hiero
206219
### Chart Dependencies Missing
207220

208221
**When running:**
222+
209223
```bash
210224
helm template --name-template bn-release block-node-server/ --dry-run --output-dir out
211225
```
212226

213227
**Error:**
228+
214229
```
215230
Error: An error occurred while checking for chart dependencies. You may need to run `helm dependency build` to fetch missing dependencies: found in Chart.yaml, but missing in charts/ directory: kube-prometheus-stack, loki, promtail
216231
Error: Chart.yaml file is missing
@@ -219,6 +234,7 @@ Error: Chart.yaml file is missing
219234
**Solution:**
220235
221236
Before running the template command, build the chart dependencies:
237+
222238
```bash
223239
helm dependency build charts/block-node-server
224240
```
@@ -230,16 +246,19 @@ This will download all required chart dependencies to the `charts/` directory.
230246
### Chart Version Not Found in Registry
231247

232248
**When running:**
249+
233250
```bash
234251
helm pull oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-helm-chart --version "${VERSION}"
235252
```
236253

237254
**Error:**
255+
238256
```
239257
Error: failed to perform "fetchReference" on source: ghcr.io/hiero-ledger/hiero-block-node/block-node-helm-chart:0.22.8-SNAPSHOT: not found
240258
```
241259

242260
or
261+
243262
```
244263
Error: failed to perform "fetchReference" on source: ghcr.io/hiero-ledger/hiero-block-node/block-node-helm-chart:0.21.2: not found
245264
```
@@ -251,13 +270,15 @@ The specified chart version or name does not exist in the registry, or the OCI r
251270
**Solution:**
252271

253272
1. Use the correct OCI registry path:
273+
254274
```bash
255-
helm pull oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server --version "${VERSION}"
275+
helm pull oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server --version "${VERSION}"
256276
```
257277

258278
2. Verify the chart version exists by checking the [releases page](https://github.com/hiero-ledger/hiero-block-node/releases)
259279

260280
3. Confirm your `VERSION` environment variable is set to a valid release:
281+
261282
```bash
262-
echo $VERSION
283+
echo $VERSION
263284
```

0 commit comments

Comments
 (0)