Skip to content
This repository was archived by the owner on Apr 8, 2024. It is now read-only.

Commit 76446d1

Browse files
committed
incorporate feedback
1 parent 9bc67d3 commit 76446d1

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/deployment/containers/docker.rst

+20-20
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ Breaking the command down:
8181
and all its internal data will be lost. If you would like to avoid this,
8282
you can mount a dedicated volume (-v) for the container (each container
8383
would need its own dedicated folder on your dev machine, see
84-
:ref:`docker-compose` as reference)
84+
:ref:`docker-compose` as reference).
8585
- Puts the container into the ``crate`` network and maps port ``4201`` on your
86-
host machine to port ``4200`` on the container (admin UI)
86+
host machine to port ``4200`` on the container (admin UI).
8787
- Defines the environment variable ``CRATE_HEAP_SIZE`` which is used by CrateDB
88-
to allocate 2G for its heap
88+
to allocate 2G for its heap.
8989
- Runs the command ``crate`` inside the container with parameters:
9090
* ``network.host``: The ``_site_`` value results in the binding of the
9191
CrateDB process to a site-local IP address.
@@ -154,13 +154,13 @@ Now add the second node, ``crate02``, to the cluster::
154154

155155
Notice here that:
156156

157-
- You updated the container and node name to ``crate02``
157+
- You updated the container and node name to ``crate02``.
158158
- You updated the port mapping, so that port ``4202`` on your host is mapped
159-
to ``4200`` on the container
159+
to ``4200`` on the container.
160160
- You set the parameter ``discovery.seed_hosts`` to contain the other hosts of
161-
the cluster
161+
the cluster.
162162
- ``cluster.initial_master_nodes``: Since only nodes ``crate01`` and ``crate02``
163-
will participate in the election of the first master, this setting is unchanged
163+
will participate in the election of the first master, this setting is unchanged.
164164

165165
Now, if you go back to the admin UI you opened earlier, or visit the admin UI
166166
of the node you just created (located at ``http://localhost:4202/``) you
@@ -179,14 +179,14 @@ You can now add ``crate03`` like this::
179179

180180
Notice here that:
181181

182-
- You updated the container and node name to ``crate03``
182+
- You updated the container and node name to ``crate03``.
183183
- You updated the port mapping, so that port ``4203`` on your host is mapped
184-
to ``4200`` on the container
184+
to ``4200`` on the container.
185185
- You set parameter ``discovery.seed_hosts`` to contain the other hosts of the
186-
cluster
186+
cluster.
187187
- ``cluster.initial_master_nodes``: This setting is removed since only nodes
188188
``crate01`` and ``crate02`` will participate in the election of the first
189-
master
189+
master.
190190

191191

192192
Success! You just created a three-node CrateDB cluster with Docker.
@@ -336,18 +336,18 @@ define your services like this:
336336
environment:
337337
- CRATE_HEAP_SIZE=2g
338338
339-
In file above:
339+
In the file above:
340340

341-
- You specified the latest `compose file version`_
341+
- You specified the latest `compose file version`_.
342342
- You created three CrateDB services which pulls the latest CrateDB Docker
343-
image and maps the ports manually
343+
image and maps the ports manually.
344344
- You created a file system volume per instance and defined a set of
345-
configuration parameters (`-C`)
346-
- You defined some deploy settings and an environment variable for the heap size
345+
configuration parameters (`-C`).
346+
- You defined some deploy settings and an environment variable for the heap size.
347347
- Network settings no longer need to be defined in the latest compose file
348-
version because a `default network`_ will be created
348+
version because a `default network`_ will be created.
349349
- The start order of the containers is not deterministic and you want all
350-
three containers to be up and running before the election of the master node
350+
three containers to be up and running before the election of the master node.
351351

352352
Best Practices
353353
==============
@@ -439,7 +439,7 @@ Memory
439439
------
440440

441441
You must calculate and explicitly `set the maximum memory`_ that the container
442-
can use. This is dependant on your host system and should typically be as high
442+
can use. This is dependent on your host system and should typically be as high
443443
as possible.
444444

445445
You must then calculate the appropriate heap size (typically half the container's
@@ -452,7 +452,7 @@ CPU
452452
---
453453

454454
You must calculate and explicitly `set the maximum number of CPUs`_ that the
455-
container can use. This is dependant on your host system and should typically
455+
container can use. This is dependent on your host system and should typically
456456
be as high as possible.
457457

458458
Combined configuration

0 commit comments

Comments
 (0)