Polarity Server BYOL AMI

Subscribe to AMI

The Polarity AMI runs on Amazon Linux 2 and includes the AWS System Manager agent installed by default. To start, subscribe to the AMI here:

Deploying the AMI

We recommend deploying the AMI by launching a new instance via EC2 rather than launching directly from the configuration page.

From your EC2 instances page click on Launch Instance from the appropriate region to begin configuring the AMI.

Name and tags

Provide a name for your server (e.g., polarity-server) and apply appropriate tags per your AWS environment and policies.

Application and OS Images (Amazon Machine Image)

Select the "My AMIs" tab and then select the "Polarity Server Enterprise 4.2.7 - BYOL" AMI:

Instance Type

The instance type will vary depending on usage. For specific questions on your deployment please reach out to Polarity at [email protected]

Key pair (login)

A key pair is required if you plan to manage your server via SSH. If you are managing the server solely via SSM a key pair is not required but is often recommended as a backup access option for the server.

Network Settings

Assign the appropriate Network (VPC) and Subnet to your Polarity Server. If required, you can also auto-assign a public IP to your server.

We also recommend assigning an appropriate security group to the server to restrict access to the server to only certain IP addresses. The security group should allow inbound port 443 from your specified, valid IP addresses. If you are managing the server via SSH you will also need to allow inbound port 22 for those same specified IP addresses. All other inbound traffic should be disallowed.

Outbound rules will typically allow all traffic outbound.

Configure Storage

The AMI will default to a 20GB root volume using a general purpose SSD (gp3). We typically recommend increasing this to 80GB for most single server deployments.

Advanced details

Under Advanced details the only required setting is to assign an IAM instance profile if SSM is being used.

IAM instance profile

For SSM management of the server to work you will need to assign an IAM instance profile with the appropriate SSM permissions. For more information please see:

Step 4: Create an IAM instance profile for Systems Manager - AWS Systems ManagerAWS Systems Manager

Launch

With the the above configuration steps complete you are no ready to launch the instance.

Next Steps

Install License

With the AMI deployed the next step is to install a valid license. Connect to your server via SSH or using SSM and follow the steps below using the license file provided to your by your Polarity customer success or sales representative.

Install SSL Certificate

Once the license is installed you will want to install a valid SSL certificate.

Set the Server's Fully Qualified Domain Name

By default the server's REST API will use the hostname of the server to generate links used in the REST API. If the hostname does not match the actual fully qualified domain name (FQDN) this can cause errors when navigating in the app (in particular the "groups" page).

For most EC2 instances you will need to set the server's fullyQualifiedDomainName configuration value to the FQDN used to access the server.

Reset Admin Password

The final step is to reset the admin password. You can do this from the command line using the change-admin-password.sh script.

From the server's command line run the following command:

sudo /app/polarity-server/scripts/change-admin-password.sh

Once the password has been reset you're now ready to login Polarity for the first time.

Logging in

Navigate to the public IP address of your server and login using the username admin and the password you set above. Once logged in you should be greeted by the Polarity search interface.