diff --git a/src/development/tilt/linux.md b/src/development/tilt/linux.md index 6f40fc4..dd38bbf 100644 --- a/src/development/tilt/linux.md +++ b/src/development/tilt/linux.md @@ -1,7 +1,7 @@ # Linux Devnet Setup ### Experimental Setup Script -There's an experimental one command setup script that should install dependencies for you on Linux and configure everything properly. This is only recommended if you're running headless Linux and unable to use Docker Desktop, as with Docker Desktop you don't need `minikube` and can just enable Kubernetes from Docker. +There's an experimental single command setup script that should install dependencies for you on Linux and configure everything properly. This is only recommended if you're running headless Linux and unable to use Docker Desktop, as you can enable Kubernetes from Docker. ```sh curl $URL | sh install_linux.sh @@ -12,25 +12,30 @@ cd wormhole/ ## Regular Setup ### 1. Install Go + ```sh wget https://go.dev/dl/go1.18.1.linux-amd64.tar.gz rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.1.linux-amd64.tar.gz ``` ### 2. Install Docker + If you're using Linux with a window manager, consider getting Docker Desktop instead of the following command. It comes with Kubernetes built in and you won't need to download `minikube`. It's recommended to have at least 4 CPUs and 16GB RAM dedicated to Docker. -Also make sure that you set up docker as a NON ROOT USER! +Also, make absolutely sure that you set up Docker as a non-root user. [https://docs.docker.com/engine/install/ubuntu/#installation-methods](https://docs.docker.com/engine/install/ubuntu/#installation-methods) ### 3. (Docker Desktop Install) + Enable Kubernetes by going into Settings > Kubernetes ### 3. (Non Docker Desktop) -Install [`minikube`](https://minikube.sigs.k8s.io/docs/start/) -Configure minikube +Install [`minikube`](https://minikube.sigs.k8s.io/docs/start/). + +Configure minikube: + ``` minikube start --driver=docker --kubernetes-version=v1.23.3 --cpus=4 --memory=14G --disk-size=10G --namespace=wormhole ``` @@ -39,7 +44,8 @@ If you reboot your VM you'll need to run the `minikube start` command again befo ### 4. Install Tilt -Install tilt by copy pasting this into the Terminal +Install Tilt by copy pasting this into the Terminal: + ```sh curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash ``` @@ -50,13 +56,14 @@ curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/instal git clone --branch dev.v2 https://github.com/certusone/wormhole.git ``` -If you're running tilt on your machine +If you're running Tilt on your machine: + ```sh cd wormhole/ tilt up ``` -If you're running tilt in a VM, we need to pass in some extra flags to enable Tilt to listen to incoming traffic from external addresses. +If you're running Tilt in a VM, you'll need to pass in some extra flags to enable Tilt to listen to incoming traffic from external addresses: ```sh cd wormhole