sandbox-starter

Spin up cloud networks in minutes

About

To learn about Sandbox Starter, visit its Aviatrix Community space

Prerequsites for local development

Building sandbox starter has several workstation or user prerequsites.

• The local workstation requires a docker installation
  • For macOS homebrew installation

    brew cask install docker

• Aws credentials for testing controller launch and transit deployment in AWS.
• Azure credentials for testing transit deployment and cross-cloud transit peering.
• An EC2 key pair in the Ohio (us-east-2) and N Virginia (us-east-1) regions.
• Subscription to the Aviatrix metered software from the AWS Marketplace (Unless launching the controller as BYOL).

Building the sst docker image locally

To build the sst docker image, update the makefile version variable and execute:

make build

Launching the sst docker image locally

To run the sst docker image from a built make build, execute:

make run

Removing the sst docker image locally

To start over and clean your system of built sst docker images, execute:

make clean

Lauching the latest version of sst in AWS using terraform

To run the Sandbox Starter in AWS with a pre-built sst AMI using terraform:

git clone https://github.com/AviatrixSystems/sandbox-starter.git
cd ./sandbox-starter/infra-ami

Be sure to update variables.tf to specify your region and ec2 keypair name. Then:

terraform init
terraform apply

The url for the sandbox starter is output from terraform.

Lauching sst with the BYOL version of the Aviatrix controller

To run the Sandbox Starter with a BYOL (bring your own license) controller:

	docker volume create TF
	docker run -v TF:/root -p 5000:5000 -d aviatrix/sandbox-starter:latest
	docker exec $(docker ps -aqf "ancestor=aviatrix/sandbox-starter") sed -i 's/"meteredplatinum"/"BYOL"/g' /root/controller/aviatrix-controller-build/variables.tf

Or, from this cloned repository:

  make run-byol