Akashlytics Deploy (Desktop App)

Akashlytics Deploy Overview

Akashlytics Deploy is a desktop application which simplifies the deployment of workloads onto the Akash Network. Post deployment the Akashlytics Deploy provides a dashboard to view the status and details of workloads. The deployment dashboard additionally grants the ability to perform administrative tasks including closing the deployment, updating the deployment’s underlying manifest/redeploying workload, and increasing the funding available to the deployment.
The guide which follows covers the following topic areas to allow developers initial exploration of Akash deployments utilizing the Akashlytics Deploy application.
    Akashlytics Deploy Installation and Initial Configuration
      Akashlytics Deploy installation package location and download instructions
      Akashlytics Deploy installation on MacOS detailed procedure
      Akashlytics Deploy installation on Windows detailed procedure
      Initial Akashlytics Deploy configuration relevant regardless of installation platform
    Detailed walkthrough of a WordPress deployment onto the Akash network using Akashlytics Deploy
    Detailed walkthrough of closing the previously deployed WordPress instance

Akashlytics Deploy Installation

Software Access and Download Instructions

The Akashlytics Deploy software may be found at the project’s documentation site and via the URL provided below. Application download for Windows and MacOS platforms may be provoked from the Download section of the landing page and as depicted below. Choose the download appropriate for your intended platform.

MacOS Installation Details

The installation of the Akashlytics Deploy application on MacOS is a rather simple process but details of the procedure are provided to ensure clarity.

STEP1 - Locate the Downloaded DMG File

    Following the provoke and completion of the Akashlytics Deploy package download the MacOS DMG file would most likely land with the Downloads directory as depicted below.
    Locate the DMG file on your machine and double-click the file to initiate installation.

STEP2 - Move Akashlytics Deploy to the Applications Directory

    Upon successful application installation - MacOS will prompt the user to move the Akashlytics Deploy shortcut to the Applications directory allowing ease of invoke from the MacOS Finder utility
    Drag and drop the Akashlytics Deploy icon into the Applications folder when the prompt/screen depicted below is provided

STEP3 - Initial Akashlytics Deploy Launch

    With the installation of the Akashlytics Deploy software completed - open the MacOS Finder utility and type “akashlytics deploy” to locate the installed application
    Double click the Akashlytics Deploy icon for initial application launch as depicted below

STEP4 - Override of the MacOS Unidentified Developer Warning

    Upon initial launch attempt of Akashlytics Deploy a MacOS “unidentified provider” warning - as depicted below - will provoke
    The warning is received - as indicated explicitly in the accompanying language within the warning prompt - due to Akashlytics Deploy software not presently a member of the App Store.
    As this software is created, maintained by the Akash community and deemed safe for use - steps will be followed to allow navigation around this warning.
    Following the steps outlined and executed the warning message should not provoke in any future attempts to launch the application within MacOS.
    Click the Question Mark (“?”) icon provided on the warning message and continue with the subsequent steps below.
    With the Question Mark (“?”) icon was selected - MacOS provides the explicit instructions depicted below - detailing the manner in which a user may circumvent the “unidentified developer” warning encountered.
    In the steps that follow those precise instructions will be followed.
    Press “Ok” to exit the warning message dialog box.
    As suggested by the MacOS instructions in proceeding with the “unidentified developer” application installation - locate Akashlytics Deploy within the MacOS Finder utility and Control-Click the icon and select “Open” as depicted below.
    Launching the application in this manner prompts the user with an “unidentified developer” dialog box and allows proceeding with the launch as depicted below.
    Proceed with application launch via the “Open” button.
    The MacOS installation and launch is completed with this final step. Proceed to the “Initial Configuration - All Operating Systems” to commence Akashlytics Deploy initial configuration.

Windows Installation Details

The installation of the Akashlytics Deploy application on Windows platforms is a rather simple process but details of the procedure are provided to ensure clarity.
The installation steps captured in the steps and screenshots that follow were conducted on a Windows Server instance but the application install should be nearly identical on other Windows Platforms (I.e. Windows 10).

STEP1 - Locate the Downloaded Application File

    Following the provoke and completion of the Akashlytics Deploy package download the application file would most likely land with the Downloads directory as depicted below.
    Locate the application file on your machine and double-click the file to initiate installation.
STEP2 - Windows Defender Warning
    Depending on the Operating System version and installed/enabled security tools - Windows Defender may initially prevent installation and display a warning message of an “unrecognized app” as depicted below.
    As this software is created, maintained by the Akash community and deemed safe for use - steps will be followed to allow navigation around this warning.
    Expand the available options on the warning prompt and select “Run anyway” as depicted below.
    Accept the default to expose the software only to the current user within the “Choose Installation Options” screen and as depicted below.
    Proceed through the remainder of the installation process accepting defaults until the following, final installation screen is encountered.
    Within the “Completing Akashlytics Deploy Setup” section - check the “Run Akashlytics Deploy” option (likely selected by default) to launch the application upon installation completion and then select “Finish” as depicted below.
    The Windows OS installation and launch is completed with this final step. Proceed to the “Initial Configuration - All Operating Systems'' to commence Akashlytics Deploy initial configuration.

Akashlytics Deploy Initial Configuration - All Operating Systems

In the section that follows detailed steps are provided pertaining to the initial configuration of Akashlytics Deploy. The initial steps in configuration to ready the application for Akash deployment creations are brief and include the following:
    Import an Existing Wallet funded with sufficient AKT to allow workload deployments
    Validation of funded Akashlytics Deploy instance and valid certificate to allow deployments

STEP1 - Import Existing Wallet

    An existing wallet import is necessary to fund Akashlytics Deploy deployments to the Akash network
    The import may be conducted via pre-existing wallet’s mnemonic as depicted below
    Remaining configuration attributes required within this step:
      Choose a name for this wallet
        May be any useful, descript name of the wallet instance as it appears in Akashlytics Deploy
        A password to protect access to the wallet’s funds within Akashlytics Deploy. Password entry will be necessary whenever the Akashlytics Deploy application is closed and then re-launched.

STEP2 - Validation of Wallet Funding and Certificate

    Following successful import of an existing wallet the Akashlytics Deploy application display as depicted below
    Note regarding wallet funding:
      The funds available in the pre-existing wallet instance should now be available to Akashlytics and displayed in the upper left corner of the application (52.943 AKT in the provided example)
      Should a need arise to delete the wallet - for the purpose of introducing a new wallet - the deletion may be conducted via the triple dot icon to the right of the wallet instance on this screen.
    Note regarding Certificate:
      Most likely the Certificate section - upper right hand corner as depicted below - will report no valid certificate found on initial application access.
      A new certificate may be generated by selecting the triple dot icon to the right of the Certificate status representation.

Create a Deployment

In this section a WordPress application will be deployed onto the Akash network using Akashlytics Deploy. The example will provide illustration of the ease in deployment utilizing the Akashlytics Deploy application as contrasted to the somewhat burdensome processes utilizing CLI instances necessary prior. While the example is rather simple in using a predefined (Stack Definition Language) SDL file - identical processes may be followed for complex deployments using highly customized manifest for subsequent needs.

STEP1 - Create the Deployment Instance

    From the Dashboard pane select the “CREATE DEPLOYMENT” button as depicted below
    Note - the CREATE DEPLOYMENT option from the Dashboard pane would only be present when there are no pre-existing, active deployments. Future deployment creation should be conducted within the Deployments pane where an identical “CREATE DEPLOYMENTS” button and option are available.

STEP2 - Checking Deployment Pre-Reqs

    Following the provoke of a deployment creation - the initial, subsequent pane in the creation process validates the requirements to proceed as depicted in the capture below.
    Deployment requirements and associated validations include:
      5AKT are available in wallet/escrow account
      Valid certificate (on chain and matching cert locally)
    Select the “CONTINUE” button

STEP3 - Choose Template

    Within this example and to provide a simple starting point in Akashlytics Deploy usage - the example WordPress template and associated SDL are utilized as depicted below
    Akashlytics Deploy provides several sample templates for initial exposure and experimentation including Games (Supermario, Minecraft, etc) and General (Wordpress, Hello-World, etc)
    Note that to deploy a custom application the Empty template may be selected and then custom SDL would be specified in subsequent steps that follow
    Press “CONTINUE” with the Wordpress template selected

STEP4 - Create Deployment

    Constitutes the final configuration step in the deployment creation process
    Within this section the sample SDL may be edited for minor adjustments or could be completely replaced for custom application deployment
    Note the hyperlink provided for SDL referencing needs for those interested in custom deployments
    In the current example only a minor edit to the SDL will be conducted and is necessary. The domain name in the SDL’s “expose” stanza must be updated.
    In production use the domain name should be updated to an actual resolvable name. But for experimentation purposes the domain name may be updated to a factius convention.
    In the depictions below the SDL pre and post domain name manipulation are both provided for clarity.
    Following the domain name adjustment - enter a name for your deployment in the bottom pane and as instructed and then press “CREATE DEPLOYMENT” as depicted in the second capture below.
Pre-Domain Name Edit Screen
Post-Domain Name Edit Screen

STEP5 - Create Deployment Transaction

    Following the initiation of deployment creation the following screen will appear allowing selection of Gas Fees and to allow the deployment transaction on chain to proceed
    Additional information is provided including the DSEQ/deployment identifier and the deposit amount - in AKT - necessary for the deployment
    Leave the default selection for Gas Fees and select “APPROVE” as depicted below
    The process to write the transaction to a block in the chain may take a couple of minutes to complete

STEP5 - Review/Accept Bids

    Available/offered provider bids are provided in a list allowing the tenant to select the most attractive details for a subsequently created lease
    Select the most affordable lease for this example deployment as depicted below and then press “ACCEPT BID”

STEP6 - Create Lease Transaction

    Following the selection of a provider bid the following screen will appear allowing selection of Gas Fees and to allow the lease transaction on chain to proceed
    Leave the default selection for Gas Fees and select “APPROVE” as depicted below
    The process to write the transaction to a block in the chain may take a couple of minutes to complete

STEP7 - Lease Confirmation

    Following deployment the details of the lease are exposed and displayed as depicted below
Lease intel revealed includes:
    The status of the lease
    Exposed URLs if applicable and pertaining to web applications
    Note that both the domain name provided in the SDL and an auto generated domain name from Akash are exposed
    Click the icon to the right of the Akash URL which provokes an attempt to load the page in the browser for further validation of deployment
    Note - the Wordpress site may take a couple of minutes to load depending on the status of the deployment
    Expected result of URL provoke

Manage Deployments

Akashlytics Deploy provides significant management capabilities of active deployments via the following mechanisms covered in this section:
    Dashboard overview of active deployments with hardware profiles at a glance
    Drill downs into active and closed deployments revealing status, escrow balance, amount spent, and lease time/duration left
    Ability to add funds to existing deployment’s Escrow Account
    Close an active deployment

Deployment Dashboard Overview

    The Akashlytics Deploy Dashboard may be viewed via the selection of the associated tag in the left hand navigation pane as depicted below
    The Dashboard provides an overview of active deployments
    Beneath a specific, active deployment provisioned hardware of the workload is revealed

Deployment Granular Details

    Deep inspection of a deployment may be conducted via drilling into the deployment of interest in either the Dashboard or Deployments left hand menu options
    In this demonstration the Deployments pane will be utilized as depicted
    Drill into/click a deployment of interest to reveal granular details of the instance
    Amongst a wealth of intelligence revealed pertaining to the active deployment note the highlighted details in the depiction:
      Escrow Balance - reveals the current funding available to the deployment
      Time Left - indicates the current provider lease lifespan
      Cost/Month - workload approximation of the cost per month in AKT

Add Funding to Active Deployment

The Deployment Granular Details section revealed the procedures to validate a deployment’s current Escrow Balance. The funds available to a deployment may be updated via the following procedure and thus increasing the Escrow Balance.
    Navigate to Deployments in the left hand navigation pane and drill into an active deployment of interest
    Within the arrived upon Deployment Detail location an “ADD FUNDS” option is available as depicted
    Select “ADD FUNDS” to explore the subsequent options
    A dialog box is presented affording the ability to add AKT funds available in the associated wallet to the deployment’s escrow account
    The amount of AKT to add may be specified by manually entering an amount or via the use of the up/down arrows on the far right of the dialog box
    Select the DEPOSIT button once the desired amount is reflected
    A pane will be presented allowing selection of gas fees for the on chain transaction
    Select the AVG gas fee (default) and press “APPROVE” as depicted
    Upon successful transaction completion the add funds are reflected in the updated Escrow Balance
    In the example provided the Escrow Balance increased from 5 AKT to 10 AKT as expected

Close Active Deployment

The closure of a deployment may be executed via the following steps:
    Visit the Deployments pane to list all active and closed instances
    Select/click the deployment desired for closure
    Select the triple dot icon to the right of the “ADD FUNDS” button
    A Close option will be exposed. Select this option to close the deployment.
    Steps for deployment closure are depicted below
    Confirmation of deployment closure from the Deployments pane
Last modified 29d ago