From d320a722470d182a550823ec03cdf10b4ee7f58c Mon Sep 17 00:00:00 2001 From: aymanthefirst Date: Fri, 17 Dec 2021 14:16:15 +0000 Subject: [PATCH 1/4] Minor improvements to docs. --- docs/docker-compose/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index e14d2edf3..1a06e6daf 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -21,6 +21,12 @@ As well as the prerequisites mentioned on the [main README](/README.md#prerequis * [Docker](https://www.docker.com/products/docker-desktop) * [Docker Compose](https://docs.docker.com/compose/install) +## Configure Docker for Desktop + +In order to deploy onto Docker for Desktop we need to configure it with as much CPU and memory as possible on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. + +![Resources](../../docs/helm/diagrams/dfd-resources.png) + ## Deploy 1. Clone this repository or download one of the docker compose files from [here](../../docker-compose) From 186ddcd197aedf92f7f73ccea459bb6bee321faf Mon Sep 17 00:00:00 2001 From: aymanthefirst Date: Fri, 17 Dec 2021 14:54:57 +0000 Subject: [PATCH 2/4] Clarifying how much memory to allocate --- docs/docker-compose/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index 1a06e6daf..78381cfac 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -23,7 +23,7 @@ As well as the prerequisites mentioned on the [main README](/README.md#prerequis ## Configure Docker for Desktop -In order to deploy onto Docker for Desktop we need to configure it with as much CPU and memory as possible on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. +In order to deploy onto Docker for Desktop we need to allocate at least 13 Gb (preferably 16 Gb) to the Docker Engine on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. ![Resources](../../docs/helm/diagrams/dfd-resources.png) From e0fd9df0be9b36505ec4bffc334e5b9a8de525e3 Mon Sep 17 00:00:00 2001 From: aymanthefirst Date: Fri, 17 Dec 2021 15:03:54 +0000 Subject: [PATCH 3/4] Added link to docker-compose.yml --- docs/docker-compose/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index 78381cfac..f8cd06afe 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -23,7 +23,7 @@ As well as the prerequisites mentioned on the [main README](/README.md#prerequis ## Configure Docker for Desktop -In order to deploy onto Docker for Desktop we need to allocate at least 13 Gb (preferably 16 Gb) to the Docker Engine on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. +In order to deploy onto Docker for Desktop we need to allocate at least [13 Gb](../../docker-compose/docker-compose.yml) (preferably 16 Gb) to the Docker Engine on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. ![Resources](../../docs/helm/diagrams/dfd-resources.png) From e9a7aaf1c27a1fa4197518d92213aa27c13d2ef2 Mon Sep 17 00:00:00 2001 From: aymanthefirst Date: Tue, 21 Dec 2021 11:39:22 +0000 Subject: [PATCH 4/4] Addressed Jan's comment --- docs/docker-compose/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docker-compose/README.md b/docs/docker-compose/README.md index f8cd06afe..f108cc3db 100644 --- a/docs/docker-compose/README.md +++ b/docs/docker-compose/README.md @@ -23,7 +23,7 @@ As well as the prerequisites mentioned on the [main README](/README.md#prerequis ## Configure Docker for Desktop -In order to deploy onto Docker for Desktop we need to allocate at least [13 Gb](../../docker-compose/docker-compose.yml) (preferably 16 Gb) to the Docker Engine on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. +In order to deploy onto Docker for Desktop we need to allocate at least [13 Gb](../../docker-compose/docker-compose.yml) (preferably 16 Gb) to the Docker Engine on the "Resources" tab in Docker for Desktop's preferences pane as shown in the screenshot below. This is required because insufficient memory will cause containers to exit without warning. ![Resources](../../docs/helm/diagrams/dfd-resources.png)