From c1cc8738ee670430471eef0258283197f1daf180 Mon Sep 17 00:00:00 2001 From: huwshimi Date: Mon, 3 Jun 2024 19:07:47 +1000 Subject: [PATCH] docs: small setup docs fixes (#1224) --- Makefile | 2 +- local/README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index f2d2d7004..4e8e5c91e 100644 --- a/Makefile +++ b/Makefile @@ -115,7 +115,7 @@ sysdeps: ifeq ($(APT_BASED),0) @$(call check_dep,go,Missing Go - install from https://go.dev/doc/install or 'sudo snap install go') @$(call check_dep,git,Missing Git - install with 'sudo apt install git') - @$(call check_dep,gcc,Missing gcc - install with 'sudo apt install build-essentials') + @$(call check_dep,gcc,Missing gcc - install with 'sudo apt install build-essential') @$(call check_dep,docker,Missing Docker - install from https://docs.docker.com/engine/install/') @$(call check_dep,docker-compose,Missing Docker Compose - install from https://docs.docker.com/engine/install/') @$(call check_dep,juju-db.mongo,Missing juju-db - install with 'sudo snap install juju-db --channel=4.4/stable') diff --git a/local/README.md b/local/README.md index 7541c3bf5..c75ad608e 100644 --- a/local/README.md +++ b/local/README.md @@ -6,8 +6,8 @@ used for integration testing within the JIMM test suite. # Starting the environment 1. Ensure you have `make` installed `sudo apt install make` -2. Check for system dependecies with `make sys-deps` this will inform you of any missing dependies and how to install them. -3. Set up necessary prequisites with `make dev-env-setup` +2. Check for system dependencies with `make sysdeps` this will inform you of any missing dependencies and how to install them. +3. Set up necessary prerequisites with `make dev-env-setup` 4. Start the dev env `make dev-env`, going forward you can skip steps 1-3. 5. To teardown the dev env `make dev-env-cleanup` @@ -47,7 +47,7 @@ The `request name` represents the literal WS endpoint, i.e., `API = /api`. 1. The following commands might need to be run to work around an [LXC networking issue](https://github.com/docker/for-linux/issues/103#issuecomment-383607773): `sudo iptables -F FORWARD && sudo iptables -P FORWARD ACCEPT`. -2. Install Juju: `sudo snap install juju --channel=3.3/stable` (minimum Juju version is `3.3`). +2. Install Juju: `sudo snap install juju --channel=3.5/stable` (minimum Juju version is `3.5`). 3. Install JQ: `sudo snap install jq`. ## Controller set up