Skip to main content
Version: Upcoming Release

Running Kurtosis in Kubernetes

This guide assumes that you have Kurtosis installed.

I. Create a Kubernetes Cluster​

There are severals diferent ways to deploy a Kubernetes cluster:

  1. Deploy it on an onprem cluster and manage the machine provisioning yourself
  2. Deploy it on the cloud, managing the Kubernetes nodes on cloud instances yourself (e.g. EC2, AVM, GCE, etc)
  3. Deploy it on a managed Kuberenetes cluster, managing scaling and configurations yourself (e.g. EKS, AKS, GKE)
Kurtosis Kloud Early Access

If you're looking to run a stress-free "Kurtosis on Kubernetes in the cloud", look no further! We're excited to launch an early access offering for Kurtosis Kloud. Once you sign up, we'll reach out to you with the next steps.

II. Add you Kubernetes Cluster credentials to your kubeconfig​

This step will depend highly on how your cluster was created. But generally you will need to either:

  1. Manually edit the kubeconfig file to contain cluster and authentication data. For more information, see Kubernetes docs.
  2. Use your cloud provider's CLI to automatically edit the kubeconfig file so that it contains your cluster and authentication data. For example, you if you are using Amazon's managed Kubernetes service (called EKS), this tutorial is comprehensive.

III. Add your cluster information to kurtosis-config.yml​

  1. Open the file located at "$(kurtosis config path)". This should look like /Users/<YOUR_USER>/Library/Application Support/kurtosis/kurtosis-config.yml on MacOS.
  2. Paste the following contents, changing NAME-OF-YOUR-CLUSTER to the cluster you created and save:
config-version: 2
should-send-metrics: true
kurtosis-clusters:
  docker:
    type: "docker"
  minikube:
    type: "kubernetes"
    config:
      kubernetes-cluster-name: "minikube"
      storage-class: "standard"
      enclave-size-in-megabytes: 10
  cloud:
    type: "kubernetes"
    config:
      kubernetes-cluster-name: "NAME-OF-YOUR-CLUSTER"
      storage-class: "standard"
      enclave-size-in-megabytes: 10

IV. Configure Kurtosis​

  1. Run kurtosis cluster set cloud. This will start the engine remotely.
  2. In another terminal, run kurtosis gateway. This will act as a middle man between your computer's ports and your services deployed on Kubernetes ports and has to stay running as a separate proccess.

Done! Now you can run any Kurtosis command or package just like if you were doing it locally.

Kurtosis Kloud Early Access

To switch back to using Kurtosis locally, simply use: kurtosis cluster set docker