This is an automated email from the ASF dual-hosted git repository.
frankchen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new b366a6c5a4 Add clarification around docker environment #8926 (#13084)
b366a6c5a4 is described below
commit b366a6c5a4aff9b535f35a200b30123737c790d3
Author: Charles Smith <[email protected]>
AuthorDate: Sat Sep 17 05:44:24 2022 -0700
Add clarification around docker environment #8926 (#13084)
* Add clarification around docker environment #8926
* fix spelling
* Update docs/tutorials/docker.md
Co-authored-by: Frank Chen <[email protected]>
* Update docs/tutorials/docker.md
Co-authored-by: Frank Chen <[email protected]>
* fix nano quickstart
Co-authored-by: Frank Chen <[email protected]>
---
docs/tutorials/docker.md | 12 ++++++++----
website/.spelling | 2 ++
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/docs/tutorials/docker.md b/docs/tutorials/docker.md
index 34953cfbba..c5cb5f22cf 100644
--- a/docs/tutorials/docker.md
+++ b/docs/tutorials/docker.md
@@ -22,9 +22,10 @@ title: "Tutorial: Run with Docker"
~ under the License.
-->
-In this quickstart, we will download the Apache Druid image from [Docker
Hub](https://hub.docker.com/r/apache/druid) and set it up on a single machine
using [Docker](https://www.docker.com/get-started) and [Docker
Compose](https://docs.docker.com/compose/). The cluster will be ready to load
data after completing this initial setup.
+This quickstart guides you through the steps to download the Apache Druid
image from [Docker Hub](https://hub.docker.com/r/apache/druid) and deploy it on
a single machine using [Docker](https://www.docker.com/get-started) and [Docker
Compose](https://docs.docker.com/compose/).
+After you finish the initial setup, the cluster will be ready to load data.
-Before beginning the quickstart, it is helpful to read the [general Druid
overview](../design/index.md) and the [ingestion
overview](../ingestion/index.md), as the tutorials will refer to concepts
discussed on those pages. Additionally, familiarity with
[Docker](https://www.docker.com/get-started) is recommended.
+Before beginning the quickstart, it is helpful to read the [general Druid
overview](../design/index.md) and the [ingestion
overview](../ingestion/index.md), because the tutorials refer to concepts
discussed on those pages. It also helps to be familiar with
[Docker](https://www.docker.com/get-started).
This tutorial assumes you will download the required files from GitHub. The
files are also available in a Druid installation and in the Druid sources.
@@ -34,9 +35,12 @@ This tutorial assumes you will download the required files
from GitHub. The file
### Docker memory requirements
-The default `docker-compose.yml` launches eight containers: Zookeeper,
PostgreSQL, and six Druid containers. Each Druid service is configured to use
up to 7 GB of memory (6 GB direct memory and 1 GB heap). However, the
Quickstart will not use all the available memory.
+The default `docker-compose.yml` launches eight containers: Zookeeper,
PostgreSQL, and six Druid containers based upon the [micro quickstart
configuration](../operations/single-server.html#micro-quickstart-4-cpu-16gib-ram).
+Each Druid service is configured to use up to 7 GiB of memory (6 GiB direct
memory and 1 GiB heap). However, the quickstart will not use all the available
memory.
-Docker needs at least 6 GiB of memory available for the Druid cluster. For
Docker Desktop on Mac OS, adjust the memory settings in the [Docker Desktop
preferences](https://docs.docker.com/desktop/mac/). If you experience a crash
with a 137 error code you likely don't have enough memory allocated to Docker.
+For this setup, Docker needs at least 6 GiB of memory available for the Druid
cluster. For Docker Desktop on Mac OS, adjust the memory settings in the
[Docker Desktop preferences](https://docs.docker.com/desktop/mac/). If you
experience a crash with a 137 error code you likely don't have enough memory
allocated to Docker.
+
+You can modify the value of `DRUID_SINGLE_NODE_CONF` in the Docker
[`environment`](#environment-file) to use different single-server mode. For
example to use the nano quickstart: `DRUID_SINGLE_NODE_CONF=nano-quickstart`.
## Getting started
diff --git a/website/.spelling b/website/.spelling
index 1b6752ff36..dffc50810e 100644
--- a/website/.spelling
+++ b/website/.spelling
@@ -2268,3 +2268,5 @@ KTable
Aotearoa
Czechia
Zeelund
+ - ../docs/tutorials/docker.md
+ nano
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
