# Getting started

[Site index](https://docs.speedscale.com/llms.txt)

## Pages

- [Command-line tools (CLI): proxymock and speedctl](https://docs.speedscale.com/getting-started/command-line-tools/index.md): Choose between the proxymock and speedctl CLIs. Find installation, quickstarts, command references, and local, Kubernetes, CI/CD, BYOC, and cloud workflows.
- [Evaluation prerequisites and plan](https://docs.speedscale.com/getting-started/evaluation/index.md): Prepare a Speedscale evaluation with a short readiness checklist, agreed success criteria, and a sample three-week plan.
- [AWS Elastic Beanstalk](https://docs.speedscale.com/getting-started/installation/install/beanstalk/index.md): This documentation provides a step-by-step guide for installing Speedscale on AWS Elastic Beanstalk, focusing on configuration and deployment best practices. It ensures seamless integration and optimal performance for applications running in the cloud environment.
- [Bringing Your Own TLS Certs](https://docs.speedscale.com/getting-started/installation/install/bring-your-own-cert/index.md): By default the Speedscale operator Helm chart generates and manages its own TLS certificates. If your organization uses an existing PKI or a tool like cert-manager, you can disable the built-in cert generation and supply the secrets yourself.
- [Install speedctl CLI](https://docs.speedscale.com/getting-started/installation/install/cli/index.md): Install the speedctl command-line tool for Speedscale platform setup, operator installation, and cloud resource automation. For recording, mocking, and replaying with proxymock, use the proxymock CLI install guide.
- [Google Cloud Run](https://docs.speedscale.com/getting-started/installation/install/cloudrun/index.md): Set up Google Cloud Run with Speedscale by creating a GKE cluster, deploying components, and configuring your app for effective traffic capture and testing
- [Docker](https://docs.speedscale.com/getting-started/installation/install/docker/index.md): Run Speedscale components using Docker Compose to capture and replay traffic, enabling seamless API testing and integration with your applications.
- [AWS ECS/Fargate](https://docs.speedscale.com/getting-started/installation/install/ecs/index.md): This documentation outlines the steps for installing Speedscale on Amazon ECS, providing a clear and comprehensive guide for users. It covers prerequisites, configuration, and verification to ensure a smooth setup process.
- [Working with EKS Auto Mode](https://docs.speedscale.com/getting-started/installation/install/eks-auto-mode/index.md): Install Speedscale on Amazon EKS Auto Mode with eBPF or transparent sidecar capture on Bottlerocket nodes.
- [Working with GKE Autopilot](https://docs.speedscale.com/getting-started/installation/install/gke-autopilot/index.md): The complete guide to running Speedscale on GKE Autopilot. Covers both capture paths — eBPF via a customer-owned WorkloadAllowlist (support request, org policy, AllowlistSynchronizer) and sidecar dual proxy mode — plus the Autopilot-specific Helm values required to pass Warden admission.
- [Install Speedscale](https://docs.speedscale.com/getting-started/installation/install/index.md): Choose a command-line tool or deployment environment to install Speedscale.
- [Istio](https://docs.speedscale.com/getting-started/installation/install/istio/index.md): Configure Istio support with the Speedscale Operator to enable traffic management and seamless integration of Speedscale sidecars in your workloads.
- [Namespaced Install: Limitations & Compatibility](https://docs.speedscale.com/getting-started/installation/install/kubernetes-namespaced-limitations/index.md): What the namespaced Speedscale install does not do: supported workload kinds, replay resource contention, opt-in metrics enrichment, mesh support, and image pinning.
- [Namespaced Install: Uninstall & Recovery Runbooks](https://docs.speedscale.com/getting-started/installation/install/kubernetes-namespaced-runbooks/index.md): Runbooks for the namespaced Speedscale install: an uninstall blocked by active capture or replay, forceCleanupOnUninstall, uninstall bypasses, coordinator-absent recovery, and a stuck uninstall hook Job.
- [Namespace-scoped installation](https://docs.speedscale.com/getting-started/installation/install/kubernetes-namespaced/index.md): Install Speedscale confined to a single Kubernetes namespace, with no cluster-scoped permissions, CRDs, or admission webhooks, for clusters that cannot grant the classic operator install.
- [Install the standard Kubernetes operator](https://docs.speedscale.com/getting-started/installation/install/kubernetes-operator/index.md): Install and verify the Speedscale Kubernetes operator with Helm, speedctl, Argo CD, or rendered manifests.
- [Install Speedscale on Kubernetes](https://docs.speedscale.com/getting-started/installation/install/kubernetes/index.md): Choose the standard operator or namespace-scoped installation, then review the requirements for your Kubernetes platform.
- [Working with OpenShift](https://docs.speedscale.com/getting-started/installation/install/openshift/index.md): This documentation provides a comprehensive guide on installing Speedscale in an OpenShift environment, detailing the necessary prerequisites and step-by-step instructions. Enhance your development workflow by seamlessly integrating Speedscale's capabilities into your OpenShift setup.
- [Troubleshooting](https://docs.speedscale.com/getting-started/installation/install/troubleshooting/index.md): Troubleshoot installation and operation permissions for Speedscale, ensuring proper setup and resolving common issues like webhook errors in your cluster.
- [Virtual Machines](https://docs.speedscale.com/getting-started/installation/install/vm/index.md): Learn how to install Speedscale on a virtual machine with comprehensive, step-by-step instructions outlined in the official documentation. This guide covers system requirements, installation procedures, and troubleshooting tips to help you effectively set up Speedscale.
- [Configuration Reference](https://docs.speedscale.com/getting-started/installation/sidecar/annotations/index.md): Configure the Speedscale sidecar using Kubernetes annotations for optimal API testing and traffic replay in your workloads.
- [Sidecar](https://docs.speedscale.com/getting-started/installation/sidecar/install/index.md): Capture network traffic for Kubernetes services using the Speedscale sidecar proxy to enhance API testing and traffic replay capabilities.
- [Performance and Diagnostics](https://docs.speedscale.com/getting-started/installation/sidecar/performance/index.md): Test sidecar latency and performance with Speedscale to ensure optimal API functionality during pre-production and progressive rollout strategies
- [Proxy Modes](https://docs.speedscale.com/getting-started/installation/sidecar/proxy-modes/index.md): Explore Proxy Modes in Speedscale to learn about default and inline proxy configurations for Kubernetes, including reverse and forward proxy setups.
- [TLS Support](https://docs.speedscale.com/getting-started/installation/sidecar/tls/index.md): Enable TLS support in Speedscale by configuring inbound and outbound interception with annotations for secure API traffic management.
- [Quick Start](https://docs.speedscale.com/getting-started/quick-start/index.md): Get started with Speedscale in Kubernetes using the Operator, with eBPF collection as the default path and goproxy sidecars as a fallback when needed.
- [Tutorial](https://docs.speedscale.com/getting-started/tutorial/index.md): Install and configure Speedscale to capture, transform, and replay traffic with mocks using a Java Spring Boot app in this comprehensive tutorial.
- [Operator](https://docs.speedscale.com/getting-started/upgrade/operator/index.md): Upgrade the Speedscale operator in your Kubernetes cluster with this comprehensive guide, covering helm commands, rollback options, and validation steps.