There are several ways to install the sidecar in your cluster. See the proxy configuration reference for proxy configuration outside of a cluster.
- Web App
- Kubernetes Annotation
From the Speedscale web app click on
service to launch the add service wizard which will walk you through
configuration and verification tailored to your environment.
With cluster access you can add the sidecar with an annotation on your workload.
Please ensure the Kubernetes Operator is running in your cluster before moving on.
Select the workload (daemonset, deployment, statefulset, job or replicaset) you'd like to monitor and add the following annotation:
That's it. Next time you deploy you can check the pods with get pods.
kubectl -n <namespace> get pods
You should notice your container count increases by one and data should be flowing.
NAME READY STATUS RESTARTS AGE
carts-xxxxxxxxxx-xxxxx 2/2 Running 0 38d
By default, the Speedscale init container starts after any existing init containers in the workload.
If you already have the sidecar installed, but you need for it to be removed,
you may either set the
sidecare.speedscale.com/inject annotation to
or remove it:
After deploying or patching your deployment, you should notice your container count decrease by one and the sidecar is no longer attached.
speedctl uninstall to remove all Speedscale components.