Instructions in README is incorrect

[kadishmal]

It says:

You can also pass in additional flags to elasticsearch:

docker run -d elasticsearch elasticsearch -Des.node.name="TestNode"

It should be either :

docker run -d elasticsearch -Des.node.name="TestNode"

Or:

docker run -d --name elasticsearch elasticsearch -Des.node.name="TestNode"

[md5]

Did you get an error when you ran docker run -d elasticsearch elasticsearch -Des.node.name="TestNode"? Looking at the entrypoint logic, it should work as documented as well as using the commands you specified.

[md5]

You can see the actual java command that was used to invoke ES by using docker top. Here's what I got when I ran the command from the README:

/usr/bin/java -Xms256m -Xmx1g -Xss256k -Djava.awt.headless=true -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseCMSInitiatingOccupancyOnly -XX:+HeapDumpOnOutOfMemoryError -XX:+DisableExplicitGC -Dfile.encoding=UTF-8 -Delasticsearch -Des.foreground=yes -Des.path.home=/usr/share/elasticsearch -cp :/usr/share/elasticsearch/lib/elasticsearch-1.4.5.jar:/usr/share/elasticsearch/lib/*:/usr/share/elasticsearch/lib/sigar/* -Des.node.name=TestNode org.elasticsearch.bootstrap.Elasticsearch

And here's what I got running docker run -d elasticsearch -Des.node.name="TestNode:

/usr/bin/java -Xms256m -Xmx1g -Xss256k -Djava.awt.headless=true -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseCMSInitiatingOccupancyOnly -XX:+HeapDumpOnOutOfMemoryError -XX:+DisableExplicitGC -Dfile.encoding=UTF-8 -Delasticsearch -Des.foreground=yes -Des.path.home=/usr/share/elasticsearch -cp :/usr/share/elasticsearch/lib/elasticsearch-1.4.5.jar:/usr/share/elasticsearch/lib/*:/usr/share/elasticsearch/lib/sigar/* -Des.node.name=TestNode org.elasticsearch.bootstrap.Elasticsearch

They look exactly the same to me.

[kadishmal]

-Des.node.name="TestNode" is correct. I updated my message above. It was my mistake not to look at a proper place.

However, the first issue explained above is still present, i.e. the command in the README is incorrect.

[md5]

@kadishmal It looks like the entrypoint was added in docker-library/elasticsearch#11, but the docs were written before that. At the time the docs were written, that was the only command that would work. The command in the README still works, so I wouldn't say it's "incorrect", just out-of-date.