GitBook: [#217] Adding Omnibus Node Deployment Doc

akash-network · Dec 3, 2021 · c18d9d4 · c18d9d4
1 parent fb68373
commit c18d9d4
Show file tree

Hide file tree

Showing 26 changed files with 144 additions and 0 deletions.
diff --git a/.gitbook/assets/acceptDeposit (1).png b/.gitbook/assets/acceptDeposit (1).png
diff --git a/.gitbook/assets/acceptDeposit.png b/.gitbook/assets/acceptDeposit.png
diff --git a/.gitbook/assets/akashlyticsBaseVerify.png b/.gitbook/assets/akashlyticsBaseVerify.png
diff --git a/.gitbook/assets/bidSelect.png b/.gitbook/assets/bidSelect.png
diff --git a/.gitbook/assets/bidTransactionFee.png b/.gitbook/assets/bidTransactionFee.png
diff --git a/.gitbook/assets/deploymentComplete (1).png b/.gitbook/assets/deploymentComplete (1).png
diff --git a/.gitbook/assets/deploymentComplete (2).png b/.gitbook/assets/deploymentComplete (2).png
diff --git a/.gitbook/assets/deploymentComplete.png b/.gitbook/assets/deploymentComplete.png
diff --git a/.gitbook/assets/deploymentCounts.png b/.gitbook/assets/deploymentCounts.png
diff --git a/.gitbook/assets/deploymentsHomeScreen.png b/.gitbook/assets/deploymentsHomeScreen.png
diff --git a/.gitbook/assets/manifestSelectFinal.png b/.gitbook/assets/manifestSelectFinal.png
diff --git a/.gitbook/assets/manifestSelectInitial.png b/.gitbook/assets/manifestSelectInitial.png
diff --git a/.gitbook/assets/mintscanBlockHeight.png b/.gitbook/assets/mintscanBlockHeight.png
diff --git a/.gitbook/assets/nodeUIR.png b/.gitbook/assets/nodeUIR.png
diff --git a/.gitbook/assets/rpcNetInfoData.png b/.gitbook/assets/rpcNetInfoData.png
diff --git a/.gitbook/assets/rpcNetInfoLink.png b/.gitbook/assets/rpcNetInfoLink.png
diff --git a/.gitbook/assets/rpcNodeWebPage (1).png b/.gitbook/assets/rpcNodeWebPage (1).png
diff --git a/.gitbook/assets/rpcNodeWebPage.png b/.gitbook/assets/rpcNodeWebPage.png
diff --git a/.gitbook/assets/rpcStatusLink (1).png b/.gitbook/assets/rpcStatusLink (1).png
diff --git a/.gitbook/assets/rpcStatusLink.png b/.gitbook/assets/rpcStatusLink.png
diff --git a/.gitbook/assets/rpcStatusVerification.png b/.gitbook/assets/rpcStatusVerification.png
diff --git a/.gitbook/assets/snapshotDownloadComplete.png b/.gitbook/assets/snapshotDownloadComplete.png
diff --git a/.gitbook/assets/snapshotDownloading.png b/.gitbook/assets/snapshotDownloading.png
diff --git a/.gitbook/assets/transactionFeeDeployAccept.png b/.gitbook/assets/transactionFeeDeployAccept.png
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -34,6 +34,7 @@
 
 ## Operations
 
+* [Akash Node Deployment Via Omnibus](operations/akash-node-deployment-via-omnibus.md)
 * [Run an Akash Node](operations/node/README.md)
   * [RPC Service](operations/node/rpc-service.md)
   * [API Service](operations/node/api-service.md)

diff --git a/operations/akash-node-deployment-via-omnibus.md b/operations/akash-node-deployment-via-omnibus.md
@@ -0,0 +1,143 @@
+# Akash Node Deployment Via Omnibus
+
+In this guide we will cover the deployment of an Akash Node using Cosmos Omnibus.  Omnibus will deploy the node onto Akash’s distributed network. Omnibus will greatly simplify the deployment process.
+
+For fine tuning of the Akash node check the _Additional Information_ section.
+
+## Akashlytics Deployment of a Node
+
+### Akashlytics Deploy Overview
+
+If you have not used Akashlytics Deploy previously, please use the following guide to get started.  The guide includes steps to install the app and to set up a wallet for Akash deployments.  Once the Akashlytics Deploy tool is installed, return to this guide to walk through the Akash Node deployment.
+
+{% embed url="https://docs.akash.network/guides/deploy" %}
+
+### Akashlytics Deploy Walkthrough
+
+* Our Akash Node install begins by creating a new deployment
+
+![](../.gitbook/assets/deploymentsHomeScreen.png)
+
+* A number of checks are completed to make sure we are ready to deploy a new app onto Akash&#x20;
+* Revisit the Akashlytics Deploy guide for tips if any checks fail
+
+![](../.gitbook/assets/akashlyticsBaseVerify.png)
+
+* To install the Akash Node we will use a custom SDL file&#x20;
+* Select the “Empty” option so that we can copy/paste the Akash Node SDL in the next step
+
+![](../.gitbook/assets/manifestSelectInitial.png)
+
+* Copy and paste SDL from the following location into the Akashlytics SDL editor window
+
+{% embed url="https://github.com/tombeynon/cosmos-omnibus/blob/master/akash/deploy.yml" %}
+
+* **NOTE -** the SDL within GitHub currently has a storage > size value of 120Gi.  Omnibus uses a compressed snapshot of the blockchain and when expanded 120GB of storage for the deployment will not be enough.  At the time of this writing adjusting the storage size to 350GB will suffice and allow some growth.  Please adjust the storage appropriately and as shown in the screenshot below.
+
+![](../.gitbook/assets/manifestSelectFinal.png)
+
+* Accept the initial deposit of 5 AKT into the deployment’s escrow account&#x20;
+* The escrow can be refilled easily within Akashlytics Deploy at any time
+
+![](<../.gitbook/assets/acceptDeposit (1).png>)
+
+* Approve the transaction fee to allow the deployment to continue
+
+![](../.gitbook/assets/transactionFeeDeployAccept.png)
+
+* Select a provider from the bid list
+
+![](../.gitbook/assets/bidSelect.png)
+
+* Accept the transaction fee to create a lease with the provider
+
+![](../.gitbook/assets/bidTransactionFee.png)
+
+### Akashlytics Deploy Complete
+
+* Once the deployment is complete the lease details are shown
+
+![](<../.gitbook/assets/deploymentComplete (1).png>)
+
+* After some time the Available/Ready Replicas fields will update to show the current node count.  It may be necessary to refresh the screen for this count to update.
+
+![](../.gitbook/assets/deploymentCounts.png)
+
+## Confirmation of Node Deployment
+
+With the install of the Akash node complete, it must sync with the blockchain.  Omnibus will use a snapshot of prior blocks to speed the sync but even so this will take several hours.  In the meantime let’s look into monitoring the sync and the running node’s health.
+
+### Snapshot Download Progress
+
+* While the blockchain snapshot is downloading, the following logs should be visible within Akashlytics&#x20;
+* We can know that the snapshot download is not yet complete if we see this message in the logs
+
+![](../.gitbook/assets/snapshotDownloading.png)
+
+### Snapshot Download Completed
+
+* After the snapshot download completes the logs will begin showing blockchain sync activity
+* &#x20;Example output shown should look something like this but with the current blocks on the chain
+
+![](../.gitbook/assets/snapshotDownloadComplete.png)
+
+### Akash Node Verifications
+
+* These confirmations can be used after the snapshot has been completed
+
+#### Capture Deployment Address
+
+* Begin by capturing the deployment’s public URI from Akashlytics
+
+![](../.gitbook/assets/nodeUIR.png)
+
+#### Confirm Blockchain Sync
+
+* Open a web browser and enter the Node’s URI as an address&#x20;
+* If the Node deployed successfully we should view a list of RPC endpoints&#x20;
+* Click the link to visit the Node’s status page
+
+![](<../.gitbook/assets/rpcStatusLink (1).png>)
+
+* Look for the “latest\_block\_height” field
+
+![](../.gitbook/assets/rpcStatusVerification.png)
+
+* Open Mintscan, a popular blockchain explorer, to compare the captured “latest\_block\_height” value to the latest block displayed in the explorer&#x20;
+* The block height from the Akash Node and Mintscan will not be exactly match but should be close to each other
+
+[**Mintscan - Akash Stats**](https://www.mintscan.io/akash)
+
+![](../.gitbook/assets/mintscanBlockHeight.png)
+
+#### Confirm Peer Nodes
+
+* Navigate back to the home page for your Node&#x20;
+* Click the link for “net\_info”
+
+![](../.gitbook/assets/rpcNetInfoLink.png)
+
+* Find the section with the name of “peers”&#x20;
+* Here we can determine what other Akash nodes our node is connected to and the status of these connections
+
+![](../.gitbook/assets/rpcNetInfoData.png)
+
+## Additional Information
+
+### Cosmos Omnibus Repository
+
+* The repository for the Akash Cosmos Omnibus project:
+
+{% embed url="https://github.com/ovrclk/cosmos-omnibus" %}
+
+### Akash SDL
+
+* The Akash manifest/SDL used in this guide:
+
+{% embed url="https://github.com/ovrclk/cosmos-omnibus/blob/master/akash/deploy.yml" %}
+
+### Chain JSON Config File
+
+* The config file used for the genesis URL, seed nodes, etc:
+
+{% embed url="https://raw.githubusercontent.com/ovrclk/net/master/mainnet/meta.json" %}