/
README.md.template
370 lines (272 loc) · 14.3 KB
/
README.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# Solo
[](https://www.npmjs.com/package/@hashgraph/solo)
[](LICENSE)
[](https://github.com/hashgraph/solo/actions/workflows/flow-build-application.yaml)
[](https://app.codacy.com/gh/hashgraph/solo/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
[](https://codecov.io/gh/hashgraph/solo)
An opinionated CLI tool to deploy and manage standalone test networks.
## Table of Contents
* [Requirements](#requirements)
* [Setup](#setup)
* [Install Solo](#install-solo)
* [Setup Kubernetes cluster](#setup-kubernetes-cluster)
* [Generate Node Keys](#generate-node-keys)
* [Legacy keys (.pfx file)](#legacy-keys-pfx-file)
* [Standard keys (.pem file)](#standard-keys-pem-file)
* [Examples](#examples)
* [Example - 1: Deploy a standalone test network (version `0.42.5`)](#example---1-deploy-a-standalone-test-network-version-0425)
* [Example - 2: Deploy a standalone test network (version `0.47.0-alpha.0`)](#example---2-deploy-a-standalone-test-network-version-0470-alpha0)
* [Support](#support)
* [Contributing](#contributing)
* [Code of Conduct](#code-of-conduct)
* [License](#license)
## Requirements
* Node(>=18.19.0) (*lts/hydrogen*)
## Setup
* Install [Node](https://nodejs.org/en/download). You may also use [nvm](https://github.com/nvm-sh/nvm) to manage different Node versions locally:
```
nvm install lts/hydrogen
nvm use lts/hydrogen
```
* Useful tools:
* Install [kubectl](https://kubernetes.io/docs/tasks/tools/)
* Install [k9s](https://k9scli.io/)
## Install Solo
* Run `npm install -g @hashgraph/solo`
## Setup Kubernetes cluster
### Remote cluster
* You may use remote kubernetes cluster. In this case, ensure kubernetes context is set up correctly.
```
kubectl config use-context <context-name>
```
### Local cluster
* You may use [kind](https://kind.sigs.k8s.io/) or [microk8s](https://microk8s.io/) to create a cluster. In this case,
ensure your Docker engine has enough resources (e.g. Memory >=8Gb, CPU: >=4). Below we show how you can use `kind` to create a cluster
First, use the following command to set up the environment variables:
```
export SOLO_CLUSTER_NAME=solo
export SOLO_NAMESPACE=solo
export SOLO_CLUSTER_SETUP_NAMESPACE=solo-cluster
```
Then run the following command to set the kubectl context to the new cluster:
```bash
kind create cluster -n "${SOLO_CLUSTER_NAME}"
```
Example output
```
$KIND_CREATE_CLUSTER_OUTPUT
```
You may now view pods in your cluster using `k9s -A` as below:
```
Context: kind-solo <0> all <a> Attac… ____ __.________
Cluster: kind-solo <1> default <ctrl-d> Delete| |/ _/ __ \______
User: kind-solo <d> Descri| < \____ / ___/
K9s Rev: v0.27.4 ⚡️v0.32.3 <e> Edit | | \ / /\___ \
K8s Rev: v1.27.3 <?> Help |____|__ \ /____//____ >
CPU: n/a <ctrl-k> Kill \/ \/
MEM: n/a
┌───────────────────────────────────────────── Pods(all)[9] ─────────────────────────────────────────────┐
│ NAMESPACE↑ NAME PF READY RESTARTS STATUS IP │
│ kube-system coredns-5d78c9869d-kc27p ● 1/1 0 Running 10.244.0.4 │
│ kube-system coredns-5d78c9869d-r8mzz ● 1/1 0 Running 10.244.0.3 │
│ kube-system etcd-solo-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kindnet-gppbk ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-apiserver-solo-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-controller-manager-solo-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-proxy-wb9w5 ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-scheduler-solo-control-plane ● 1/1 0 Running 172.18.0.2 │
│ local-path-storage local-path-provisioner-6bc4bddd6b-5vh5d ● 1/1 0 Running 10.244.0.2 │
│ │
│
```
## Examples
### Example - 1: Deploy a standalone test network (version `0.42.5`)
* Initialize `solo` with tag `v0.42.5` and list of node names `node0,node1,node2`:
```
$ solo init -t v0.42.5 -i node0,node1,node2 -n "${SOLO_NAMESPACE}" -s "${SOLO_CLUSTER_SETUP_NAMESPACE}" --key-format pfx
```
Example output
```
$SOLO_INIT_OUTPUT
```
* Generate `pfx` formatted node keys
We need to generate `pfx` keys as `pem` key files are only supported by Hedera platform >=`0.47.0-alpha.0`.
```
$ solo node keys --gossip-keys --tls-keys --key-format pfx
```
Example output
```
$SOLO_NODE_KEYS_OUTPUT
```
Key files are generated in `~/.solo/keys` directory.
```
$ ls ~/.solo/cache/keys
hedera-node0.crt hedera-node1.crt hedera-node2.crt private-node0.pfx private-node2.pfx
hedera-node0.key hedera-node1.key hedera-node2.key private-node1.pfx public.pfx
```
* Setup cluster with shared components
* In a separate terminal, you may run `k9s` to view the pod status.
```
$ solo cluster setup
```
Example output
```
$SOLO_CLUSTER_SETUP_OUTPUT
```
* Deploy helm chart with Hedera network components
* It may take a while (5~15 minutes depending on your internet speed) to download various docker images and get the pods started.
* If it fails, ensure you have enough resources allocated for Docker engine and retry the command.
```
$ solo network deploy
```
Example output
```
$SOLO_NETWORK_DEPLOY_OUTPUT
```
* Setup node with Hedera platform software.
* It may take a while as it download the hedera platform code from <https://builds.hedera.com/>
```
$ solo node setup
```
Example output
```
$SOLO_NODE_SETUP_OUTPUT
```
* Start the nodes.
```
$ solo node start
```
Example output
```
$SOLO_NODE_START_OUTPUT
```
* Deploy mirror node
```
$ solo mirror-node deploy
```
Example output
```
$SOLO_MIRROR_NODE_DEPLOY_OUTPUT
```
* Deploy a JSON RPC relay
```
$ solo relay deploy
```
Example output
```
$SOLO_RELAY_DEPLOY_OUTPUT
```
You may view the list of pods using `k9s` as below:
```
Context: kind-solo-e2e <0> all <a> Attach <l> … ____ __.________
Cluster: kind-solo-e2e <1> default <ctrl-d> Delete <p> | |/ _/ __ \______
User: kind-solo-e2e <d> Describe <shift-f>| < \____ / ___/
K9s Rev: v0.27.4 ⚡️v0.32.4 <e> Edit <s> | | \ / /\___ \
K8s Rev: v1.27.3 <?> Help <n> |____|__ \ /____//____ >
CPU: n/a <ctrl-k> Kill <f> \/ \/
MEM: n/a
┌─────────────────────────────────────────────────── Pods(all)[27] ────────────────────────────────────────────────────┐
│ NAMESPACE↑ NAME PF READY RESTARTS STATUS IP │
│ fullstack-setup console-557956d575-fqctd ● 1/1 0 Running 10.244.0.4 │
│ fullstack-setup minio-operator-7d575c5f84-j9p6f ● 1/1 0 Running 10.244.0.3 │
│ kube-system coredns-5d78c9869d-gknqp ● 1/1 0 Running 10.244.0.6 │
│ kube-system coredns-5d78c9869d-q59pc ● 1/1 0 Running 10.244.0.5 │
│ kube-system etcd-solo-e2e-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kindnet-w9ps5 ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-apiserver-solo-e2e-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-controller-manager-solo-e2e-control-plane ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-proxy-p69z8 ● 1/1 0 Running 172.18.0.2 │
│ kube-system kube-scheduler-solo-e2e-control-plane ● 1/1 0 Running 172.18.0.2 │
│ local-path-storage local-path-provisioner-6bc4bddd6b-8pkfk ● 1/1 0 Running 10.244.0.2 │
│ solo envoy-proxy-node0-84947f844f-f28tp ● 1/1 0 Running 10.244.0.215 │
│ solo envoy-proxy-node1-65f8879dcc-j2lrk ● 1/1 0 Running 10.244.0.216 │
│ solo envoy-proxy-node2-667f848689-dkmf9 ● 1/1 0 Running 10.244.0.214 │
│ solo fullstack-deployment-grpc-69f9cc5666-lf6ql ● 1/1 0 Running 10.244.0.227 │
│ solo fullstack-deployment-hedera-explorer-79f79b7df4-wjdct ● 1/1 0 Running 10.244.0.226 │
│ solo fullstack-deployment-importer-864489ffb8-6v8tk ● 1/1 0 Running 10.244.0.228 │
│ solo fullstack-deployment-postgres-postgresql-0 ● 1/1 0 Running 10.244.0.232 │
│ solo fullstack-deployment-rest-584f5cb6bb-q9vnt ● 1/1 0 Running 10.244.0.230 │
│ solo fullstack-deployment-web3-69dcdfc4fb-mm5pk ● 1/1 0 Running 10.244.0.229 │
│ solo haproxy-node0-6969f76c77-n5cfl ● 1/1 1 Running 10.244.0.219 │
│ solo haproxy-node1-59f6976d45-x6xmp ● 1/1 1 Running 10.244.0.217 │
│ solo haproxy-node2-6df64d5457-hf9ps ● 1/1 1 Running 10.244.0.218 │
│ solo minio-pool-1-0 ● 2/2 1 Running 10.244.0.224 │
│ solo network-node0-0 ● 5/5 0 Running 10.244.0.221 │
│ solo network-node1-0 ● 5/5 0 Running 10.244.0.222 │
│ solo network-node2-0 ● 5/5 0 Running 10.244.0.220 │
```
#### Access Hedera Network services
Once the nodes are up, you may now expose various services (using `k9s` (shift-f) or `kubectl port-forward`) and access. Below are most used services that you may expose.
* Node services: `network-<node ID>-svc`
* HAProxy: `haproxy-<node ID>-svc`
* Envoy Proxy: `envoy-proxy-<node ID>-svc`
* Hedera explorer: `fullstack-deployment-hedera-explorer`
* JSON Rpc Relays
* You can deploy JSON RPC relays for one or more nodes as below:
```
$ solo relay deploy -i node0,node1
```
Example output
```
$SOLO_RELAY_DEPLAY_OUTPUT
```
### Example - 2: Deploy a standalone test network (version `0.47.0-alpha.0`)
* Initialize `solo` with tag `v0.47.0-alpha.0` and list of node names `node0,node1,node2`:
```
# reset .solo directory
$ rm -rf ~/.solo
$ solo init -t v0.47.0-alpha.0 -i node0,node1,node2 -n "${SOLO_NAMESPACE}" -s "${SOLO_CLUSTER_SETUP_NAMESPACE}" --key-format pem
```
* Example output
```
$SOLO_INIT_047_OUTPUT
```
* Generate `pem` formatted node keys
```
$ solo node keys --gossip-keys --tls-keys --key-format pem
```
* Example output
```
$SOLO_NODE_KEY_PEM_OUTPUT
```
PEM key files are generated in `~/.solo/keys` directory.
```
$ ls ~/.solo/cache/keys
a-private-node0.pem a-public-node1.pem hedera-node1.crt s-private-node0.pem s-public-node1.pem
a-private-node1.pem a-public-node2.pem hedera-node1.key s-private-node1.pem s-public-node2.pem
a-private-node2.pem hedera-node0.crt hedera-node2.crt s-private-node2.pem
a-public-node0.pem hedera-node0.key hedera-node2.key s-public-node0.pem
```
* Setup cluster with shared components
```
$ solo cluster setup
# output is similar to example-1
```
In a separate terminal, you may run `k9s` to view the pod status.
* Deploy helm chart with Hedera network components
```
$ solo network deploy
# output is similar to example-1
```
* Setup node with Hedera platform.
* It may take a while (~10 minutes depending on your internet speed) to download various docker images and get the
pods started.
```
$ solo node setup
# output is similar to example-1
```
* Start the nodes
```
$ solo node start
# output is similar to example-1
```
## Support
If you have a question on how to use the product, please see our [support guide](https://github.com/hashgraph/.github/blob/main/SUPPORT.md).
## Contributing
Contributions are welcome. Please see the [contributing guide](https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md) to see how you can get involved.
## Code of Conduct
This project is governed by the [Contributor Covenant Code of Conduct](https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are
expected to uphold this code of conduct.
## License
[Apache License 2.0](LICENSE)