Deploy SwaggerHub On-Premise from AWS Marketplace
Important
SwaggerHub On-Premise 1.x AMI is no longer available on the AWS Marketplace. New installs should follow the installation instructions for 2.x. Existing Users of SwaggerHub On-Premise 1.x in AWS who need to deploy in AWS marketplace must file a support ticket with Customer Service for help.
This guide explains how you can set up a SwaggerHub On-Premise 1.x instance from the AWS Marketplace.
Prerequisites
Before deploying SwaggerHub On-Premise on AWS, you must have the following:
An AWS account. You can sign up at https://aws.amazon.com.
The SwaggerHub On-Premise 1.x license file that was provided by a SmartBear representative when you set up your account.
An AWS private image provided by SmartBear Customer Service
1. Set up a Virtual Private Cloud (VPC)
A VPC is an isolated network within an Amazon region where you can deploy EC2 instances and host other resources. You have complete control over the VPC configuration, including the IP range, subnets, routing tables, network gateways, and security.
All new AWS accounts include a default VPC in each AWS region. The default VPC comes with a public subnet, meaning that EC2 instances from that subnet will have direct Internet access. VPCs can also have private subnets where instances can connect only to the Internet via NAT and cannot be accessed directly from outside the VPC.
If you don’t have a VPC in your preferred AWS region, or if you need a specific VPC configuration, you can create your own VPC and configure it as required. To learn how to create VPCs, see Creating a VPC and Scenarios and Examples in the AWS documentation.
2. Launch SwaggerHub On-Premise from AWS Marketplace
SmartBear Customer Support will guide you through this process.
3. Initial SwaggerHub configuration
Navigate to
http://IP_address/uito access the installer.Configure basic system settings, including the admin username and password. Important: Enter the instance’s IP address in the DNS name for this instance field.
Log in to the SwaggerHub Admin Center using the created admin user. Here you can configure additional system settings.
After the setup, you can access the SwaggerHub application at http://IP_address, and the SwaggerHub Admin Center at http://IP_address/ui.
You can also connect to the instance via SSH using its IP address, the username ubuntu, and the private key from the key pair you selected when launching the instance.
4. Monitor instance health
AWS provides status checks to monitor the operational status of EC2 instances. You can configure status check alarms to get notified when an issue is detected.
In the EC2 Console, go to Instances.
Select your SwaggerHub On-Premise instance and switch to the Status Checks tab at the bottom.
Click Create Status Check Alarm.
Specify the following options:
Send a notification to – the user to send a notification to
Whenever – Status Check Failed (Any)
Name of alarm – enter a unique name for this alarm
Leave the default values for the other options.
Click Create Alarm.
In addition to status checks, you can configure CloudWatch alarms to monitor the CPU usage and other metrics and get alerted when these metrics reach critical levels. To learn more about using CloudWatch, refer to the CloudWatch documentation.