From 4a8168bb94332a730c81dc9d368f532489852271 Mon Sep 17 00:00:00 2001 From: Swirlds Automation Date: Fri, 4 Oct 2024 16:29:50 +0000 Subject: [PATCH] auto update README.md [skip ci] Signed-off-by: Swirlds Automation --- README.md | 77 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 7b060a63a..35a950fe8 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,6 @@ Then run the following command to set the kubectl context to the new cluster: ```bash kind create cluster -n "${SOLO_CLUSTER_NAME}" ``` - Example output ``` @@ -97,6 +96,7 @@ Have a nice day! 👋 You may now view pods in your cluster using `k9s -A` as below: + ``` Context: kind-solo <0> all Attach Delete | |/ _/ __ \______ @@ -141,13 +141,13 @@ solo init -t v0.54.0-alpha.4 -i node1,node2,node3 -n "${SOLO_NAMESPACE}" -s "${S ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo ********************************************************************************** ✔ Setup home directory and cache -✔ Check dependency: helm [OS: linux, Release: 5.15.0-118-generic, Arch: x64] +✔ Check dependency: helm [OS: linux, Release: 5.15.0-119-generic, Arch: x64] ✔ Check dependencies ✔ Setup chart manager @@ -169,7 +169,7 @@ solo node keys --gossip-keys --tls-keys ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -187,16 +187,13 @@ Kubernetes Namespace : solo ✔ Generate gRPC TLS keys ✔ Finalize ``` - PEM key files are generated in `~/.solo/keys` directory. - ``` hedera-node1.crt hedera-node3.crt s-private-node1.pem s-public-node1.pem unused-gossip-pem hedera-node1.key hedera-node3.key s-private-node2.pem s-public-node2.pem unused-tls hedera-node2.crt hedera-node4.crt s-private-node3.pem s-public-node3.pem hedera-node2.key hedera-node4.key s-private-node4.pem s-public-node4.pem ``` - * Setup cluster with shared components ``` @@ -208,7 +205,7 @@ solo cluster setup ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -233,7 +230,7 @@ solo network deploy ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -244,20 +241,20 @@ Kubernetes Namespace : solo ✔ Prepare staging directory ✔ Copy Gossip keys ✔ Node: node1 +✔ Copy Gossip keys +✔ Node: node3 ✔ Copy TLS keys ✔ Copy Gossip keys ✔ Node: node2 -✔ Copy Gossip keys -✔ Node: node3 ✔ Copy node keys to secrets ✔ Install chart 'fullstack-deployment' ✔ Check Node: node1 ✔ Check Node: node2 ✔ Check Node: node3 ✔ Check node pods are running +✔ Check Envoy Proxy for: node2 ✔ Check Envoy Proxy for: node1 ✔ Check Envoy Proxy for: node3 -✔ Check Envoy Proxy for: node2 ✔ Check HAProxy for: node1 ✔ Check HAProxy for: node3 ✔ Check HAProxy for: node2 @@ -278,19 +275,19 @@ solo node setup ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo ********************************************************************************** ✔ Initialize ✔ Check network pod: node1 -✔ Check network pod: node2 ✔ Check network pod: node3 +✔ Check network pod: node2 ✔ Identify network pods -✔ Update node: node1 [ platformVersion = v0.54.0-alpha.4 ] ✔ Update node: node3 [ platformVersion = v0.54.0-alpha.4 ] ✔ Update node: node2 [ platformVersion = v0.54.0-alpha.4 ] +✔ Update node: node1 [ platformVersion = v0.54.0-alpha.4 ] ✔ Fetch platform software into network nodes ✔ Set file permissions ✔ Node: node1 @@ -312,23 +309,23 @@ solo node start ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo ********************************************************************************** ✔ Initialize +✔ Check network pod: node3 ✔ Check network pod: node1 ✔ Check network pod: node2 -✔ Check network pod: node3 ✔ Identify existing network nodes ✔ Start node: node1 -✔ Start node: node2 ✔ Start node: node3 +✔ Start node: node2 ✔ Starting nodes -✔ Check network pod: node2 - status ACTIVE, attempt: 16/120 +✔ Check network pod: node1 - status ACTIVE, attempt: 16/120 +✔ Check network pod: node2 - status ACTIVE, attempt: 17/120 ✔ Check network pod: node3 - status ACTIVE, attempt: 17/120 -✔ Check network pod: node1 - status ACTIVE, attempt: 17/120 ✔ Check nodes are ACTIVE ✔ Check proxy for node: node1 ✔ Check proxy for node: node2 @@ -351,7 +348,7 @@ solo mirror-node deploy ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -363,9 +360,9 @@ Kubernetes Namespace : solo ✔ Check Hedera Explorer ✔ Check Postgres DB ✔ Check GRPC -✔ Check REST API -✔ Check Importer ✔ Check Monitor +✔ Check Importer +✔ Check REST API ✔ Check pods are ready ✔ Insert data in public.file_data ✔ Seed DB data @@ -382,7 +379,7 @@ solo relay deploy ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -444,12 +441,33 @@ Once the nodes are up, you may now expose various services (using `k9s` (shift-f * Node services: `network--svc` * HAProxy: `haproxy--svc` + ```bash + # enable portforwarding for haproxy + # node1 grpc port accessed by localhost:50211 + kubectl port-forward svc/haproxy-node1-svc -n "${SOLO_NAMESPACE}" 50211:50211 & + # node2 grpc port accessed by localhost:51211 + kubectl port-forward svc/haproxy-node2-svc -n "${SOLO_NAMESPACE}" 51211:50211 & + # node3 grpc port accessed by localhost:52211 + kubectl port-forward svc/haproxy-node3-svc -n "${SOLO_NAMESPACE}" 52211:50211 & + ``` * Envoy Proxy: `envoy-proxy--svc` + ```bash + # enable portforwarding for envoy proxy + kubectl port-forward svc/envoy-proxy-node1-svc -n "${SOLO_NAMESPACE}" 8181:8080 & + kubectl port-forward svc/envoy-proxy-node2-svc -n "${SOLO_NAMESPACE}" 8281:8080 & + kubectl port-forward svc/envoy-proxy-node3-svc -n "${SOLO_NAMESPACE}" 8381:8080 & + ``` * Hedera explorer: `fullstack-deployment-hedera-explorer` + ```bash + #enable portforwarding for hedera explorer, can be access at http://localhost:8080/ + kubectl port-forward svc/fullstack-deployment-hedera-explorer -n "${SOLO_NAMESPACE}" 8080:80 & + ``` * JSON Rpc Relays * You can deploy JSON RPC relays for one or more nodes as below: - ``` - solo relay deploy -i node1,node2 + ```bash + solo relay deploy -i node1 + # enable relay for node1 + kubectl port-forward svc/relay-node1-hedera-json-rpc-relay -n "${SOLO_NAMESPACE}" 7546:7546 & ``` Example output @@ -457,7 +475,7 @@ Example output ``` ******************************* Solo ********************************************* -Version : 0.30.1 +Version : 0.31.0 Kubernetes Context : kind-solo Kubernetes Cluster : kind-solo Kubernetes Namespace : solo @@ -478,7 +496,6 @@ To set customized `settings.txt` file, edit the file `~/.solo/cache/templates/settings.txt` after `solo init` command. Then you can start customized built hedera network with the following command: - ``` solo node setup --local-build-path ,node1=,node2= @@ -488,15 +505,12 @@ solo node setup --local-build-path ,node1=,node1=,node2= --app PlatformTestingTool.jar --app-config # example: solo node setup --local-build-path ../hedera-services/platform-sdk/sdk/data,node1=../hedera-services/platform-sdk/sdk/data,node2=../hedera-services/platform-sdk/sdk/data --app PlatformTestingTool.jar --app-config ../hedera-services/platform-sdk/platform-apps/tests/PlatformTestingTool/src/main/resources/FCMFCQ-Basic-2.5k-5m.json ``` - ## Logs - You can find log for running solo command under the directory `~/.solo/logs/` The file `solo.log` contains the logs for the solo command. The file `hashgraph-sdk.log` contains the logs from Solo client when sending transactions to network nodes. @@ -506,7 +520,6 @@ The file `hashgraph-sdk.log` contains the logs from Solo client when sending tra NOTE: the hedera-services path referenced '../hedera-services/hedera-node/data' may need to be updated based on what directory you are currently in. This also assumes that you have done an assemble/build and the directory contents are up-to-date. Example 1: attach jvm debugger to a hedera node - ```bash ./test/e2e/setup-e2e.sh solo node keys --gossip-keys --tls-keys