Update Docker docs for 6.0.0-rc2 #27166

jarpy · 2017-10-30T05:53:22Z

Update the docs to match the new Docker "image flavours" of "basic",
"platinum", and "oss".

jarpy · 2017-10-30T05:57:04Z

docs/reference/setup/install/docker.asciidoc

@@ -49,7 +69,7 @@ Elasticsearch can be quickly started for development or testing use with the fol

 ["source","sh",subs="attributes"]
 --------------------------------------------
-docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" {docker-image}


We don't really need to bind transport to the host for dev mode, right?

This was discussed in this thread

Restored. I think it's a bit noisy, however.

jarpy · 2017-10-30T05:57:41Z

docs/reference/setup/install/docker.asciidoc

@@ -97,7 +117,7 @@ sysctl -w vm.max_map_count=262144
 +
 The `vm.max_map_count` setting must be set via docker-machine:
 +
-["source","sh"]
+["source","txt"]


Trying to control crazy syntax highlighting.

jarpy · 2017-10-30T05:58:01Z

docs/reference/setup/install/docker.asciidoc

@@ -109,7 +129,8 @@ To bring up the cluster, use the <<docker-prod-cluster-composefile,`docker-compo

 ifeval::["{release-state}"=="unreleased"]

-WARNING: Version {version} of the Elasticsearch Docker image has not yet been released, so a `docker-compose.yml` is not available for this version.
+WARNING: Version {version} of the Elasticsearch has not yet been released, so a
+`docker-compose.yml` is not available for this version.



Just using less words here.

Is the redundant here? i.e.

instead of

Version {version} of the Elasticsearch has not yet been released

to read

Version {version} of Elasticsearch has not yet been released

Trying to use fewer words... but not few enough! Thanks.

jarpy · 2017-10-30T05:59:46Z

docs/reference/setup/install/docker.asciidoc

-    image: docker.elastic.co/elasticsearch/elasticsearch:{version}
-    container_name: elasticsearch1
+  elasticsearch:
+    image: {docker-image}


Renaming this container to the default name makes it easier to add other Stack components without having to explicitly configure them to hit elasticsearch1. This also applies to Kibana and Logstash monitoring, which work out-of-the-box with this change.

jarpy · 2017-10-30T06:00:41Z

docs/reference/setup/install/docker.asciidoc

+additionally need the `memlock: true` ulimit, either defined in the
+https://docs.docker.com/engine/reference/commandline/dockerd/#default-ulimits[Docker
+Daemon] or specifically set for the container. This is demonstrated above in the
+<<docker-prod-cluster-composefile,docker-compose.yml>>. If using `docker run`:
 +


Made the "demonstrated earlier" part a bit friendlier sounding.

jarpy · 2017-10-30T06:01:49Z

docs/reference/setup/install/docker.asciidoc

@@ -154,25 +178,24 @@ services:
      memlock:
        soft: -1
        hard: -1
-    mem_limit: 1g
    volumes:


I don't think we should suggest this anymore because I believe it constrains the disk cache.

👍 this will help us close elastic/elasticsearch-docker#122

dliappis

Great and solid work, thanks!

I left a few comments.

I will also shortly issue a PR on top of this branch with some additional bug fixes and clarifications.

dliappis · 2017-10-30T07:13:43Z

docs/reference/setup/install/docker.asciidoc

@@ -49,7 +69,7 @@ Elasticsearch can be quickly started for development or testing use with the fol

 ["source","sh",subs="attributes"]
 --------------------------------------------
-docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" {docker-image}


This was discussed in this thread

dliappis · 2017-10-30T07:15:08Z

docs/reference/setup/install/docker.asciidoc

@@ -109,7 +129,8 @@ To bring up the cluster, use the <<docker-prod-cluster-composefile,`docker-compo

 ifeval::["{release-state}"=="unreleased"]

-WARNING: Version {version} of the Elasticsearch Docker image has not yet been released, so a `docker-compose.yml` is not available for this version.
+WARNING: Version {version} of the Elasticsearch has not yet been released, so a
+`docker-compose.yml` is not available for this version.



Is the redundant here? i.e.

instead of

Version {version} of the Elasticsearch has not yet been released

to read

Version {version} of Elasticsearch has not yet been released

dliappis · 2017-10-30T07:18:09Z

docs/reference/setup/install/docker.asciidoc

@@ -154,25 +178,24 @@ services:
      memlock:
        soft: -1
        hard: -1
-    mem_limit: 1g
    volumes:


👍 this will help us close elastic/elasticsearch-docker#122

dliappis · 2017-10-30T07:20:37Z

docs/reference/setup/install/docker.asciidoc

-USER root
-RUN chown elasticsearch:elasticsearch config/elasticsearch.yml
-USER elasticsearch
+COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/


This is great, however we need to be mindful that will will not work for people running anything older than docker-ce 17.09

I know, but I think we should write for the present. Everyone should build with the latest Docker. Upgrading your build workstation is not a big deal like upgrading your orchestrator.

That makes sense.

dliappis · 2017-10-30T09:39:12Z

docs/reference/setup/install/docker.asciidoc


-NOTE: {xpack-ref}/index.html[X-Pack] is preinstalled in this image.
-Please take a few minutes to familiarize yourself with {xpack-ref}/security-getting-started.html[X-Pack Security] and how to change default passwords. The default password for the `elastic` user is `changeme`.
+The images are available in three different configurations or "flavours". The


I believe the style guide mandates American English for conformity, so probably needs to be flavors. I get caught by this frequently.

I couldn't find that in the guide. Do we have an official dialect, @hstephenson?

Switched to US spelling since I want to ship this and it doesn't really hurt anything except my cultural pride (which is not particularly relevant, let's face it).

dliappis · 2017-10-30T13:29:04Z

@jarpy You may want to review https://github.com/jarpy/elasticsearch/pull/1/files as before tweaking this further.

Update the docs to match the new Docker "image flavours" of "basic", "platinum", and "oss".

* Clarifications for Openshift and bind-mounts * Bump docker-compose 2.x format to 2.2 * Combine Docker Toolbox instructions for setting vm.max_map_count for both macOS + Windows * devicemapper is not the default storage driver any more on RHEL

jarpy · 2017-10-31T01:05:48Z

docs/reference/setup/install/docker.asciidoc

+  chmod g+rwx esdatadir
+  chgrp 1000 esdatadir
+
+As a last resort, you can also force the container to mutate the ownership of any bind-mounts used for the <<path-settings,data and log dirs>> through the environment variable `TAKE_FILE_OWNERSHIP`; in this case they will be owned by uid:gid `1000:0` providing read/write access to the elasticsearch process as required.


"As a last resort" 👍

* Update Docker docs for 6.0.0-rc2 * Update the docs to match the new Docker "image flavours" of "basic", "platinum", and "oss". * Clarifications for Openshift and bind-mounts * Bump docker-compose 2.x format to 2.2 * Combine Docker Toolbox instructions for setting vm.max_map_count for both macOS + Windows * devicemapper is not the default storage driver any more on RHEL

* master: Enhances exists queries to reduce need for `_field_names` (elastic#26930) Added new terms_set query Set request body to required to reflect the code base (elastic#27188) Update Docker docs for 6.0.0-rc2 (elastic#27166) Add version 6.0.0 Docs: restore now fails if it encounters incompatible settings (elastic#26933) Convert index blocks to cluster block exceptions (elastic#27050) [DOCS] Link remote info API in Cross Cluster Search docs page Fix Laplace scorer to multiply by alpha (and not add) (elastic#27125) [DOCS] Clarify migrate guide and search request validation Raise IllegalArgumentException if query validation failed (elastic#26811) prevent duplicate fields when mixing parent and root nested includes (elastic#27072) TopHitsAggregator must propagate calls to `setScorer`. (elastic#27138)

* master: Remove checkpoint tracker bit sets setting Fix stable BWC branch detection logic Fix logic detecting unreleased versions Enhances exists queries to reduce need for `_field_names` (elastic#26930) Added new terms_set query Set request body to required to reflect the code base (elastic#27188) Update Docker docs for 6.0.0-rc2 (elastic#27166) Add version 6.0.0 Docs: restore now fails if it encounters incompatible settings (elastic#26933) Convert index blocks to cluster block exceptions (elastic#27050) [DOCS] Link remote info API in Cross Cluster Search docs page Fix Laplace scorer to multiply by alpha (and not add) (elastic#27125) [DOCS] Clarify migrate guide and search request validation Raise IllegalArgumentException if query validation failed (elastic#26811) prevent duplicate fields when mixing parent and root nested includes (elastic#27072) TopHitsAggregator must propagate calls to `setScorer`. (elastic#27138)

* master: Lazy initialize checkpoint tracker bit sets Remove checkpoint tracker bit sets setting Fix stable BWC branch detection logic Fix logic detecting unreleased versions Enhances exists queries to reduce need for `_field_names` (#26930) Added new terms_set query Set request body to required to reflect the code base (#27188) Update Docker docs for 6.0.0-rc2 (#27166) Add version 6.0.0 Docs: restore now fails if it encounters incompatible settings (#26933) Convert index blocks to cluster block exceptions (#27050) [DOCS] Link remote info API in Cross Cluster Search docs page Fix Laplace scorer to multiply by alpha (and not add) (#27125) [DOCS] Clarify migrate guide and search request validation Raise IllegalArgumentException if query validation failed (#26811) prevent duplicate fields when mixing parent and root nested includes (#27072) TopHitsAggregator must propagate calls to `setScorer`. (#27138)

* 6.x: Lazy initialize checkpoint tracker bit sets Remove checkpoint tracker bit sets setting Tests: Fix FullClusterRestartIT.testSnapshotRestore test failing in 6.x (#27218) Fix FullClusterRestartIT using lenient booleans with 6.0 Fix stable BWC branch detection logic Add version 6.0.0 Fix logic detecting unreleased versions Skips exists query tests on unsupported versions Enhances exists queries to reduce need for `_field_names` (#26930) Added new terms_set query Set request body to required to reflect the code base (#27188) Update Docker docs for 6.0.0-rc2 (#27166) Docs: restore now fails if it encounters incompatible settings (#26933) Convert index blocks to cluster block exceptions (#27050) [DOCS] Link remote info API in Cross Cluster Search docs page prevent duplicate fields when mixing parent and root nested includes (#27072) TopHitsAggregator must propagate calls to `setScorer`. (#27138)

jarpy requested a review from dliappis October 30, 2017 05:53

jarpy added v6.0.0 >docs General docs changes labels Oct 30, 2017

jarpy commented Oct 30, 2017

View reviewed changes

dliappis requested changes Oct 30, 2017

View reviewed changes

jarpy and others added 4 commits October 31, 2017 11:51

Update Docker docs for 6.0.0-rc2

2d878cf

Update the docs to match the new Docker "image flavours" of "basic", "platinum", and "oss".

Docker: Various 6.0 updates

ee5d684

* Clarifications for Openshift and bind-mounts * Bump docker-compose 2.x format to 2.2 * Combine Docker Toolbox instructions for setting vm.max_map_count for both macOS + Windows * devicemapper is not the default storage driver any more on RHEL

Restore transport client port to Docker example

9f0565d

Remove extra word in Docker docs

edb9407

jarpy commented Oct 31, 2017

View reviewed changes

jarpy added 2 commits October 31, 2017 12:10

Missing comma in Docker docs

4eeebb6

Use US spelling in Docker docs

d940a5d

dliappis approved these changes Oct 31, 2017

View reviewed changes

jarpy merged commit b71f7d3 into elastic:master Nov 1, 2017

jarpy added v6.1.0 v7.0.0 labels Nov 1, 2017

lcawl removed the v6.1.0 label Dec 12, 2017

lcawl mentioned this pull request Jul 10, 2018

[DOCS] Removes alternative docker pull example #31934

Merged

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Docker docs for 6.0.0-rc2 #27166

Update Docker docs for 6.0.0-rc2 #27166

jarpy commented Oct 30, 2017

jarpy Oct 30, 2017

dliappis Oct 30, 2017

jarpy Oct 31, 2017

jarpy Oct 30, 2017

jarpy Oct 30, 2017

dliappis Oct 30, 2017

jarpy Oct 31, 2017

jarpy Oct 30, 2017

jarpy Oct 30, 2017 •

edited

jarpy Oct 30, 2017

dliappis Oct 30, 2017

dliappis left a comment

dliappis Oct 30, 2017

dliappis Oct 30, 2017

dliappis Oct 30, 2017

dliappis Oct 30, 2017

jarpy Oct 31, 2017 •

edited

dliappis Oct 31, 2017

dliappis Oct 30, 2017

jarpy Oct 31, 2017

jarpy Oct 31, 2017

dliappis commented Oct 30, 2017

jarpy Oct 31, 2017

Update Docker docs for 6.0.0-rc2 #27166

Update Docker docs for 6.0.0-rc2 #27166

Conversation

jarpy commented Oct 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jarpy Oct 30, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dliappis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jarpy Oct 31, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dliappis commented Oct 30, 2017

Choose a reason for hiding this comment

jarpy Oct 30, 2017 •

edited

jarpy Oct 31, 2017 •

edited