Philterd

Talk to the Team

Tell us about your stack and the privacy problems you're trying to solve. We typically respond within one business day.

Prefer email? support@philterd.ai

Prefer to skip the form? Pick a time on our calendar →
or send a message

Please do not enter PII or PHI in this form. If you need to share an example, use a sanitized one.

Reference and how-to

Deploying Philter in AWS via a CloudFormation Template

How to deploy Philter in AWS with a CloudFormation template: finding the Philter AMI, editing the template, and launching the stack.

AWS CloudFormation can be used to automate the creation and tear down of your AWS cloud resources in a repeatable manner. Philter can be included in your CloudFormation templates to automate its deployment and configuration.

This guide is a quick start into CloudFormation and Philter. It describes a CloudFormation template suitable for deploying Philter for purposes of integration testing. A template for deploying Philter for production use requires a few more changes.

Finding Philter’s AMI

To begin, you must have the AMI (for example ami-123456789) of Philter.

To find the AMI, launch Philter from the AWS Marketplace. If you have not already, you will be prompted by the AWS Marketplace to subscribe to Philter. At the end of the subscription process you will be able to launch an instance into your AWS account (you can select the smallest available instance size). Do this and then navigate to your EC2 instances in the AWS Console.

In the EC2 Console, locate the newly launched Philter instance. It will likely still be in a “Pending” state if it has not finished launching. Click on the instance so its details are displayed at the bottom of the EC2 Console, and locate the “AMI” property. This is the Philter AMI identifier. Make a note of it so you can reference it in your CloudFormation templates. You can now terminate the instance.

Note that when a new version of Philter is published to the AWS Marketplace it will have a different AMI identifier. If you want to use the newest version you will need to repeat the steps above to find the new AMI identifier. If you have difficulties finding the Philter AMI identifier, please contact us for assistance.

CloudFormation template

You can use the AMI ID to launch one or more instances of Philter via your CloudFormation template. You can launch a single instance, multiple instances, or one or more instances as part of an auto-scaling group, depending on your requirements. In the example below we launch a single instance of Philter.

We base our template off the AWS sample for a single EC2 instance in a VPC. The sample template creates a new VPC along with the required subnet and route table.

  • Open this template in your text editor and locate the AWSRegionArch2AMI mapping. For your region, replace the value for the AMI with the Philter AMI you previously found.
  • Next, locate the security group in the template that exposes port 80. Replace 80 with 8080 to be able to access Philter’s API. You will also likely want to change the security group’s inbound CIDR from everyone (0.0.0.0/0) to a specific host or set of hosts within your network.
  • Save and close the template.

Note that we only replaced the Philter AMI for your region in the template. The Philter AMI will be different for each AWS region.

Launch the stack

Now that we have the template we can create a stack from it. A stack is the set of resources that the template defines; you can think of a stack as an instance of the template. We will use the AWS Console to create the stack. Navigate to the CloudFormation console, find the button to create a stack, walk through the steps uploading your template when prompted, and finish. Your new stack with Philter will now launch, and you can watch the stack’s progress as CloudFormation creates its resources. When you are finished with the stack you can delete it, and all resources that were created for the stack, such as the Philter instance, will be deleted.

If you try to launch a CloudFormation stack that uses a Philter AMI but you do not have an active subscription to Philter via the AWS Marketplace, the stack creation will fail. To remedy this, subscribe to Philter on the AWS Marketplace.

Related reading