cluster-ls.md

title	sidebar_label	slug
cluster ls	cluster ls	/cluster-ls

To list all valid clusters that Kurtosis can connect to (as defined in your kurtosis-config.yml), simply run:

kurtosis cluster ls

The clusters that Kurtosis can connect to are defined in your kurtosis-config.yml file, located at /Users/<YOUR_USER>/Library/Application Support/kurtosis/kurtosis-config.yml on MacOS. See this guide to learn more about how to add cluster information to your kurtosis-config.yml file.

Below is an example of what a valid kurtosis-config.yml file might look like with the clusters: docker, minikube, and cloud:

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