Install Threeport on AWS¶

This guide provides instructions to install Threeport on AWS Elastic Kubernetes Service. We will spin up a new EKS cluster and install the Threeport control plane there. It requires you have an AWS account and API keys. This install method is useful for testing Threeport on a remote cloud provider.

If you would prefer to test out Threeport locally, see our guide to Install Threeport Locally

Note: this guide requires you have our tptctl command line tool installed. See our Install tptctl guide to install if you haven't already.

Install Threeport¶

This section assumes you already have an AWS account and credentials configured on your local machine with a profile named "default". Follow the AWS quickstart page for steps on how to do this.

Note: if you have the ~/.aws/config and ~/.aws/credentials files on your file system, you're likely already set up.

Also, ensure you have the required permissions to create the necessary resources in AWS. If your user has the built-in AdministratorAccess policy attached, you can continue. Otherwise, check out our AWS Permissions guide to make sure you can create the resources required to run a Threeport control plane.

You also will need your AWS account ID. It can be found in the AWS console. Log in to AWS and look at the top-right of the console. It will say something like username @ 1111-2222-3333. The 12 digit number (without dashes) is your account ID.

With credentials configured, run the following to install the Threeport control plane in EKS:

tptctl up \
    --name test \
    --provider eks \
    --aws-region [aws region]  # e.g. us-east-1

This process will usually take 10-15 minutes. It can take even longer on some AWS accounts. You will see output as AWS resources are created. It will create a remote EKS Kubernetes cluster and install all of the control plane components. It will also register the same EKS cluster as the default Kubernetes cluster cluster for tenant workloads.

Validate Deployment¶

Note: if you would like to use kubectl against the cluster where Threeport is running, and you have the AWS CLI installed, you can update your kubeconfig with:

aws eks update-kubeconfig --name threeport-test --region [aws region]

Then, view the Threeport control plane pods with kubectl:

kubectl get pods -n threeport-control-plane

Next Steps¶

Next, we suggest you deploy a sample workload to AWS using Threeport. It will give you clear idea of Threeport's dependency management capabilities. See our Deploy Workload on AWS guide for instructions.

Clean Up¶

If you're done for now and not installing a workload on AWS, you can uninstall the Threeport control plane:

tptctl down --name test