Skip to content

Commit 5792dcd

Browse files
authored
chore: Part 1 of Hiero migration for Helm Charts names and documents (#677)
Signed-off-by: Alfredo Gutierrez <[email protected]>
1 parent 18582c2 commit 5792dcd

24 files changed

+55
-29
lines changed

.github/workflows/helm-charts.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
run: |
5757
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
5858
helm repo add grafana https://grafana.github.io/helm-charts
59-
helm dependency update charts/hedera-block-node
59+
helm dependency update charts/block-node-server
6060
6161
- name: Run chart-testing (install)
6262
if: steps.list-changed.outputs.changed == 'true'

.github/workflows/release-push-image.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,12 @@ jobs:
166166
167167
- name: Package helm chart
168168
run: |
169-
helm dependency update charts/hedera-block-node
170-
helm package charts/hedera-block-node
169+
helm dependency update charts/block-node-server
170+
helm package charts/block-node-server
171171
172172
- name: Push helm chart
173173
run: |
174-
helm push block-node-helm-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hashgraph/hedera-block-node
174+
helm push block-node-helm-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hiero-ledger/hiero-block-node
175175
176176
- name: Simulator Chart - Package helm chart
177177
run: |
@@ -180,4 +180,4 @@ jobs:
180180
181181
- name: Simulator Chart - Push helm chart
182182
run: |
183-
helm push blockstream-simulator-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hashgraph/hedera-block-node
183+
helm push blockstream-simulator-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hiero-ledger/hiero-block-node
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# SPDX-License-Identifier: Apache-2.0
22
apiVersion: v2
33
appVersion: 0.5.0-SNAPSHOT
4-
description: A Helm chart for Hedera Block Node
5-
home: https://github.com/hashgraph/hedera-block-node
4+
description: A Helm chart for Hiero Block Node
5+
home: https://github.com/hiero-ledger/hiero-block-node
66
keywords:
77
- blocknode
88
- dlt
9+
- hiero
910
- hedera
1011
- hashgraph
1112
maintainers:
12-
- name: Hedera Block Node Team
13+
- name: Hiero Block Node Team
1314
1415
name: block-node-helm-chart
1516
sources:
16-
- https://github.com/hashgraph/hedera-block-node
17+
- https://github.com/hiero-ledger/hiero-block-node
1718
version: 0.5.0-SNAPSHOT
1819
dependencies:
1920
- name: kube-prometheus-stack
Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,57 @@
11
# Helm Chart
2+
23
Installs the Hedera Block Node on a Kubernetes cluster.
34

45
## Prerequisites
6+
57
- Helm 3+
68
- Kubernetes 1.29+
79

810
For Development and Test environment is recommended to use minikube with the following command (if want to deploy the kube-prometheus-stack for metrics visualization):
11+
912
```bash
1013
minikube delete && minikube start --kubernetes-version=v1.23.0 --memory=8g --bootstrapper=kubeadm --extra-config=kubelet.authentication-token-webhook=true --extra-config=kubelet.authorization-mode=Webhook --extra-config=scheduler.bind-address=0.0.0.0 --extra-config=controller-manager.bind-address=0.0.0.0
1114
```
1215

1316
Set environment variables that will be used for the remainder of the document:
14-
Replacing the values with the appropriate values for your environment: bn1 is short for block-node-1, but you can name you release as you wish. And use the version that you want to install.
17+
Replacing the values with the appropriate values for your environment: bn-release is short for block-node-release, but you can name you release as you wish. And use the version that you want to install.
18+
1519
```bash
16-
export RELEASE="blkNod"
17-
export VERSION="0.3.0-SNAPSHOT"
20+
export RELEASE="bn-release"
21+
export VERSION="0.4.0-SNAPSHOT"
1822
```
1923

2024
## Template
25+
2126
To generate the K8 manifest files without installing the chart, you need to clone this repo and navigate to `/charts` folder.
27+
2228
```bash
23-
helm template --name-template my-bn hedera-block-node/ --dry-run --output-dir out
29+
helm template --name-template bn-release block-node-server/ --dry-run --output-dir out
2430
```
2531

2632
## Install using a published chart
2733

2834
To pull the packaged chart from the public repo:
35+
2936
```bash
30-
helm pull oci://ghcr.io/hashgraph/hedera-block-node/block-node-helm-chart --version "${VERSION}"
37+
helm pull oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-helm-chart --version "${VERSION}"
3138
```
3239

3340
To install the chart with default values:
41+
3442
```bash
3543
helm install "${RELEASE}" hedera-block-node/charts/block-node-helm-chart-$VERSION.tgz
3644
```
3745

3846
To install the chart with custom values:
47+
3948
```bash
4049
helm install "${RELEASE}" hedera-block-node/charts/block-node-helm-chart-$VERSION.tgz -f <path-to-custom-values-file>
4150
```
4251

4352
*Note:* If using the chart directly after cloning the github repo, there is no need to add the repo. and install can be directly.
4453
Assuming you are at the root folder of the repo.
54+
4555
```bash
4656
helm dependency build charts/hedera-block-node
4757

@@ -54,40 +64,49 @@ There are several ways to configure the Hedera Block Node. The following is the
5464

5565
1. Create an override values file, `values.yaml`:
5666
2. Add the necessary environment configuration variables to the following section:
67+
5768
```yaml
58-
blockNode:
69+
blockNode:
5970
config:
6071
# Add any additional env configuration here
6172
# key: value
6273
BLOCKNODE_STORAGE_ROOT_PATH: "/app/storage"
63-
74+
6475
```
76+
6577
3. Secrets should be set at the following structure:
78+
6679
```yaml
6780
blockNode:
6881
secret:
69-
PRIVATE_KEY: "<Secret>"
82+
PRIVATE_KEY: "<Secret>"
7083
```
84+
7185
or passed at the command line:
86+
7287
```bash
7388
helm install "${RELEASE}" hedera-block-node/hedera-block-node --set blockNode.secret.PRIVATE_KEY="<Secret>"
7489
```
7590

7691
### Enable Prometheus + Grafana Stack
92+
7793
By default the stack includes a chart dependency that includes a prometheus + grafana + node-exporter stack, also adds 3 provisioned dashboards
78-
- **Hedera Block Node Dashboard:** to monitor the Hedera Block Node metrics, this are the server application specific metrics.
94+
- **Hedera Block Node Dashboard:** to monitor the Hedera Block Node metrics, this are the server application specific metrics.
7995
- **Node Exporter Full:** to monitor the node-exporter metrics, system metrics at the K8 cluster/node level.
8096
- **Kubernetes View Pods:** to monitor the kubernetes pods metrics, system metrics at the container level.
8197

8298
If you prefer to use your own prometheus+grafana stack, you can disable the stack by setting the following values:
99+
83100
```yaml
84101
kubepromstack:
85102
enabled: false
86103
```
87104
88105
### Enable Loki + Promtail
106+
89107
By default the stack includes chart dependencies for a loki + promtail stack, to collect logs from the Hedera Block Node and the K8 cluster.
90108
If you prefer to use your own loki+promtail stack, you can disable the stack by setting the following values:
109+
91110
```yaml
92111
loki:
93112
enabled: false
@@ -97,16 +116,21 @@ promtail:
97116
```
98117
99118
## Using
119+
100120
Follow the `NOTES` instructions after installing the chart to perform `port-forward` to the Hedera Block Node and be able to use it.
101121

102122
## Uninstall
123+
103124
To uninstall the chart:
125+
104126
```bash
105127
helm uninstall "${RELEASE}"
106128
```
107129

108130
## Upgrade
131+
109132
To upgrade the chart:
133+
110134
```bash
111135
# update the helm repo
112136
helm repo update

charts/hedera-block-node/dashboards/block-node-server.json renamed to charts/block-node-server/dashboards/block-node-server.json

File renamed without changes.

charts/hedera-block-node/dashboards/kubernetes-views-pods.json renamed to charts/block-node-server/dashboards/kubernetes-views-pods.json

File renamed without changes.

charts/hedera-block-node/dashboards/node-exporter-full.json renamed to charts/block-node-server/dashboards/node-exporter-full.json

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)