Welcome. Your Aviatrix product experience starts here.
The Aviatrix Controller provides a single pane of glass for all your network connectivity tasks. Once you have a Controller instance launched in a VPC, you can start building your network.
This guide walks you through the following steps to launch the Aviatrix Controller and complete the initial setups:
- Subscribe an Aviatrix AMI from AWS Marketplace.
- Launch a Controller instance by CloudFormation Template. (Do not launch the Controller instance from AWS EC2 console or Marketplace.)
- Go through the Initial Setup.
- Setup a primary account.
- Start your use cases.
To learn all Aviatrix use cases, read the Aviatrix overview.
Before you start, you need to have an AWS account. Create a new account or login to an existing IAM account.
We require this AWS IAM account to have permissions to create AWS IAM roles, IAM policies and launch EC2 instances.
Let’s get started!
1. Subscribe to an Aviatrix AMI from AWS Marketplace¶
Go to AWS Marketplace, search “aviatrix”, you should see a list of Aviatrix marketplace offerings.
- Mertered AMI Aviatrix Secure Networking Platform PAYG - Metered AMI offers a pay as you go cloud consumption model for all use cases: AWS Global Transit Network, Encrypted Peering, OpenVPN® User Access, Egress FQDN filter and Site to Cloud IPSEC VPN.
- Utility AMI Aviatrix Inter-Region VPC Peering 5 Tunnel License AMI offers Cloud2Cloud tunnel utility model for use cases that build IPSEC VPN: AWS Global Transit Network, Encrypted Peering and Site to Cloud IPSEC VPN.
- Utility User VPN AMI We offer a range of OpenVPN® User Access AMIs. You can choose 10 User VPN Server, 25 User VPN Server, 50 User VPN Server, 100 User VPN Server.
- BYOL AMI Aviatrix for Cloud Interconnect, Cloud Peering and VPN (BYOL) offers BYOL license for all use cases. Contact firstname.lastname@example.org for a trial license.
Once you decide on an AMI, for example, Inter-Region VPC Peering 5 Tunnel AMI, select the AMI, then click Continue to Subscribe.
Click Manual Launch and then Accept Software Terms. Once accepted, continue to the next step in this guide. Do not launch Controller instance from the marketplace.
All AMIs should be launched by CloudFormation template provided by Aviatrix, as described in the next section.
If the VPC where the Controller is deployed in has a custom DNS server (via DHCP option), make sure the Controller instance can reach this DNS server.
2. Launch the Controller with CloudFormation Template¶
Each Aviatrix AMI in AWS marketplace has a companion CloudFormation template. The template is used to launch the Controller instance. Copy the URL link address for the AMI you intend to launch.
2.1. In the AWS console, change to the region where you would like to install the Aviatrix Controller.
2.2. Once in the correct region, go to the CloudFormation service.
2.3. Click Create new stack or Create Stack
2.4. Select Specify an Amazon S3 template and paste the URL link address for the AMI you selected in the above table.
2.5. Click Next
- 2.6. 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. 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 Aviatrix Controller, select the default setting New for IAM Role Creation. If Aviatrix IAM role has been created before, select aviatrix-role-ec2 for IAM Role Creation. The Aviatrix Controller instance is termination protected.
2.7. Leave the Controller Size at t2.large and keep the IAM role creation at “New” unless you have already created the Aviatrix IAM roles.
2.8. Click Next
2.9. Optionally, add any key/value tags as required
2.10. Optionally, select an IAM Role if your currently logged in user does not have permission to create instances.
2.11. We recommend you to enable stack termination protection during stack creation time to prevent accidental deletion, as shown below, then click Next
The Controller instance has Termination Protection enabled. If you need to delete the stack, make sure you first disable the Controller instance Termination Protection at the AWS EC2 console.
2.12. Click the checkbox next to “I acknowledge that AWS CloudFormation ...” and then click Create.
2.13. 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.
3. Initial Setup¶
Now that Aviatrix Controller instance has been launched, let’s login and go through a few init steps.
3.1. 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.
Use the AviatrixControllerPrivateIP as the password. The AviatrixControllerPrivateIP is 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, click the Controller instance and locate 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. Next, you will be prompted to change the admin password.
3.5. Click Skip in the next page, unless the Controller instance VPC has an HTTP or HTTPS proxy configured for Internet access.
3.6. 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 user admin and your new password to login.
4. Create A Primary Access Account¶
4.1 Select AWS¶
Once logged back in to the Controller, you should be on the Onboarding page or click “Onboarding` on the navigation item. Then click AWS icon.
4.2 (Only apply to BYOL AMI) Enter Your Customer ID¶
This step only applies if you select BYOL AMI. Contact email@example.com to get a trial license if you do not have one.
Enter the Customer ID in the field and click Save.
4.3 Setup a Primary Access Account¶
The Aviatrix primary access account contains two sets of information:
- The Controller instance’s AWS account credential.
- A login access credential to the Controller web console with the account name.
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. The e-mail address of the admin. Password Password for login to the Controller using the account name specified. Confirm Password AWS Account Number The Controller instance’s 12 digit AWS account number. IAM role-based Check this box. aviatrix-role-app ARN This field is auto filled. aviatrix-role-ec2 ARN This filed is auto filled.
Once complete, click the Create button at the bottom of the form.
You are now ready to establish connectivities to/from the cloud. Here are some of the things you can do:
- Build User SSL VPN
- Build Global Transit Network
- Build Egress Security Filter
- Build your own site to cloud IPSEC connectivity
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 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 firstname.lastname@example.org