Web App

Akash Deploy Overview

Akash Deploy delivers a web application allowing for easy deployment on the Akash Network.
Akash Deploy is an open-source project written in ReactJS. The repository for the application is listed below. However a demo of the app is available if you want to jump right in. For our walkthrough we will be using the demo site.

Prepare the Environment

The Akash Deploy app integrates with the popular Keplr wallet. Keplr is a simple, open-source browser extension wallet for the Cosmos interchain ecosystem. It also happens to have full support for the Akash blockchain. We will cover the setup of the keplr wallet.

Keplr Wallet Browser Extension Guidance

The Keplr wallet extension for Chrome may be found at the following location:
Keplr
After you have installed the extension the Keplr wallet should appear in the browser extension tray. To open the wallet simply click on the keplr icon in the extension tray.

Ensure Adequately Funded Keplr Wallet

  • To check your funds simply open the extension and select Akash from the dropdown at the top of the app
  • A minimum 5 AKT is needed to fund a deployment’s escrow account
  • For the next section we will assume you have the required funds in the wallet

Initial Akash Deploy Access and Configuration

We will use a demo Akash Deploy site for this guide. To access the site go to the following URL
If all worked as intended you should see something like this.

Linking Keplr to The Deploy Tool

  • When launching the tool for the first time Keplr will prompt you for permission to link the wallet to the tool.
  • Go ahead and approve the link

Create Certificate for Transactions

The Akash Deploy instance must have access to a certificate to sign transactions placed onto the blockchain. Since this is our first time using the tool no such certificate exists. Let’s create one now.
  • Click the “CERTIFICATE” tab
  • In the dialog box that appears select the “CREATE” button
  • On certificate creation, Keplr will prompt to accept gas fees for the transaction.
  • Accept the default gas fees by clicking the “APPROVE” button.
Note - All transaction processes that interact on chain may take a few seconds to complete.
  • Once the process completes you should see a valid certificate as in the screenshot below

Deployment of Sample Workload

When first launched, the Akash Deploy application displays an editing pane prepopulated with Stack Definition Language (SDL) for the Lunie Light application. The sample application (Lunie Light) is a non-custodial, web wallet for Akash. This is one of many pre-built deployments to choose from. In subsequent sections, we will take a quick look at additional applications/SDLs within the Akash Deploy Gallery.

Steps in Application Deployment

SDL Edit/Deploy

  • Make sure you are on the “DEPLOY” page from the top toolbar and as depicted below
  • Akash Deploy has the default Lunie Light SDL in the code editor.
  • For our example today we can simply click the “DEPLOY” button.
  • Once the process starts a Keplr prompt will popup requesting acceptance of the deployment’s transaction gas fees.
  • Accept the default gas fee selection to allow deployment to proceed.
  • Once you have accepted the fees notice the status change to “waiting for bids” as the provider bids are collected.

Provider Selection

  • Select a provider from the list of submitted bids
  • Press “SUBMIT” once the preferred provider has been selected
  • A transaction gas fee prompt will pop up. Feel free to accept the defaults.
  • Once a bid is accepted the status message will run through the following steps “Confirming the lease” > “Querying the provider” > “Sending the manifest” > “Querying lease status”.
  • Once the bid has been accepted and the deployment setup an information window will pop up for the new deployment. A couple things to note:
    • Number of workload replicas
    • Available replicas
    • In the case of web services workloads the exposed URI

Testing Our Deployment

  • Copy the URI from the popup window
    • Note - if the deployment information detail panel was closed - the URI may be found by navigating to “MY DEPLOYMENTS” from the toolbar and then clicking the info “I” icon next to the relevant deployment.
  • Paste the URI into a browser window and hit enter
    • Note - if a 502 Bad Gateway HTTP response is returned - continue refreshing the page for a few seconds as the workload may not yet be fully deployed on the provider.
  • Once the page loads you should see something like this

Manage Deployments

With Akash Deploy you can not only deploy but also manage, monitor, and close active workloads.
Monitoring and managing deployments from Akash Deploy is often easier than performing the same operations within the Akash CLI, particularly across many deployments.

View Active and Inactive Deployment Details

Akash Deploy allows you to view active and inactive deployments.
  • Navigate to “MY DEPLOYMENTS” from the toolbar.
  • Toggle the “Show Inactive” button
  • Active deployments are represented by a red filled circle containing a cloud icon.
  • Inactive deployments are represented by a grey filled circle containing a cloud icon slashed.
  • To see additional information on an active deployment’s lease, select the information (“i”) icon.
Note that the information revealed is identical to the information first displayed when the deployment process completed and includes details such as replica count, available replicas, and URI if applicable.
  • For a more detailed block of information regarding the deployment click on the Deployment identifier (DSEQ) or anywhere in the white space to the right of the DSEQ.
  • The revealed information is displayed in a rather lengthy JSON string and includes:
    • Hardware utilized by the deployment (CPU/mem/disk)
    • Escrow Account information including current balance
    • Deployment details (DSEQ, OwnerID, etc)

Close a Deployment

Akash Deploy makes it simple to close a deployment. Follow the steps provided below to terminate the instance.
  • Navigate to “MY DEPLOYMENTS”
  • Close the deployment of interest by selecting the trash can icon on the deployment’s row.
  • Approve related transaction gas fees within Keplr
  • Deployment now displays as closed and remaining funds in the deployment’s escrow have been returned to the Keplr wallet

SDL Gallery

Akash Deploy has a rich selection of pre-defined SDL definition files for all kinds of popular software packages. Within this section we will access the SDL Gallery, review the gallery categories, and use a specific SDL definition for additional deployment experience.
  • Navigate to the “SDL GALLERY” tab from the toolbar

Exploring SDL Categories and Available Software Deployments

Scroll through the SDL Gallery’s available categories and related definition files to reveal a wealth of available applications.
  • SDL categories include :
    • Official
    • DeFi
    • Blogging
    • Games
    • Databases and Administration
    • Hosting
    • Continuous Integration
    • Project Management
    • Tools
    • Wallet
    • Build with Cosmos SDK
    • Media
    • Data Visualization
    • Chat
  • Locate the “supermario” SDL file via the search bar at the top of the Gallery page and then click on the “SOURCE” link as depicted below. This will open the git repository that the file lives in.
In the prior section the SuperMario SDL was selected. We will now use the SDL to deploy the SuperMario app on the network.
  • Return to the Akash Deploy application and select the SuperMario SDL’s “DEPLOY!” option.
  • This will redirect us to the “DEPLOY” pane with the SuperMario SDL now loaded within the code editor
  • Click “DEPLOY”.
  • Approve the gas fees and transaction within Keplr.
  • Select a provider and press “SUBMIT”
  • Approve the gas fees and transaction within Keplr again.
  • Copy the URI from the deployed workload informational screen.
  • Allow a couple of minutes for the deployment to complete build and then visit the URI in a web browser.
  • You should see something similar to the following
Last modified 1mo ago