Skip to main content

Quick Start

API Key

You will need to get your API key from your Profile Page. Copy the API key and paste when prompted.

Install

Make sure you have Helm 3 installed. Then,

helm install speedscale-operator speedscale/speedscale-operator \
-n speedscale \
--create-namespace \
--set apiKey=<YOUR-SPEEDSCALE-API-KEY> \
--set clusterName=<YOUR-CLUSTER-NAME>

Navigate to the Helm repository for all configuration options available for the Helm chart.

Verify Install

Once you're done, make sure the operator pods are running properly:

kubectl -n speedscale get pods

Note: The Operator will start at least 2 pods (the operator itself and the Speedscale Forwarder) after it starts. On your cluster the ids of the pods will be different.

NAME                                    READY   STATUS    RESTARTS   AGE
speedscale-forwarder-xxxxxxxxxx-xxxxx 1/1 Running 0 5s
speedscale-operator-xxxxxxxxxx-xxxxx 1/1 Running 0 15s

If you're ready to capture traffic skip ahead to Sidecar.

tip

If you have any issues installing, check out the troubleshooting guide.