This is a template repo for a Terraform configuration that deploys the Worklytics pseudonymization proxy (psoxy) on AWS.
This is a template repo. To use it, follow the instructions below.
You'll need:
- a Bash-like shell environment on Linux, MacOS, or WSL on Windows.
git
installed, although it is usually included on those platforms (check withgit --version
).- an AWS account and credentials, as described in Psoxy's AWS - Getting Started docs
- the prerequisites for Psoxy itself, although this example will attempt to help you check those.
See GitHub's documentation for more details.
-
Click the 'Use this template' button in the upper right corner of this page.
- choose a name for your copy of this repo
- leave "Include all branches" unchecked
-
Clone the resulting repo to your machine. Example command below, just fill in your org and repo names.
git clone https://github.com/{{YOUR_ORG_ID}}/{{YOUR_REPO_NAME}}.git
- Check your prereqs. Review versions and install anything needed.
./check-prereqs
- Authenticate your tools as needed:
- AWS CLI -
aws get-caller-identity
should work and return your expected account/user - if plan to get data from Google Workspace, auth GCloud CLI -
gcloud auth login
to authenticate, thengcloud auth list
to verify you have expected account/user - if plan to get data from Microsoft 365, auth Azure CLI -
az login --allow-no-subscription
to authenticate, thenaz account list
to verify you have expected account/user
- Initialize your configuration
./init
-
Review your
terraform.tfvars
file andmain.tf
; customize as needed (eg, comment out datasources you don't need).In particular, if you're NOT using Google Workspace as a data source, remove (delete) the
.tf
files namedgoogle-*.tf
AND from themain.tf
file. -
Run
terraform plan
and review results to understand what will be created. Customize yourterraform.tfvars
ormain.tf
file if needed.
terraform plan
- Run
terraform apply
to create the resources.
terraform apply
The source code contained in this repo is licensed under the Apache License, Version 2.0.
Usage of terraform, psoxy, or other tooling invoked by scripts in this repo or described in the example tutorials it contains are each subject to their own license terms.
This example repo is maintained by Worklytics. Paid support is available. Please contact sales@worklytics.co.