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
- Helm
- CLI (Mac/Linux)
- CLI (Windows)
- GitOps
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.
Start by installing speedctl
the Speedscale CLI-based API via Homebrew:
brew install speedscale/tap/speedctl
Or via the install script:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
If using Kubernetes run speedctl install
, choose "Kubernetes" and follow the prompts.
The install wizard
will walk you through installing the
Speedscale Kubernetes Operator
and adding the Speedscale Sidecar to your deployment.
Open PowerShell and create a Speedscale directory.
mkdir -f $env:userprofile\.speedscale
Download speedctl
into the Speedscale directory.
curl.exe -L "https://downloads.speedscale.com/speedctl/speedctl.exe" -o $env:userprofile\.speedscale\speedctl.exe
If this is your first time using speedctl
you may need to add the Speedscale
directory to your Path environment variable so it is accessible without knowing
the full path.
To add the Speedscale directory to your path, right click on the Windows button and click System.
Click Advanced system settings on the right.
Click Environment Variables.
Under System variables select Path and click Edit.
Create a New entry in the list with the Speedscale directory. If you are unsure of the exact path run this command from PowerShell.
echo $env:userprofile\.speedscale
Click OK and restart PowerShell.
If using Kubernetes run speedctl install
, choose "Kubernetes" and follow the prompts.
The install wizard
will walk you through installing the
Speedscale Kubernetes Operator
and adding the Speedscale Sidecar to your deployment.
caution
Installing via helm install
is preferred as different GitOps engines treat Helm charts differently and Helm guarantees an order of operations during the install.
You can generate manifests either via Helm or our CLI.
helm template speedscale-operator speedscale/speedscale-operator \
-n speedscale \
--create-namespace \
--set apiKey=<YOUR-SPEEDSCALE-API-KEY> \
--set clusterName=<YOUR-CLUSTER-NAME> > ./manifests
or
speedctl deploy operator -e $(kubectl config current-context) --dir
Verify Install
For Kubernetes users, 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.