Configure Ax Controller

Installation

Follow the Installation guide to install the Ax Controller

ax configure

Setup and configure the ax controller and validate your cloud account ๐Ÿ’ป

Example Usage

ax configure --run

Launch the interactive configuration workflow will step you through the following:

  • Install dependencies

  • Add ax to your shell profile

  • Ask to occasionally check for updates in the background

  • Set up access to your chosen cloud provider

Usage

run ~/.axiom/interact/axiom-configure if ax is not yet in your shell path.

# axiom-configure --help

 โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ•—   โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—
โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ•šโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•    โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•”โ•โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•‘ โ•šโ–ˆโ–ˆโ–ˆโ•”โ•     โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ–ˆโ–ˆโ•— โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ–ˆโ•—
โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•‘ โ–ˆโ–ˆโ•”โ–ˆโ–ˆโ•—     โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘โ•šโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘
โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ• โ–ˆโ–ˆโ•—    โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘ โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•‘     โ–ˆโ–ˆโ•‘โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•
โ•šโ•โ•  โ•šโ•โ•โ•šโ•โ•  โ•šโ•โ•     โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•  โ•šโ•โ•โ•โ•โ•šโ•โ•     โ•šโ•โ• โ•šโ•โ•โ•โ•โ•โ•

Maintainer: 0xtavian

๐“ช๐“ต๐“ป๐“ฒ๐“ฐ๐“ฑ๐“ฝ, ๐”‚๐“ธ๐“พ ๐“ฐ๐“ธ๐“ฝ ๐“ถ๐“ฎ, ๐“ฒ๐“ฝ๐“ผ ๐“ณ๐“พ๐“ผ๐“ฝ ๐“ช๐”๐“ฒ๐“ธ๐“ถ: ๐“ฝ๐“ฑ๐“ฎ ๐“ญ๐”‚๐“ท๐“ช๐“ถ๐“ฒ๐“ฌ ๐“ฒ๐“ท๐“ฏ๐“ป๐“ช๐“ผ๐“ฝ๐“ป๐“พ๐“ฌ๐“ฝ๐“พ๐“ป๐“ฎ ๐“ฏ๐“ป๐“ช๐“ถ๐“ฎ๐”€๐“ธ๐“ป๐“ด ๐“ฏ๐“ธ๐“ป ๐“ฎ๐“ฟ๐“ฎ๐“ป๐”‚๐“ซ๐“ธ๐“ญ๐”‚! - @๐“น๐“ป๐”‚0๐“ฌ๐“ฌ @0๐”๐“ฝ๐“ช๐“ฟ๐“ฒ๐“ช๐“ท

Description:
Examples:
  axiom-configure --run # kick off Ax configuration wizard
  axiom-configure --shell zsh # Set default shell to zsh via command line
  axiom-configure --config <personal.json file> # Use personal.json from a file for account setup
  axiom-configure --config <personal.json string> # Use personal.json data supplied by command-line for account setup (must be vaild personal.json data wrapped in single quotes)
  axiom-configure --shell bash --unattended --config <path to personal.json file>  # Use bash for default shell, do not promot, use personal.json data from file for axiom setup
Usage:
  --run (required)
    Start axiom-configure wizard, install dependencies, kick off axiom-account-setup and axiom-build
  --config <axiom.json data>
    Setup account with data from file or supplied from the command line (must be vaild data from a personal.json axiom file)
  --unattended (optional)
    Avoid any promots, defaults to Oh My Zsh unless --shell argument is also provided
  --shell <bash, zsh, omz (Oh My Zsh)> (optional)
    Add axiom to path, backup .zshrc/.bashrc to .zshrcbak/.bashrcbak
  --auto-update <yes, no> (optional)
    Toggle auto-update to periodically update axiom
  --debug (optional)
    Enable debug mode (VERY VERBOSE!)
  --help
    Display this help menu

You can provide your config inline or after running axiom-configure. axiom-configure --shell bash --unattended --config { "do_key": "[redacted]", "region": "nyc1", "provider": "do", "default_size": "s-1vcpu-1gb", "appliance_name": "", "appliance_key": "", "appliance_url": "", "email": "", "op": "[redacted]", "imageid": "axiom-default-myimageid", "provisioner": "default", "sshkey": "id_rsa" }

To get your account.json config file in this format run: cat ~/.axiom/accounts/do.json | tr '\n' ' ' | tr -s ' '

Cloud Configuration

During the initial installation, running ax configure will trigger ax account-setup, which in turn calls ax account along with the respective cloud provider's account-helper script. Once this setup is complete, ax build is executed to create your Packer image. After the image is successfully built, you can deploy fleets of servers using ax fleet and distribute scans with ax scan!

You can also just run axiom account-setup at any time.

$ ax account-setup 
Axiom Account Setup
You can use this wizard to add new accounts, once made, use axiom-account to switch between profiles
Please enter your provider (aws, azure, do, gcp, hetzner, ibm, linode, scaleway): 

Last updated