From 504dd7861f98367a3668bfef951a65c7eb04f785 Mon Sep 17 00:00:00 2001 From: Bert Blommers Date: Tue, 6 Feb 2024 13:42:16 -0100 Subject: [PATCH] Specify Docker Desktop in development-environment-setup.md The list of required tools mentions `docker`, but that is a umbrella-term for a lot of things. Renaming it to `Docker Desktop` makes it more obvious that this specific Docker tool is required. The additional Tip is to help people if they happen to have only the Docker engine installed. One might think that the Docker Engine is enough, but newer versions of the engine do not include `buildx` by default, and building the LS Docker image fails in an odd way of `buildx` cannot be found. --- content/en/contributing/development-environment-setup.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/contributing/development-environment-setup.md b/content/en/contributing/development-environment-setup.md index 5a7ed6fd08..fa70e02fec 100644 --- a/content/en/contributing/development-environment-setup.md +++ b/content/en/contributing/development-environment-setup.md @@ -25,7 +25,7 @@ You will need the following tools for the local development of LocalStack. * [Maven](https://maven.apache.org/download.cgi) * [Gradle](https://gradle.org/install/) * [Terraform](https://www.terraform.io/downloads) -* [Docker](https://docs.docker.com/desktop/) +* [Docker Desktop](https://docs.docker.com/desktop/) * [Docker-Compose](https://docs.docker.com/compose/install/) We recommend you to individually install the above tools using your favorite package manager. For example, on macOS, you can use [Homebrew](https://brew.sh/) to install the above tools. @@ -72,4 +72,5 @@ $ make docker-build * If `virtualenv` chooses system python installations before your pyenv installations, manually initialize `virtualenv` before running `make install`: `virtualenv -p ~/.pyenv/shims/python3.10 .venv` . * Terraform needs version <0.14 to work currently. Use `tfenv` () to manage terraform versions comfortable. Quick start: `tfenv install 0.13.7 && tfenv use 0.13.7` -* Set env variable `LS_LOG='trace'` to print every `http` request sent to localstack and their responses. It is useful for debugging certain issues. \ No newline at end of file +* Set env variable `LS_LOG='trace'` to print every `http` request sent to localstack and their responses. It is useful for debugging certain issues. +* If `make docker-build` fails with the error `unknown flag: --pull`, you may not have buildx` installed. See this SO page for more information: https://askubuntu.com/questions/1467602/buildx-is-not-a-docker-command