Skip to main content
Version: 0.2.0

Development setup

Prerequisites:​

Create a local development environment​

  1. Clone the Rancher Turtles repository locally

  2. Create tilt-settings.yaml:

{
    "k8s_context": "k3d-rancher-test",
    "default_registry": "ghcr.io/rancher-turtles-dev",
    "debug": {
        "turtles": {
            "continue": true,
            "port": 40000
        }
    }
}
  1. Open a terminal in the root of the Rancher Turtles repository
  2. Run the following:
make dev-env

# Or if you want to use a custom hostname for Rancher
RANCHER_HOSTNAME=my.customhost.dev make dev-env
  1. When tilt has started, open a new terminal and start ngrok or inlets
kubectl port-forward --namespace cattle-system svc/rancher 10000:443
ngrok http https://localhost:10000

What happens when you run make dev-env?​

  1. A kind cluster is created with the following configuration.
  2. Cert manager is installed on the cluster, which is a requirement for running Rancher turtes extension.
  3. clusterctl is used to bootstrap CAPI components onto the cluster, and a default configuration includes: core Cluster API controller, Kubeadm bootstrap and control plane providers, Docker infrastructure provider.
  4. Rancher manager is installed using helm.
  5. tilt up is run to start the development environment.