Install with CLI
Following this quickstart tutorial provides you with a simplified On Prem installation that deploys both the control plane and agent within the same namespace. It does not create Ingress configuration as its mainly designed for local installations that allow you to quickly try out and evaluate the solution. It comes with a preconfigured admin, organization and environment.
1. Prerequisites
Before you can get started with our quickstart deployment, you will need the following:
- Access to a Kubernetes cluster - If you don't have one we provide instructions on how to run the Testkube Agent with Docker.
- The helm CLI to generate the required Kubernetes YAML configurations.
- The kubectl CLI to run commands against Kubernetes clusters.
- The Testkube CLI for the quickstarter. For instructions, see the next section.
For the complete Testkube experience including the Dashboard and all related functionality, you will need to request your free trial license that will be necessary during the installation process.
Alternatively, you can get started with just the standalone agent which is fully open-sourced and does not require a license.
Why is a license required? Using a license helps us ensure you have an optimal installation and product experience with Testkube. Don’t worry, you won’t have to talk to a sales rep or enter any credit-card details to get going, but if you need our help we’ll be much better prepared!
2. Install the Testkube CLI
You can choose one of the following methods to install the CLI:
- MacOS
- Windows
- Ubuntu
- Script
- Manual Download
Run the following command to install the Testkube CLI with brew on MacOS:
brew install testkube
Run the following commands to install the Testkube CLI with Chocolatey on Windows.
choco source add --name=kubeshop_repo --source=https://chocolatey.kubeshop.io/chocolatey
choco install testkube -y
Run the following commands to install the Testkube CLI on Ubuntu:
wget -qO - https://repo.testkube.io/key.pub | sudo apt-key add -
echo "deb https://repo.testkube.io/linux linux main" | sudo tee -a /etc/apt/sources.list
sudo apt-get update
sudo apt-get install -y testkube
Run the following command to install the Testkube CLI with curl:
curl -sSLf https://get.testkube.io | sh
- Download the binary for the version and platform of your choice here.
- Unpack it. For example, in Linux use
tar -zxvf testkube_1.5.1_Linux_x86_64.tar.gz
. - Move it to a location in the PATH. For example:
mv testkube_1.5.1_Linux_x86_64/kubectl-testkube /usr/local/bin/kubectl-testkube
For Windows, you will need to unpack the binary and add it to the %PATH%
as well.
3. Run the Testkube Installer
The installer will complete these steps:
- Check if you have chosen the right Kubernetes environment.
- Ask for some information, such as the previously requested license.
- Install Testkube’s control plane and agent, both within the same namespace.
The whole process takes 3-5 minutes and can be started with the following command:
testkube init demo
Once installed, you will be asked if you want to testkube dashboard
to conveniently access all relevant services on your localhost. You can always execute this yourself afterwards should you close this terminal after installation. The admin in this demo has the following e-mail and password: admin@example.com/password
.
Happy testing!