CloudFormation installation

Installation via CloudFormation

This guide is targeted at developers and system administrators who need to install Browsolate using AWS CloudFormation. This installation method is required for certain configurations and license agreements.

Prerequisites

  1. License Key: You will need a valid license key, which you will enter during the deployment process.
  2. CloudFormation Template Location: An S3 location containing the CloudFormation templates will be provided to you, along with any specific configuration instructions related to your contract.
  3. AWS Permissions: Ensure that the deploying user has the necessary AWS IAM permissions, as outlined below.

Security and Template Inspection

For security assurance, you are encouraged to inspect the provided CloudFormation templates to review settings, including role and IAM policies.

Required AWS Permissions

The following AWS IAM permissions are required for deploying Browsolate via CloudFormation:

  • AmazonEC2ContainerRegistryFullAccess
  • AmazonEC2FullAccess
  • AmazonECS_FullAccess
  • AmazonSSMReadOnlyAccess
  • AWSCloudFormationFullAccess
  • AWSLambda_FullAccess
  • CloudWatchLogsFullAccess
  • IAMFullAccess

Installation Steps

  1. Deploying the Template: Using the AWS Management Console, AWS CLI, or SDK, initiate the CloudFormation template deployment using the provided S3 URL.

  2. Parameters: Follow the parameters listed in the Installation Options Documentation to configure the template. Additionally, you will need to pass your secret key, provided in your installation email. Ensure you check this email for any additional installation notes or customer-specific instructions.

  3. Deployment Verification: Once the deployment is complete, check the Outputs section in the CloudFormation template. Here you will find URLs, deployment details, and other relevant configuration information.

  4. DNS Propagation: If using a browsolate.com domain, DNS propagation may take some time. To monitor the progress, consult the CloudWatch logs.

Testing the installation

If you enabled the Launcher UI you can use the built-in example page to create and launch arbitrary URLs. The URL of the Launcher will be published in the Outputs section of the CloudFormation deployment.

NOTES

  • By default, the Launcher UI is hosted on port 5443. Access to this port in controlled by the Public API Enabled installation parameter, and the security group tagged Browsolate-PublicSecurityGroup, which you can customise to control access to the Launcher UI.
  • The username for the Launcher UI is b8admin .
  • The password in configured at installation by the Management Password parameter.