Skip to content

Quickstart

Deploy a Private Location with Helm and connect it to your Escape account.

Before You Begin

Before deploying a Private Location, review the Prerequisites, including:

  • Infrastructure workflow understanding
  • Resource requirements (Helm defaults to 1 vCPU and 2 GiB RAM; configure Helm Values for your workload)
  • Firewall configuration for egress connections - Private Locations require outbound connectivity to Escape's infrastructure. See the Firewall Configuration for required egress rules.

Step 1: Retrieve Your API Key

  1. Go to your profile page.
  2. Copy your API Key.

Step 2: Deploy With Helm

Start by adding our Helm repository and update your repos:

helm repo add escape-cli https://escape-technologies.github.io/cli/
helm repo update

Next, deploy the chart using the following command:

helm install escape-private-location escape-cli/private-location --set ESCAPE_API_KEY="${ESCAPE_API_KEY}"

This connects over SSH on port 2222. If your network blocks outbound SSH, use the HTTPS transport instead.

Once the pod is running, check the logs for Private location ready to accept connections. The agent's GET /health endpoint on port 8080 returns 200 OK when the tunnel is connected.

See Deployment Methods for other deployment options.

Step 3: Find Your Private Location

  1. Visit the Private Locations dashboard
  2. Find your newly created Private Location.

Check that the location is enabled and its Last seen value updates.

Step 4: Start Using Your Private Location

Now that your Private Location is up and running, you can:

  • Create a new application with Private Location settings
  • Update existing application settings to use your Private Location