Deploy Instances

Deploy one instance with axiom-init or several with axiom-fleet

Example Usage

axiom-init: deploy one instance

Use axiom-init to deploy one instance

axiom-init --run # provision instance with random name
axiom-init testy01 # provision instance named testy01
axiom-init stok01 --region nyc3 --image axiom-barebones-1635920849 --size s-1vcpu-2gb --deploy desktop --shell

axiom-fleet: deploy several instances in a fleet

Use axiom-fleet to deploy several instances as a fleet.

axiom-fleet -i 13 # Initialize a fleet, name it randomly
axiom-fleet testy -i 8 # Initialize a fleet named 'testy', instances will be named, testy01, test02 etc
axiom-fleet testy -i 10 --regions nyc1,lon1,ams3,fra1 # Initialize a fleet using round-robin region distribution 

Usage

axiom-init

Initialize a single instance 🌱

Description:
Initialize one axiom instance with differnet options, such as image, region, size and axiom deployment profile
Examples:
axiom-init # provision instance with random name
axiom-init --deploy desktop # provision instance with random name, then deploy axiom profile 'desktop'
axiom-init testy01 # provision instance named testy01
axiom-init stok01 --region nyc3 --image axiom-barebones-1635920849 --size s-1vcpu-2gb --deploy desktop --shell
Usage:
<name> string (optional)
  Name of the instance, supplied as a positional first argument
--image <image name>
  Manually set the image to use (default is imageid in ~/.axiom/axiom.json)
--region <region>
  User specified region to use (default is region in ~/.axiom/axiom.json)
--deploy <profile>
  Deploy a profile after initialization (e.g desktop, openvpn, bbrf, wireguard)
--shell (optional)
  Connect to instance after initialization
--size <vm size>
  VM size to use  (default is size in ~/.axiom/account/account.json)
--no-select (optional)
  Dont select instance after initialization (default is to select instance)
--domain <example.com>
  Manually specify the domain to use (default is specified by cloud provider)
--restore <backup>
  Initialize with a previous backup
--help
  Display this help menu

axiom-fleet

Spin up fleets of axiom instances

Description:
  Spin up fleets of axiom instances in one or multiple regions.
  Specify the name of your fleet (fleet prefix) or have axiom choose for you.
Examples:
  axiom-fleet ctbb  # Spin up 3 instances named ctbb01 ctbb02 and ctbb03
  axiom-fleet -i 10 # Spin up 10 instances with random fleet prefix
  axiom-fleet jerry -i 25 --regions dal13,lon06,fra05 # Spin up 25 instances named jerry01 to jerry25 using Round-robin region distribution
Usage:
  <fleet prefix> (optional)
    Name of fleet prefix (default is random fleet prefix)
  -i/--instances <required integer>
    The number of instances to spin up
  -r/--regions <regions> (optional)
    Supply comma-separated regions to cycle through (default is region in ~/.axiom/axiom.json)
  --image <image name> (optional)
    Manually set the image to use (default is imageid in ~/.axiom/axiom.json)
  --debug (optional)
    Run with set -xv, warning: very verbose
  --help (optional)
    Display this help menu