## 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. NOTE: for cleanup from previous runs, you may need to run the following command: ``` rm -Rf ~/.solo kind delete cluster -n "${SOLO_CLUSTER_NAME}" ``` ### 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 ``` #### 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 Attach Delete | |/ _/ __ \______ User: kind-solo Describe

| < \____ / ___/ K9s Rev: v0.32.5 Edit Help |____|__ \ /____//____ > CPU: n/a Jump Owner \/ \/ MEM: n/a ┌───────────────────────────────────────────────── Pods(all)[11] ─────────────────────────────────────────────────┐ │ NAMESPACE↑ NAME PF READY STATUS RESTARTS IP NODE │ │ solo-setup console-557956d575-4r5xm ● 1/1 Running 0 10.244.0.5 solo-con │ │ solo-setup minio-operator-7d575c5f84-8shc9 ● 1/1 Running 0 10.244.0.6 solo-con │ │ kube-system coredns-5d78c9869d-6cfbg ● 1/1 Running 0 10.244.0.4 solo-con │ │ kube-system coredns-5d78c9869d-gxcjz ● 1/1 Running 0 10.244.0.3 solo-con │ │ kube-system etcd-solo-control-plane ● 1/1 Running 0 172.18.0.2 solo-con │ │ kube-system kindnet-k75z6 ● 1/1 Running 0 172.18.0.2 solo-con │ │ kube-system kube-apiserver-solo-control-plane ● 1/1 Running 0 172.18.0.2 solo-con │ │ kube-system kube-controller-manager-solo-control-plane ● 1/1 Running 0 172.18.0.2 solo-con │ │ kube-system kube-proxy-cct7t ● 1/1 Running 0 172.18.0.2 solo-con │ │ kube-system kube-scheduler-solo-control-plane ● 1/1 Running 0 172.18.0.2 solo-con │ │ local-path-storage local-path-provisioner-6bc4bddd6b-gwdp6 ● 1/1 Running 0 10.244.0.2 solo-con │ │ │ │ │ └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ ``` ### Step by Step Instructions * Initialize `solo` directories: ``` # reset .solo directory rm -rf ~/.solo solo init ``` * Example output ``` $SOLO_INIT_OUTPUT ``` * Generate `pem` formatted node keys ``` solo node keys --gossip-keys --tls-keys -i node1,node2,node3 ``` * Example output ``` $SOLO_NODE_KEY_PEM_OUTPUT ``` 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 ``` * Create a deployment in the specified clusters, generate RemoteConfig and LocalConfig objects. ``` solo deployment create -n "${SOLO_NAMESPACE}" --context kind-${SOLO_CLUSTER_NAME} --email "${SOLO_EMAIL}" --deployment-clusters kind-${SOLO_CLUSTER_NAME} --deployment "${SOLO_DEPLOYMENT}" ``` * Example output ``` $SOLO_DEPLOYMENT_CREATE_OUTPUT ``` * Setup cluster with shared components ``` solo cluster setup -s "${SOLO_CLUSTER_SETUP_NAMESPACE}" ``` * Example output ``` $SOLO_CLUSTER_SETUP_OUTPUT ``` In a separate terminal, you may run `k9s` to view the pod status. * 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 -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" ``` * 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 ``` solo node setup -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" ``` * Example output ``` $SOLO_NODE_SETUP_OUTPUT ``` * Start the nodes ``` solo node start -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" ``` * Example output ``` $SOLO_NODE_START_OUTPUT ``` * Deploy mirror node ``` solo mirror-node deploy --deployment "${SOLO_DEPLOYMENT}" ``` * Example output ``` $SOLO_MIRROR_NODE_DEPLOY_OUTPUT ``` * Deploy Hedera Explorer ``` solo explorer deploy --deployment "${SOLO_DEPLOYMENT}" --cluster-ref kind-${SOLO_CLUSTER_NAME} ``` * Example output ``` $SOLO_EXPLORER_DEPLOY_OUTPUT ``` * Deploy a JSON RPC relay ``` solo relay deploy -i node1,node2,node3 --deployment "${SOLO_DEPLOYMENT}" ``` * Example output ``` $SOLO_RELAY_DEPLOY_OUTPUT ``` You may view the list of pods using `k9s` as below: ``` Context: kind-solo <0> all Attach Delete | |/ _/ __ \______ User: kind-solo Describe

| < \____ / ___/ K9s Rev: v0.32.5 Edit Help |____|__ \ /____//____ > CPU: n/a Jump Owner \/ \/ MEM: n/a ┌───────────────────────────────────────────────── Pods(all)[31] ─────────────────────────────────────────────────┐ │ NAMESPACE↑ NAME PF READY STATUS RESTARTS I │ │ kube-system coredns-5d78c9869d-994t4 ● 1/1 Running 0 1 │ │ kube-system coredns-5d78c9869d-vgt4q ● 1/1 Running 0 1 │ │ kube-system etcd-solo-control-plane ● 1/1 Running 0 1 │ │ kube-system kindnet-q26c9 ● 1/1 Running 0 1 │ │ kube-system kube-apiserver-solo-control-plane ● 1/1 Running 0 1 │ │ kube-system kube-controller-manager-solo-control-plane ● 1/1 Running 0 1 │ │ kube-system kube-proxy-9b27j ● 1/1 Running 0 1 │ │ kube-system kube-scheduler-solo-control-plane ● 1/1 Running 0 1 │ │ local-path-storage local-path-provisioner-6bc4bddd6b-4mv8c ● 1/1 Running 0 1 │ │ solo envoy-proxy-node1-65f8879dcc-rwg97 ● 1/1 Running 0 1 │ │ solo envoy-proxy-node2-667f848689-628cx ● 1/1 Running 0 1 │ │ solo envoy-proxy-node3-6bb4b4cbdf-dmwtr ● 1/1 Running 0 1 │ │ solo solo-deployment-grpc-75bb9c6c55-l7kvt ● 1/1 Running 0 1 │ │ solo solo-deployment-hedera-explorer-6565ccb4cb-9dbw2 ● 1/1 Running 0 1 │ │ solo solo-deployment-importer-dd74fd466-vs4mb ● 1/1 Running 0 1 │ │ solo solo-deployment-monitor-54b8f57db9-fn5qq ● 1/1 Running 0 1 │ │ solo solo-deployment-postgres-postgresql-0 ● 1/1 Running 0 1 │ │ solo solo-deployment-redis-node-0 ● 2/2 Running 0 1 │ │ solo solo-deployment-rest-6d48f8dbfc-plbp2 ● 1/1 Running 0 1 │ │ solo solo-deployment-restjava-5d6c4cb648-r597f ● 1/1 Running 0 1 │ │ solo solo-deployment-web3-55fdfbc7f7-lzhfl ● 1/1 Running 0 1 │ │ solo haproxy-node1-785b9b6f9b-676mr ● 1/1 Running 1 1 │ │ solo haproxy-node2-644b8c76d-v9mg6 ● 1/1 Running 1 1 │ │ solo haproxy-node3-fbffdb64-272t2 ● 1/1 Running 1 1 │ │ solo minio-pool-1-0 ● 2/2 Running 1 1 │ │ solo network-node1-0 ● 5/5 Running 2 1 │ │ solo network-node2-0 ● 5/5 Running 2 1 │ │ solo network-node3-0 ● 5/5 Running 2 1 │ │ solo relay-node1-node2-node3-hedera-json-rpc-relay-ddd4c8d8b-hdlpb ● 1/1 Running 0 1 │ │ solo-cluster console-557956d575-c5qp7 ● 1/1 Running 0 1 │ │ solo-cluster minio-operator-7d575c5f84-xdwwz ● 1/1 Running 0 1 │ │ │ └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ ```