Skip to content

Commit 1a6b16a

Browse files
docs(solo-weaver): update to block node install and add new v0.3.0 command options
Signed-off-by: Pranali Deshmukh <[email protected]>
1 parent 6e420c9 commit 1a6b16a

File tree

1 file changed

+59
-30
lines changed

1 file changed

+59
-30
lines changed

docs/block-node/operations/solo-weaver-single-node-k8s-deployment.md

Lines changed: 59 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Solo Weaver Single Node Kubernetes Deployment Guide
22

3-
# Overview
3+
## Overview
44

55
This guide explains how to deploy the Hiero Block Node on a Google Cloud Platform (GCP) virtual machine (VM) using the Solo Weaver tool.
66
The Block Node supports the Hiero network by processing and validating consensus node produced blocks amongst others features.
@@ -10,7 +10,7 @@ This guide walks you through creating the VM, uploading the Weaver binary to it,
1010

1111
While this guide focuses on GCP, node operators can deploy the Block Node on any cloud provider of their choice by following equivalent provisioning and deployment steps.
1212

13-
# Prerequisites
13+
## Prerequisites
1414

1515
Before you begin, ensure you have:
1616

@@ -20,9 +20,9 @@ Before you begin, ensure you have:
2020
- **`weaver-linux-arm64`** for ARM-based VMs.
2121
- The **`gcloud`** CLI installed and authenticated (if using Google Cloud).
2222

23-
# Step-by-Step Guide
23+
## Step-by-Step Guide
2424

25-
## Step 1: Create a Google Cloud VM
25+
### Step 1: Create a Google Cloud VM
2626

2727
1. In the [**Google Cloud Console**](https://console.cloud.google.com/), click **Select a project** at the top of the page.
2828
2. Choose an existing project. If you don’t have a project, click **New project** in the popup window and follow the prompts to create one.
@@ -36,7 +36,7 @@ Before you begin, ensure you have:
3636
8. Click **Create** to launch the VM.
3737
9. Wait until the instance status is **Running** before proceeding.
3838

39-
## Step 2: Upload Weaver to the VM
39+
### Step 2: Upload Weaver to the VM
4040

4141
1. Download the appropriate Weaver binary to your local machine (see [Prerequisites](https://www.notion.so/Hiero-Block-Node-Cloud-Deployment-Guide-2b77c9ab259180fa9cc0e111cf9f77d0?pvs=21) for the correct file).
4242
2. In the Google Cloud Console, open your VM’s details page.
@@ -60,7 +60,7 @@ Before you begin, ensure you have:
6060
7. Run the command to upload the file.
6161
8. When complete, the Weaver binary will be available on your VM at the specified path. (e.g., at **`/home/<USER>/weaver`).**
6262

63-
## Step 3: Connect to VM and Prepare Weaver
63+
### Step 3: Connect to VM and Prepare Weaver
6464

6565
1. SSH into your VM:
6666
- Use the **SSH** button in the Google Cloud Console (browser window), or
@@ -88,29 +88,60 @@ Before you begin, ensure you have:
8888

8989
If the binary runs and prints usage or help text, Weaver is correctly installed on the VM.
9090

91-
## Step 4: Create the **`weaver`** User
91+
### Step 4: Create the **`weaver`** User
9292

93-
1. Run the Block Node setup command with **`sudo`** and the desired profile (choose one of: **`local`****`testnet`****`previewnet`****`mainnet`**):
93+
1. Run the Block Node install command with **`sudo`** and the desired profile (choose one of: **`local`****`testnet`****`previewnet`****`mainnet`**):
9494

9595
```bash
96-
sudo ./weaver-linux-amd64 blocknode setup -p <profile>
96+
sudo ./weaver-linux-amd64 block node install -p <profile>
9797
```
9898

99-
*(Replace **`<profile>`** with the desired value, e.g., **`local`** for test deployments. For ARM, use **`weaver-linux-arm64`** instead.)*
99+
*(Replace **`<profile>`** with the desired value. For ARM, use **`weaver-linux-arm64`** instead.)*
100100

101-
2. The command will fail and print instructions to create **`weaver`** system user and group.
101+
2. The first run will fail and print instructions to create the **`weaver`** system user and group with specific UID/GID.
102102

103103
- Copy the **`groupadd`** and **`useradd`** commands shown in the output.
104104
- Run them exactly as printed, including specific user/group ID numbers.
105105
3. After creating the **`weaver`** user and group, re-run the setup command:
106106

107107
```bash
108-
sudo ./weaver-linux-amd64 blocknode setup -p <profile>
108+
sudo ./weaver-linux-amd64 blocknode install -p <profile>
109109
```
110110

111111
Once complete, Weaver will be able to manage Kubernetes resources on your VM using the dedicated **`weaver`** system user.
112112

113-
## Step 5: Run Block Node Setup with the Local Profile
113+
**Additional Options (v0.3.0+):**
114+
115+
- **Custom Helm values****`-values <path-to-values.yaml>`**
116+
117+
```bash
118+
sudo ./weaver-linux-amd64 blocknode install -p local --values my-values.yaml
119+
```
120+
- **Custom configuration****`-config <path-to-config.yaml>`**
121+
122+
```bash
123+
sudo ./weaver-linux-amd64 blocknode install -p local --values my-values.yaml --config config.yaml
124+
```
125+
126+
**Example `config.yaml`:**
127+
128+
```bash
129+
log:
130+
level: debug
131+
consoleLogging: true
132+
fileLogging: false
133+
blockNode:
134+
namespace: "block-node"
135+
release: "block-node"
136+
chart: "oci://ghcr.io/hiero-ledger/hiero-block-node/block-node-server"
137+
version: "0.22.1"
138+
storage:
139+
basePath: "/mnt/fast-storage"
140+
```
141+
142+
**Note:** **`blocknode setup`** is **deprecated**. Use **`blocknode install`** for all Weaver v0.3.0+ deployments [**Solo Weaver v0.3.0**](https://github.com/hashgraph/solo-weaver/releases/tag/v0.3.0).
143+
144+
### Step 5: Run Block Node Setup with the Local Profile
114145

115146
1. Ensure you are on the VM and the **`weaver`** binary is executable.
116147
2. Run the Block Node setup with **`sudo`** and the local profile:
@@ -129,7 +160,7 @@ Once complete, Weaver will be able to manage Kubernetes resources on your VM usi
129160
- Deploy the Block Node Helm chart into the cluster.
130161
4. The process takes several minutes and will show progress logs in your terminal.
131162

132-
## Step 6: Verify the Block Node Deployment
163+
### Step 6: Verify the Block Node Deployment
133164

134165
After completing the setup, confirm that your Block Node is deployed and running by checking the Kubernetes cluster:
135166

@@ -153,27 +184,25 @@ After completing the setup, confirm that your Block Node is deployed and running
153184

154185
If the pods are running and healthy, your Block Node is successfully installed and running on the Google Cloud VM.
155186

156-
## Step 7: Test Block Node Accessibility with grpcurl
187+
### Step 7: Test Block Node Accessibility with grpcurl
157188

158189
1. **Install grpcurl** using the package manager of your system:
159-
- Debian/Ubuntu: **`apt-get install grpcurl`**
160-
- macOS: **`brew install grpcurl`**
161-
- Other systems: Download from [**grpcurl releases**](https://github.com/fullstorydev/grpcurl/releases)
190+
- Debian/Ubuntu: **`apt-get install grpcurl`**
191+
- macOS: **`brew install grpcurl`**
192+
- Other systems: Download from [**grpcurl releases**](https://github.com/fullstorydev/grpcurl/releases)
162193
2. **Download the latest protobuf files** from the official release:
163-
164-
```bash
165-
curl -LO https://github.com/hiero-ledger/hiero-block-node/releases/latest/download/blocknode.proto
166-
```
167-
194+
195+
```bash
196+
curl -LO https://github.com/hiero-ledger/hiero-block-node/releases/latest/download/blocknode.proto
197+
```
168198
3. **Call the `serverStatus` endpoint** to verify the node is accessible:
169-
170-
```bash
171-
grpcurl -plaintext -import-path . -proto blocknode.proto localhost:50211 hedera.BlockNodeService.ServerStatus
172-
```
173-
199+
200+
```bash
201+
grpcurl -plaintext -import-path . -proto blocknode.proto localhost:50211 hedera.BlockNodeService.ServerStatus
202+
```
174203
4. **Review the output** for status information confirming the node is running and serving requests.
175-
176-
## Step 8: Deprovisioning and Shutdown
204+
205+
### Step 8: Deprovisioning and Shutdown
177206

178207
If you need to permanently remove a Block Node deployment (for decommissioning, upgrades, or migration):
179208

0 commit comments

Comments
 (0)