Skip to content

Commit

Permalink
chore: auto update docs/content/User/StepByStepGuide.md
Browse files Browse the repository at this point in the history 
Signed-off-by: Swirlds Automation <swirlds-eng-automation@swirlds.com>
  • Loading branch information
@swirlds-automation
swirlds-automation committed Jan 24, 2025
1 parent d60247a commit d0a8046
Showing 1 changed file with 34 additions and 39 deletions.
73 changes: 34 additions & 39 deletions docs/content/User/StepByStepGuide.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
## Advanced User Guide

For those who would like to have more control or need some customized setups, here are some step by step instructions of how to setup and deploy a solo network.

### Setup Kubernetes cluster

#### Remote cluster
Expand Down Expand Up @@ -30,7 +28,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

```
Expand All @@ -46,11 +43,12 @@ You can now use your cluster with:
kubectl cluster-info --context kind-solo
Thanks for using kind! 😊
Have a nice day! 👋
```

You may now view pods in your cluster using `k9s -A` as below:


```
Context: kind-solo <0> all <a> Attach <ctr… ____ __.________
Cluster: kind-solo <ctrl-d> Delete <l> | |/ _/ __ \______
Expand All @@ -77,6 +75,7 @@ You may now view pods in your cluster using `k9s -A` as below:
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```


### Step by Step Instructions

* Initialize `solo` directories:
Expand All @@ -93,7 +92,7 @@ solo init
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
**********************************************************************************
Expand All @@ -120,7 +119,7 @@ solo node keys --gossip-keys --tls-keys -i node1,node2,node3
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
**********************************************************************************
Expand All @@ -131,22 +130,19 @@ Kubernetes Cluster : kind-solo
✔ Gossip key for node: node3
✔ Generate gossip keys
✔ Backup old files
✔ TLS key for node: node3
✔ TLS key for node: node2
✔ TLS key for node: node1
✔ TLS key for node: node3
✔ 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

```
Expand All @@ -158,10 +154,11 @@ solo cluster setup -s "${SOLO_CLUSTER_SETUP_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
**********************************************************************************
Current deployment name is not set in local config
✔ Initialize
✔ Prepare chart values
✔ Install 'solo-cluster-setup' chart
Expand All @@ -184,36 +181,36 @@ solo network deploy -i node1,node2,node3 -n "${SOLO_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
Kubernetes Namespace : solo
**********************************************************************************
remote config not found
✔ Acquire lease - lease acquired successfully, attempt: 1/10
✔ Initialize
✔ Load remote config - remote config not found
✔ Check if cluster setup chart is installed
✔ Copy Gossip keys to staging
✔ Copy gRPC TLS keys to staging
✔ Prepare staging directory
✔ Copy Gossip keys
✔ Node: node2
✔ Copy TLS keys
✔ Copy Gossip keys
✔ Node: node3
✔ Copy Gossip keys
✔ Node: node1
✔ Copy TLS keys
✔ Copy Gossip keys
✔ Node: node2
✔ Copy node keys to secrets
✔ Install chart 'solo-deployment'
✔ Check Node: node1
✔ Check Node: node2
✔ Check Node: node3
✔ Check node pods are running
✔ Check Envoy Proxy for: node3
✔ Check Envoy Proxy for: node1
✔ Check HAProxy for: node2
✔ Check Envoy Proxy for: node2
✔ Check HAProxy for: node1
✔ Check Envoy Proxy for: node3
✔ Check HAProxy for: node2
✔ Check HAProxy for: node3
✔ Check proxy pods are running
✔ Check MinIO
Expand All @@ -232,31 +229,31 @@ solo node setup -i node1,node2,node3 -n "${SOLO_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
Kubernetes Namespace : solo
**********************************************************************************
remote config not found
✔ Acquire lease - lease acquired successfully, attempt: 1/10
✔ Initialize
✔ Load remote config - remote config not found
✔ Check network pod: node1
✔ Check network pod: node2
✔ Check network pod: node1
✔ Check network pod: node3
✔ Identify network pods
✔ Update node: node2 [ platformVersion = v0.58.3 ]
✔ Update node: node3 [ platformVersion = v0.58.3 ]
✔ Update node: node1 [ platformVersion = v0.58.3 ]
✔ Update node: node2 [ platformVersion = v0.59.0-main.x5322bdc ]
✔ Update node: node3 [ platformVersion = v0.59.0-main.x5322bdc ]
✔ Update node: node1 [ platformVersion = v0.59.0-main.x5322bdc ]
✔ Fetch platform software into network nodes
✔ Copy configuration files
✔ Copy configuration files
✔ Copy configuration files
✔ Set file permissions
✔ Node: node2
✔ Set file permissions
✔ Node: node1
✔ Set file permissions
✔ Node: node3
✔ Set file permissions
✔ Node: node2
✔ Setup network nodes
```

Expand All @@ -271,25 +268,25 @@ solo node start -i node1,node2,node3 -n "${SOLO_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
Kubernetes Namespace : solo
**********************************************************************************
remote config not found
✔ Acquire lease - lease acquired successfully, attempt: 1/10
✔ Initialize
✔ Load remote config - remote config not found
✔ 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: node3
✔ Start node: node2
✔ Start node: node1
✔ Starting nodes
✔ Check network pod: node2 - status ACTIVE, attempt: 18/120
✔ Check network pod: node1 - status ACTIVE, attempt: 18/120
✔ Check network pod: node3 - status ACTIVE, attempt: 18/120
✔ Check network pod: node1 - status ACTIVE, attempt: 19/120
✔ Check network pod: node2 - status ACTIVE, attempt: 19/120
✔ Check network pod: node3 - status ACTIVE, attempt: 19/120
✔ Check all nodes are ACTIVE
✔ Check proxy for node: node1
✔ Check proxy for node: node2
Expand All @@ -312,19 +309,17 @@ solo mirror-node deploy -n "${SOLO_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
Kubernetes Namespace : solo
**********************************************************************************
remote config not found
✔ Acquire lease - lease acquired successfully, attempt: 1/10
✔ Initialize
✔ Load remote config - remote config not found
✔ Prepare address book
✔ Deploy mirror-node
✔ Deploy hedera-explorer
✔ Enable mirror-node
✔ Check Hedera Explorer
✔ Check Postgres DB
✔ Check REST API
✔ Check GRPC
Expand All @@ -346,14 +341,14 @@ solo relay deploy -i node1 -n "${SOLO_NAMESPACE}"
```
******************************* Solo *********************************************
Version : 0.33.0
Version : 0.34.0
Kubernetes Context : kind-solo
Kubernetes Cluster : kind-solo
Kubernetes Namespace : solo
**********************************************************************************
remote config not found
✔ Acquire lease - lease acquired successfully, attempt: 1/10
✔ Initialize
✔ Load remote config - remote config not found
✔ Prepare chart values
✔ Deploy JSON RPC Relay
✔ Check relay is ready
Expand Down

0 comments on commit d0a8046

Please sign in to comment.