AWS Startup Guide¶
Welcome to getting started on AWS! This guide takes you through the 3 steps to launch the Controller instance. When complete, you’ll be ready to deploy use cases.
You can also watch a video for this startup guide.
The Aviatrix Controller must be launched by a cloudformation script provided by Aviatrix. Follow the instructions in this document to launch the Controller. Do not launch the Controller instance from AWS Console.
Step 1. Subscribe to an Aviatrix AMI¶
If you have already subscribed the Metered AMI on AWS Marketplace, skip this step and proceed to Step 2.
1.1 Subscribe to the AMI¶
Click the AMI link below to take you to the AWS Marketplace to complete step 1.1 and 1.2. (Open a new tab on the selected AMI so you can follow along with this guide.)
1.2 Continue to Subscribe¶
Click Continue to Subscribe. Subscribing means that you can begin deploying the software in later steps via the CloudFormation template.
1.3 Accept Terms¶
Click Accept Terms. Return to this guide and continue. (Do not proceed to Continue to Configuration))
Step 2. Launch the Controller with CloudFormation¶
2.2 Login to AWS Console¶
If you have not logged in, you will be prompted to login to AWS console.
2.3 Change to the region¶
Change to the region where you would like to install the Aviatrix Controller on the CloudFormation page. Note the CloudFormation is already loaded.
2.4 Click Next¶
2.5 Fill in the following fields¶
- the Stack name,
- select a VPC in the drop down menu,
- select a public subnet in that VPC (Go to AWS VPC console to make sure the public subnet is indeed in your selected VPC. A public subnet must have a default route point to IGW in its associated VPC route table. Read this link if you do not know what public subnet is.)
- and a keypair (Read how to create a keypair to create a keypair in AWS EC2 console if this field is blank.)
The Aviatrix Controller must be launched on a public subnet. If this is the first time you launch an Aviatrix Controller, select the default setting New for IAM Role Creation. If an Aviatrix IAM role has been created before, select aviatrix-role-ec2 for IAM Role Creation. The Aviatrix Controller instance is termination protected.
2.6 Select instance size¶
Leave the Controller Size at t2.large and keep the IAM role creation at “New” unless you have already created the Aviatrix IAM roles.
For more information on Controller instance size selection, refer to Controller sizing recommendations..
2.7 Click Next¶
2.8 Click acknowledge¶
Click the checkbox next to “I acknowledge that AWS CloudFormation ...” and then click Create.
2.9 Check stack output¶
Once the stack creation completes (Status change to CREATE_COMPLETE), click on the Outputs tab. The values displayed will be needed when configuring primary access account in Aviatrix. (You might have to refresh your browser window and/or AWS console to see your Stack show up and the Status to be updated).
Step 3. Onboarding¶
Now that Aviatrix Controller instance has been launched, let’s login and go through the onboarding process.
3.1 Access the Controller¶
Open a browser window to https://AviatrixControllerEIP, where AviatrixControllerEIP can be found in the Stack Outputs. You can also find the Controller instance EIP by going to AWS EC2 console, click the Controller instance and locate its public IP address.
You may receive a warning that the connection may not be secure. This is because the certificate is self-signed by the Controller. It is safe to continue to the page.
3.2 Login with the username admin¶
For the password field, use the AviatrixControllerPrivateIP. The AviatrixControllerPrivateIP can be found in the Outputs section of the CloudFormation stack. You can also find the Controller instance’s private IP address by going to AWS EC2 console, clicking the Controller instance and locating its private IP address.
3.3 Enter your email address¶
This email will be used for alerts as well as password recovery (if needed).
3.4 Change password¶
Next, you will be prompted to change the admin password.
3.5 Click Run¶
Finally, the Controller will upgrade itself to the latest software version after you click on Run. Wait for a few minutes for the process to finish.
The Controller upgrade takes about 3-5 minutes. Once complete, the login prompt will appear. Use the username admin and your new password to login.
If you wish to run a custom version, consult the Aviatrix support team before attempting it.
3.6 Select AWS¶
Once logged back into the Controller, you should be on the Onboarding page. You can also do this by clicking “Onboarding` on the navigation item. Then click the AWS icon.
3.7 Setup a primary access account¶
The Aviatrix primary access account contains the following information:
- The Controller instance’s AWS 12 digit account ID.
Check out this link if you have questions regarding Aviatrix access account.
Fill out the fields as follows: (The AWS Account Number can be found at the Stack Outputs section or get from this link.)
Field Expected Value Account Name Enter a name that is unique on the Controller. Example name: AWSOpsTeam. AWS Account Number The Controller instance’s 12 digit AWS account number. It can be found in the Stack Outputs section AccoundId. IAM role-based Check this box.
Once complete, click the Create button at the bottom of the form.
Next: Start a Use Case¶
You are now ready to deploy use cases. Here are some of the things you can do:
- Build Net-Gen Transit Network for AWS
- Build Egress Security
- Build User SSL VPN
- Build Site to Cloud VPN
- Build Multicloud Peering
- Build Encrypted Peering
- Build Firewall Network
- Aviatrix Overview.
Any resources created by the Controller, such as Aviatrix gateways, route entries, ELB, SQS queues, etc, must be deleted from the Controller console. If you delete them directly on an AWS console, the Controller’s view of resources will be incorrect which will lead to features not working properly.
For technical support, email us at email@example.com
Other Aviatrix Products¶
In addition to Metered AMI, we offer a few others, as shown below. Subscribe to them on AWS Marketplace and then come back to this section to click on the CloudFormation script to launch the Controller.
Additional Information for Controller¶
- Controller sizing Controller instance sizing and EBS volume selection info.
- Controller backup and restore Controller backup instructions can be found here.
- Controller high availability Controller HA instructions can be found here.
- Software upgrade Software upgrade procedure can be found here.