How to deploy Hyperglance in your AWS VPC using a Cloud Formation Template

Find out how to use AWS Cloud Formation to deploy the Hyperglance Cloud Formation Template (CFT)

Hyperglance can be deployed from an AWS AMI using our CloudFormation template or using Terraform. It can also be installed on your own Instance or as part of a Kubernetes Cluster using a help chart. This article details how to deploy the Hyperglance application using the supplied CFT.

Most often you will have received the CFT via an email that was sent to you after you signed up for your free trial. This email will also include a licence key. If you've used our CFT without obtaining a licence, please contact us for help.

Step 1: Use the AWS Console to deploy Hyperglance

1. Download the Hyperglance Cloud Formation Template
2. Navigate to CloudFormation in the AWS Console
3. Make sure you are in the desired Region
4. Select Create Stack
5. Select Upload a template file then Choose File
6. Find the CFT you downloaded and then select Next
7. Specify stack details, filling out the fields:
   1. Stack name: This can be any lowercase freeform text, we recommend 'hyperglance'
   2. Instance size: See here for an explanation of sizing
   3. Choose an SSH key pair: Name of an existing EC2 KeyPair. The Hyperglance instance will launch with this KeyPair.
   4. Initial security group entry for TCP port 443: The IP range that can connect to the Hyperglance UI. Must be a valid CIDR range of the form x.x.x.x/x
   5. Initial security group entry for TCP port 22: The IP range that can SSH to the Hyperglance instance. Must be a valid CIDR range of the form x.x.x.x/x IP configuration
   6. Assign a Public IP: Hyperglance needs to access the AWS API endpoints in order to function. See here for an article on deployment models. The two most common deployment models are 
      1. The Hyperglance instance has a public IP, the subnet Hyperglance runs in has a route to an internet Gateway and the Security group is configured to restrict access.
      2. The Hyperglance instance doesn't have a public IP, the subnet Hyperglance runs in has a route to a NAT Gateway and the Security group is configured to restrict access.
   7. Assign Static Private IP: Do you want to assign a Static Private IP? Most people leave this as 'False'. Must be a valid IP range of the form x.x.x.x and must be part of the selected subnet range 10.0.0.1
   8. VPC configuration: VPC to use for the Hyperglance instance. 
   9. Subnet to use for the Hyperglance instance: The ID of an existing subnet (for the primary network) in your Virtual Private Cloud (VPC) you have chosen
      
      Once all the fields have been filled out, select Next
8. Configure stack options: Add any Tags as per your company policy (you don't need to add an IAM policy as the CFT creates one).
9. Review Hyperglance:
   1. Scroll down to the bottom and check I acknowledge that AWS CloudFormation might create IAM resources
   2. Select Create Stack
   3. The stack will take approximately 5 minutes to fully deploy. There is a 'refresh' icon at the top right to update the text.

Step 2: Sign in to Hyperglance

1. Once the CFT has completed, navigate to the Outputs column in the top-middle of the page
2. Copy the Instance ID, this will be the initial Hyperglance password
3. Click on the relevant DNS or IP entry and you'll be sent to the Hyperglance web portal
4. Enter admin as the username
5. Enter the instance ID as the password
6. Go to Menu > Tools > Apply Licence Key
7. Paste in the licence key you received after signing up
8. Cancel/close the popup window
9. Refresh your browser until you see Amazon on the left-hand side of the page
10. Click on Advanced then Proceed

Step 3: Add an AWS Account

Please follow the steps outlined in this article.

Optional - Step 4: Enable Automations

Please follow the steps outlined in this article.