wiki
  • 👋Welcome to the Ax Framework Wiki
  • Overview
    • ✅Existing Users
    • 💿Installation Guide
    • 💻Ax Controller
    • 💡How it Works
    • ▶️QuickStart Guide
      • Configure Ax Controller
      • Build a Base Image
      • Deploy Instances
      • List Instances
      • Run Scans
      • Teardown Instances
  • Fundamentals
    • 🛠️Ax Utility Scripts
    • 🔎Bring Your Own Provisioner
    • ⚔️Fleets
    • 🚀Scans
      • 🤖Modules
        • 📤Adding Simple Modules
        • 🎯Adding One-Shot Modules
        • 📎Merging and Module Extensions
      • ⚙️Horizontal vs Vertical Scaling
    • 🤝Responsibility
    • 📖Terminology
Powered by GitBook
On this page
  1. Fundamentals

Fleets

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.

PreviousBring Your Own ProvisionerNextScans

Last updated 9 months ago

ax fleet

Initialize a fleet

axiom-fleet usage
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
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 
⚔️
🚀