Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 4.48 KB

README.md

File metadata and controls

90 lines (65 loc) · 4.48 KB
Raw

Akash Mass Deploy

Akash Mass Deploy is a console app for managing a large number of deployments on Akash Network™ infrastructure.

Motivation

The tools available for deploying workloads to Akash, the desktop app Akashlytics Deploy, the web app Akash Deploy, and the native command-line interface, are ideal for single deployments but aren’t suited to orchestrating multiple deployments.

The Akash Mass Deploy app was developed to run a Massive® testnet across the network and can be used to automate similar mass deployments.

Summary

Akash Mass Deploy extends the command-line interface to add coordination functions by connecting to an Akash-loaded Linux instance over SSH.

Deployments are created with the user-supplied Akash wallet, certificate, and configuration files; active deployments are maximized by closing any that become stale and by maintaining a list of providers that fail repeatedly for the deployment configuration so should be avoided later on.

Configuring

  1. Install Akash on the target Linux instance.
  2. Create an Akash wallet.
  3. Create and publish a certificate for the wallet.

Usage

The deployment mode is determined by one of the following command-line arguments:

  • [none] – creates the number of deployments CREATE_DEPLOYMENTS with the number of cores per deployment DEFAULT_CORES given by the config.js file
  • manifests – updates all active deployments with the current deploy.yml file
  • deposits – tops up all active deployments, to 5 AKT currently
  • cleanup – tears down all nonfunctioning deployments
  • info – returns the state of all deployments

Limitations

Akash Mass Deploy is experimental at the moment and, in particular:

  • Can control no more than 500 simultaneous deployments and doesn’t support paging
  • Prompts for a password on first run, via dialog box if AKASH_KEYRING_BACKEND is set to (the default) os or via command line if set to file
  • Retries most Akash commands up to 3x but still doesn’t account for all intermittent failure modes, like those involving connectivity problems
  • Has been developed in MonoDevelop for Linux and hasn’t been tested in Windows

C# class details

The following classes define important functionality:

  • MainClass – is the app entry point
  • EnvVarsReplacer – evaluates environment variables, caching for future use any that are set
  • ClientSSH – manages the SSH connection
  • Wallet – stores Akash wallet info
  • Instance – creates, updates, and tears down deployments
  • InstanceList – batches deployment commands and results, refilling and releasing funds as needed
  • Converters – performs various data conversions

License

Copyright 2022 Massive Computing, Inc.

This program is free software, excluding the brand features identified in the Exceptions below: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Exceptions

The Massive logos, trademarks, domain names, and other brand features used in this program cannot be reused without permission and no license is granted thereto.

The referenced Akash Network name, logo, and service names are trademarks or trade dress of Overclock Labs, Inc.; any use thereof is subject to their own license terms.