docker.asciidoc 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  1. [[docker]]
  2. === Install {es} with Docker
  3. {es} is also available as Docker images. A list of all published Docker
  4. images and tags is available at
  5. https://www.docker.elastic.co[www.docker.elastic.co]. The source files are
  6. in
  7. https://github.com/elastic/elasticsearch/blob/{branch}/distribution/docker[Github].
  8. include::license.asciidoc[]
  9. Starting in {es} 8.0, security is enabled by default. With security enabled,
  10. {stack} {security-features} require TLS encryption for the transport networking
  11. layer, or your cluster will fail to start.
  12. ==== Install Docker Desktop or Docker Engine
  13. Install the appropriate https://docs.docker.com/get-docker/[Docker application]
  14. for your operating system.
  15. NOTE: Make sure that Docker is allotted at least 4GiB of memory. In Docker
  16. Desktop, you configure resource usage on the Advanced tab in Preference (macOS)
  17. or Settings (Windows).
  18. ==== Pull the {es} Docker image
  19. Obtaining {es} for Docker is as simple as issuing a `docker pull` command
  20. against the Elastic Docker registry.
  21. ifeval::["{release-state}"=="unreleased"]
  22. WARNING: Version {version} of {es} has not yet been released, so no
  23. Docker image is currently available for this version.
  24. endif::[]
  25. ifeval::["{release-state}"!="unreleased"]
  26. [source,sh,subs="attributes"]
  27. ----
  28. docker pull {docker-repo}:{version}
  29. ----
  30. endif::[]
  31. Now that you have the {es} Docker image, you can start a
  32. <<docker-cli-run-dev-mode,single-node>> or <<docker-compose-file,multi-node>>
  33. cluster.
  34. [[docker-cli-run-dev-mode]]
  35. ==== Start a single-node cluster with Docker
  36. ifeval::["{release-state}"=="unreleased"]
  37. WARNING: Version {version} of the {es} Docker image has not yet been released.
  38. endif::[]
  39. If you're starting a single-node {es} cluster in a Docker container, security
  40. will be automatically enabled and configured for you. When you start {es} for
  41. the first time, the following security configuration occurs automatically:
  42. * <<elasticsearch-security-certificates,Certificates and keys>> are generated
  43. for the transport and HTTP layers.
  44. * The Transport Layer Security (TLS) configuration settings are written to
  45. `elasticsearch.yml`.
  46. * A password is generated for the `elastic` user.
  47. * An enrollment token is generated for {kib}.
  48. You can then {kibana-ref}/docker.html[start {kib}] and enter the enrollment
  49. token, which is valid for 30 minutes. This token automatically applies the
  50. security settings from your {es} cluster, authenticates to {es} with the
  51. `kibana_system` user, and writes the security configuration to `kibana.yml`.
  52. The following command starts a single-node {es} cluster for development or
  53. testing.
  54. . Start {es} in Docker. A password is generated for the `elastic` user and
  55. output to the terminal, plus an enrollment token for enrolling {kib}.
  56. +
  57. --
  58. ifeval::["{release-state}"!="unreleased"]
  59. [source,sh,subs="attributes"]
  60. ----
  61. docker run --name es-node01 -p 9200:9200 -p 9300:9300 -it {docker-image}
  62. ----
  63. endif::[]
  64. --
  65. +
  66. TIP: You might need to scroll back a bit in the terminal to view the password
  67. and enrollment token.
  68. . Copy the generated password and enrollment token and save them in a secure
  69. location. These values are shown only when you start {es} for the first time.
  70. +
  71. [NOTE]
  72. ====
  73. If you need to reset the password for the `elastic` user or other
  74. built-in users, run the <<reset-password,`elasticsearch-reset-password`>> tool.
  75. This tool is available in the {es} `/bin` directory of the Docker container.
  76. For example:
  77. [source,sh]
  78. ----
  79. docker exec -it es-node01 /usr/share/elasticsearch/bin/elasticsearch-reset-password
  80. ----
  81. ====
  82. . Copy the `http_ca.crt` security certificate from your Docker container to
  83. your local machine.
  84. +
  85. [source,sh]
  86. ----
  87. docker cp es-node01:/usr/share/elasticsearch/config/tls_auto_config_*/http_ca.crt .
  88. ----
  89. . Open a new terminal and verify that you can connect to your {es} cluster by
  90. making an authenticated call, using the `http_ca.crt` file that you copied from
  91. your Docker container. Enter the password for the `elastic` user when prompted.
  92. +
  93. [source,sh]
  94. ----
  95. curl --cacert http_ca.crt -u elastic https://localhost:9200
  96. ----
  97. // NOTCONSOLE
  98. ===== Next steps
  99. You now have a test {es} environment set up. Before you start
  100. serious development or go into production with {es}, review the
  101. <<docker-prod-prerequisites,requirements and recommendations>> to apply when running {es} in Docker in production.
  102. [[elasticsearch-security-certificates]]
  103. ===== Security certificates and keys
  104. When you start {es} for the first time, the following certificates and keys are
  105. generated in the
  106. `/usr/share/elasticsearch/config/tls_auto_config_initial_node_<timestamp>`
  107. directory in the Docker container, and allow you to connect a {kib} instance
  108. to your secured {es} cluster and encrypt internode communication. The files are
  109. listed here for reference.
  110. `http_ca.crt`::
  111. The CA certificate that is used to sign the certificates for the HTTP layer of
  112. this {es} cluster.
  113. `http_keystore_local_node.p12`::
  114. Keystore that contains the key and certificate for the HTTP layer for this node.
  115. `transport_keystore_all_nodes.p12`::
  116. Keystore that contains the key and certificate for the transport layer for all
  117. the nodes in your cluster.
  118. [[docker-compose-file]]
  119. ==== Start a multi-node cluster with Docker Compose
  120. When defining multiple nodes in a `docker-compose.yml` file, you'll need to
  121. explicitly enable and configure security so that {es} doesn't try to generate a
  122. password for the `elastic` user on every node.
  123. ===== Prepare the environment
  124. The following example uses Docker Compose to start a three-node {es} cluster.
  125. Create each of the following files inside of a new directory. Copy and paste the
  126. contents of each example into the appropriate file as described in the
  127. following sections:
  128. * <<docker-instances-yml,`instances.yml`>>
  129. * <<docker-env,`.env`>>
  130. * <<docker-create-certs,`create-certs.yml`>>
  131. * <<docker-docker-compose,`docker-compose.yml`>>
  132. [[docker-instances-yml]]
  133. [discrete]
  134. ===== `instances.yml`
  135. When you run the example, {es} uses this file to create a three-node cluster.
  136. The nodes are named `es01`, `es02`,and `es03`.
  137. ifeval::["{release-state}"=="unreleased"]
  138. --
  139. WARNING: Version {version} of {es} has not yet been released, so a
  140. `docker-compose.yml` is not available for this version.
  141. endif::[]
  142. ifeval::["{release-state}"!="unreleased"]
  143. [source,yaml,subs="attributes"]
  144. ----
  145. include::instances.yml[]
  146. ----
  147. endif::[]
  148. --
  149. [[docker-env]]
  150. [discrete]
  151. ===== `.env`
  152. The `.env` file sets environment variables that are used when you run the
  153. example. Ensure that you specify a strong password for the `elastic` user with
  154. the `ELASTIC_PASSWORD` variable. This variable is referenced by the
  155. `docker-compose.yml` file.
  156. ifeval::["{release-state}"=="unreleased"]
  157. --
  158. WARNING: Version {version} of {es} has not yet been released, so a
  159. `docker-compose.yml` is not available for this version.
  160. endif::[]
  161. ifeval::["{release-state}"!="unreleased"]
  162. [source,yaml,subs="attributes"]
  163. ----
  164. include::.env[]
  165. ----
  166. endif::[]
  167. --
  168. `COMPOSE_PROJECT_NAME`:: Adds an `es_` prefix for all volumes and networks
  169. created by `docker-compose`.
  170. `CERTS_DIR`:: Specifies the path inside the Docker image where {es} expects the
  171. security certificates.
  172. `ELASTIC_PASSWORD`:: Sets the initial password for the `elastic` user.
  173. [discrete]
  174. [[docker-create-certs]]
  175. ===== `create-certs.yml`
  176. The `create-certs.yml` file includes a script that generates node certificates
  177. and a certificate authority (CA) certificate and key where {es} expects them.
  178. These certificates and key are placed in a Docker volume named `es_certs`.
  179. ifeval::["{release-state}"=="unreleased"]
  180. --
  181. WARNING: Version {version} of {es} has not yet been released, so a
  182. `docker-compose.yml` is not available for this version.
  183. endif::[]
  184. ifeval::["{release-state}"!="unreleased"]
  185. [source,yaml,subs="attributes"]
  186. ----
  187. include::create-certs.yml[]
  188. ----
  189. endif::[]
  190. --
  191. [[docker-docker-compose]]
  192. [discrete]
  193. ===== `docker-compose.yml`
  194. The `docker-compose.yml` file defines configuration settings for each of your
  195. {es} nodes.
  196. NOTE: This sample `docker-compose.yml` file uses the `ES_JAVA_OPTS`
  197. environment variable to manually set the heap size to 512MB. We do not recommend
  198. using `ES_JAVA_OPTS` in production.
  199. See <<docker-set-heap-size,manually set the heap size>>.
  200. This configuration exposes port `9200` on all network interfaces. Given how
  201. Docker manipulates `iptables` on Linux, this means that your {es} cluster is
  202. publicly accessible, potentially ignoring any firewall settings. If you don't
  203. want to expose port `9200` and instead use a reverse proxy, replace `9200:9200`
  204. with `127.0.0.1:9200:9200` in the `docker-compose.yml` file. {es} will then only
  205. be accessible from the host machine itself.
  206. ifeval::["{release-state}"=="unreleased"]
  207. --
  208. WARNING: Version {version} of {es} has not yet been released, so a
  209. `docker-compose.yml` is not available for this version.
  210. endif::[]
  211. ifeval::["{release-state}"!="unreleased"]
  212. [source,yaml,subs="attributes"]
  213. ----
  214. include::docker-compose.yml[]
  215. ----
  216. endif::[]
  217. --
  218. ===== Start your cluster with security enabled and configured
  219. This sample Docker Compose file starts a three-node {es} cluster.
  220. The https://docs.docker.com/storage/volumes[Docker named volumes]
  221. `data01`, `data02`, and `data03` store the node data directories so that the
  222. data persists across restarts. If they don't already exist, running
  223. `docker-compose` creates these volumes.
  224. [[docker-generate-certificates]]
  225. . Generate the certificates. You only need to run this command one time:
  226. +
  227. ["source","sh"]
  228. ----
  229. docker-compose -f create-certs.yml run --rm create_certs
  230. ----
  231. . Start your {es} nodes with TLS configured on the transport layer:
  232. +
  233. ["source","sh"]
  234. ----
  235. docker-compose up -d
  236. ----
  237. +
  238. Node `es01` listens on `localhost:9200` and `es02` and `es03` talk to `es01`
  239. over a Docker network.
  240. . Access the {es} API over TLS using the bootstrapped password for the `elastic`
  241. user that you specified in the `.env` file:
  242. +
  243. ["source","sh",subs="attributes"]
  244. ----
  245. docker run --rm -v es_certs:/certs --network=es_default {docker-image} curl --cacert /certs/ca/ca.crt -u elastic:<password> https://es01:9200
  246. ----
  247. // NOTCONSOLE
  248. +
  249. --
  250. `es_certs`:: The name of the volume that the script in `create-certs.yml`
  251. creates to hold your certificates.
  252. `<password>`:: The password for the `elastic` user, defined by the
  253. `ELASTIC_PASSWORD` variable in the `.env` file.
  254. --
  255. . Submit a `_cat/nodes` request to check that the nodes are up and running:
  256. +
  257. [source,sh]
  258. ----
  259. curl -X GET "https://localhost:9200/_cat/nodes?v=true&pretty"
  260. ----
  261. // NOTCONSOLE
  262. Log messages go to the console and are handled by the configured Docker logging
  263. driver. By default, you can access logs with `docker logs`. If you prefer that
  264. the {es} container write logs to disk, set the `ES_LOG_STYLE` environment
  265. variable to `file`. This causes {es} to use the same logging configuration as
  266. other {es} distribution formats.
  267. If you need to generate a new password for the `elastic` user or any of the
  268. built-in users, use the `elasticsearch-reset-password` tool:
  269. WARNING: Windows users not running PowerShell must remove all backslashes (`\`)
  270. and join lines in the following command.
  271. ["source","sh"]
  272. ----
  273. docker exec es01 /bin/bash -c "bin/elasticsearch-reset-password \
  274. auto --batch \
  275. --url https://localhost:9200"
  276. ----
  277. ===== Stop the cluster
  278. To stop the cluster, run `docker-compose down`. The data in the Docker volumes
  279. is preserved and loaded when you restart the cluster with `docker-compose up`.
  280. --
  281. ["source","sh"]
  282. ----
  283. docker-compose down
  284. ----
  285. --
  286. To **delete the data volumes** when you stop the cluster, specify the `-v`
  287. option:
  288. ["source","sh"]
  289. ----
  290. docker-compose down -v
  291. ----
  292. WARNING: Deleting data volumes will remove the generated security certificates
  293. for your nodes. You will need to run `docker-compose` and
  294. <<docker-generate-certificates,regenerate the security certificates>> before
  295. starting your cluster.
  296. ===== Next steps
  297. You now have a test {es} environment set up. Before you start
  298. serious development or go into production with {es}, review the
  299. <<docker-prod-prerequisites,requirements and recommendations>> to apply when running {es} in Docker in production.
  300. [[docker-prod-prerequisites]]
  301. ==== Using the Docker images in production
  302. The following requirements and recommendations apply when running {es} in Docker in production.
  303. ===== Set `vm.max_map_count` to at least `262144`
  304. The `vm.max_map_count` kernel setting must be set to at least `262144` for production use.
  305. How you set `vm.max_map_count` depends on your platform:
  306. * Linux
  307. +
  308. --
  309. The `vm.max_map_count` setting should be set permanently in `/etc/sysctl.conf`:
  310. [source,sh]
  311. --------------------------------------------
  312. grep vm.max_map_count /etc/sysctl.conf
  313. vm.max_map_count=262144
  314. --------------------------------------------
  315. To apply the setting on a live system, run:
  316. [source,sh]
  317. --------------------------------------------
  318. sysctl -w vm.max_map_count=262144
  319. --------------------------------------------
  320. --
  321. * macOS with https://docs.docker.com/docker-for-mac[Docker for Mac]
  322. +
  323. --
  324. The `vm.max_map_count` setting must be set within the xhyve virtual machine:
  325. . From the command line, run:
  326. +
  327. [source,sh]
  328. --------------------------------------------
  329. screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
  330. --------------------------------------------
  331. . Press enter and use`sysctl` to configure `vm.max_map_count`:
  332. +
  333. [source,sh]
  334. --------------------------------------------
  335. sysctl -w vm.max_map_count=262144
  336. --------------------------------------------
  337. . To exit the `screen` session, type `Ctrl a d`.
  338. --
  339. * Windows and macOS with https://www.docker.com/products/docker-desktop[Docker Desktop]
  340. +
  341. --
  342. The `vm.max_map_count` setting must be set via docker-machine:
  343. [source,sh]
  344. --------------------------------------------
  345. docker-machine ssh
  346. sudo sysctl -w vm.max_map_count=262144
  347. --------------------------------------------
  348. --
  349. * Windows with https://docs.docker.com/docker-for-windows/wsl[Docker Desktop WSL 2 backend]
  350. +
  351. --
  352. The `vm.max_map_count` setting must be set in the docker-desktop container:
  353. [source,sh]
  354. --------------------------------------------
  355. wsl -d docker-desktop
  356. sysctl -w vm.max_map_count=262144
  357. --------------------------------------------
  358. --
  359. ===== Configuration files must be readable by the `elasticsearch` user
  360. By default, {es} runs inside the container as user `elasticsearch` using
  361. uid:gid `1000:0`.
  362. IMPORTANT: One exception is https://docs.openshift.com/container-platform/3.6/creating_images/guidelines.html#openshift-specific-guidelines[Openshift],
  363. which runs containers using an arbitrarily assigned user ID.
  364. Openshift presents persistent volumes with the gid set to `0`, which works without any adjustments.
  365. If you are bind-mounting a local directory or file, it must be readable by the `elasticsearch` user.
  366. In addition, this user must have write access to the <<path-settings,config, data and log dirs>>
  367. ({es} needs write access to the `config` directory so that it can generate a keystore).
  368. A good strategy is to grant group access to gid `0` for the local directory.
  369. For example, to prepare a local directory for storing data through a bind-mount:
  370. [source,sh]
  371. --------------------------------------------
  372. mkdir esdatadir
  373. chmod g+rwx esdatadir
  374. chgrp 0 esdatadir
  375. --------------------------------------------
  376. You can also run an {es} container using both a custom UID and GID. Unless you
  377. bind-mount each of the `config`, `data` and `logs` directories, you must pass
  378. the command line option `--group-add 0` to `docker run`. This ensures that the user
  379. under which {es} is running is also a member of the `root` (GID 0) group inside the
  380. container.
  381. ===== Increase ulimits for nofile and nproc
  382. Increased ulimits for <<setting-system-settings,nofile>> and <<max-number-threads-check,nproc>>
  383. must be available for the {es} containers.
  384. Verify the https://github.com/moby/moby/tree/ea4d1243953e6b652082305a9c3cda8656edab26/contrib/init[init system]
  385. for the Docker daemon sets them to acceptable values.
  386. To check the Docker daemon defaults for ulimits, run:
  387. [source,sh]
  388. --------------------------------------------
  389. docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{version} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
  390. --------------------------------------------
  391. If needed, adjust them in the Daemon or override them per container.
  392. For example, when using `docker run`, set:
  393. [source,sh]
  394. --------------------------------------------
  395. --ulimit nofile=65535:65535
  396. --------------------------------------------
  397. ===== Disable swapping
  398. Swapping needs to be disabled for performance and node stability.
  399. For information about ways to do this, see <<setup-configuration-memory>>.
  400. If you opt for the `bootstrap.memory_lock: true` approach,
  401. you also need to define the `memlock: true` ulimit in the
  402. https://docs.docker.com/engine/reference/commandline/dockerd/#default-ulimits[Docker Daemon],
  403. or explicitly set for the container as shown in the <<docker-compose-file, sample compose file>>.
  404. When using `docker run`, you can specify:
  405. [source,sh]
  406. ----
  407. -e "bootstrap.memory_lock=true" --ulimit memlock=-1:-1
  408. ----
  409. ===== Randomize published ports
  410. The image https://docs.docker.com/engine/reference/builder/#/expose[exposes]
  411. TCP ports 9200 and 9300. For production clusters, randomizing the
  412. published ports with `--publish-all` is recommended,
  413. unless you are pinning one container per host.
  414. [[docker-set-heap-size]]
  415. ===== Manually set the heap size
  416. By default, {es} automatically sizes JVM heap based on a nodes's
  417. <<node-roles,roles>> and the total memory available to the node's container. We
  418. recommend this default sizing for most production environments. If needed, you
  419. can override default sizing by manually setting JVM heap size.
  420. To manually set the heap size in production, bind mount a <<set-jvm-options,JVM
  421. options>> file under `/usr/share/elasticsearch/config/jvm.options.d` that
  422. includes your desired <<set-jvm-heap-size,heap size>> settings.
  423. For testing, you can also manually set the heap size using the `ES_JAVA_OPTS`
  424. environment variable. For example, to use 16GB, specify `-e
  425. ES_JAVA_OPTS="-Xms16g -Xmx16g"` with `docker run`. The `ES_JAVA_OPTS` variable
  426. overrides all other JVM options. The `ES_JAVA_OPTS` variable overrides all other
  427. JVM options. We do not recommend using `ES_JAVA_OPTS` in production. The
  428. `docker-compose.yml` file above sets the heap size to 512MB.
  429. ===== Pin deployments to a specific image version
  430. Pin your deployments to a specific version of the {es} Docker image. For
  431. example +docker.elastic.co/elasticsearch/elasticsearch:{version}+.
  432. ===== Always bind data volumes
  433. You should use a volume bound on `/usr/share/elasticsearch/data` for the following reasons:
  434. . The data of your {es} node won't be lost if the container is killed
  435. . {es} is I/O sensitive and the Docker storage driver is not ideal for fast I/O
  436. . It allows the use of advanced
  437. https://docs.docker.com/engine/extend/plugins/#volume-plugins[Docker volume plugins]
  438. ===== Avoid using `loop-lvm` mode
  439. If you are using the devicemapper storage driver, do not use the default `loop-lvm` mode.
  440. Configure docker-engine to use
  441. https://docs.docker.com/engine/userguide/storagedriver/device-mapper-driver/#configure-docker-with-devicemapper[direct-lvm].
  442. ===== Centralize your logs
  443. Consider centralizing your logs by using a different
  444. https://docs.docker.com/engine/admin/logging/overview/[logging driver]. Also
  445. note that the default json-file logging driver is not ideally suited for
  446. production use.
  447. [[docker-configuration-methods]]
  448. ==== Configuring {es} with Docker
  449. When you run in Docker, the <<config-files-location,{es} configuration files>> are loaded from
  450. `/usr/share/elasticsearch/config/`.
  451. To use custom configuration files, you <<docker-config-bind-mount, bind-mount the files>>
  452. over the configuration files in the image.
  453. You can set individual {es} configuration parameters using Docker environment variables.
  454. The <<docker-compose-file, sample compose file>> and the
  455. <<docker-cli-run-dev-mode, single-node example>> use this method. You can
  456. use the setting name directly as the environment variable name. If
  457. you cannot do this, for example because your orchestration platform forbids
  458. periods in environment variable names, then you can use an alternative
  459. style by converting the setting name as follows.
  460. . Change the setting name to uppercase
  461. . Prefix it with `ES_SETTING_`
  462. . Escape any underscores (`_`) by duplicating them
  463. . Convert all periods (`.`) to underscores (`_`)
  464. For example, `-e bootstrap.memory_lock=true` becomes
  465. `-e ES_SETTING_BOOTSTRAP_MEMORY__LOCK=true`.
  466. You can use the contents of a file to set the value of the
  467. `ELASTIC_PASSWORD` or `KEYSTORE_PASSWORD` environment variables, by
  468. suffixing the environment variable name with `_FILE`. This is useful for
  469. passing secrets such as passwords to {es} without specifying them directly.
  470. For example, to set the {es} bootstrap password from a file, you can bind mount the
  471. file and set the `ELASTIC_PASSWORD_FILE` environment variable to the mount location.
  472. If you mount the password file to `/run/secrets/bootstrapPassword.txt`, specify:
  473. [source,sh]
  474. --------------------------------------------
  475. -e ELASTIC_PASSWORD_FILE=/run/secrets/bootstrapPassword.txt
  476. --------------------------------------------
  477. You can override the default command for the image to pass {es} configuration
  478. parameters as command line options. For example:
  479. [source,sh]
  480. --------------------------------------------
  481. docker run <various parameters> bin/elasticsearch -Ecluster.name=mynewclustername
  482. --------------------------------------------
  483. While bind-mounting your configuration files is usually the preferred method in production,
  484. you can also <<_c_customized_image, create a custom Docker image>>
  485. that contains your configuration.
  486. [[docker-config-bind-mount]]
  487. ===== Mounting {es} configuration files
  488. Create custom config files and bind-mount them over the corresponding files in the Docker image.
  489. For example, to bind-mount `custom_elasticsearch.yml` with `docker run`, specify:
  490. [source,sh]
  491. --------------------------------------------
  492. -v full_path_to/custom_elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml
  493. --------------------------------------------
  494. If you bind-mount a custom `elasticsearch.yml` file, ensure it includes the
  495. `network.host: 0.0.0.0` setting. This setting ensures the node is reachable for
  496. HTTP and transport traffic, provided its ports are exposed. The Docker image's
  497. built-in `elasticsearch.yml` file includes this setting by default.
  498. IMPORTANT: The container **runs {es} as user `elasticsearch` using
  499. uid:gid `1000:0`**. Bind mounted host directories and files must be accessible by this user,
  500. and the data and log directories must be writable by this user.
  501. [[docker-keystore-bind-mount]]
  502. ===== Create an encrypted {es} keystore
  503. By default, {es} will auto-generate a keystore file for <<secure-settings,secure
  504. settings>>. This file is obfuscated but not encrypted.
  505. To encrypt your secure settings with a password and have them persist outside
  506. the container, use a `docker run` command to manually create the keystore
  507. instead. The command must:
  508. * Bind-mount the `config` directory. The command will create an
  509. `elasticsearch.keystore` file in this directory. To avoid errors, do
  510. not directly bind-mount the `elasticsearch.keystore` file.
  511. * Use the `elasticsearch-keystore` tool with the `create -p` option. You'll be
  512. prompted to enter a password for the keystore.
  513. ifeval::["{release-state}"!="unreleased"]
  514. For example:
  515. [source,sh,subs="attributes"]
  516. ----
  517. docker run -it --rm \
  518. -v full_path_to/config:/usr/share/elasticsearch/config \
  519. docker.elastic.co/elasticsearch/elasticsearch:{version} \
  520. bin/elasticsearch-keystore create -p
  521. ----
  522. You can also use a `docker run` command to add or update secure settings in the
  523. keystore. You'll be prompted to enter the setting values. If the keystore is
  524. encrypted, you'll also be prompted to enter the keystore password.
  525. [source,sh,subs="attributes"]
  526. ----
  527. docker run -it --rm \
  528. -v full_path_to/config:/usr/share/elasticsearch/config \
  529. docker.elastic.co/elasticsearch/elasticsearch:{version} \
  530. bin/elasticsearch-keystore \
  531. add my.secure.setting \
  532. my.other.secure.setting
  533. ----
  534. endif::[]
  535. If you've already created the keystore and don't need to update it, you can
  536. bind-mount the `elasticsearch.keystore` file directly. You can use the
  537. `KEYSTORE_PASSWORD` environment variable to provide the keystore password to the
  538. container at startup. For example, a `docker run` command might have the
  539. following options:
  540. [source,sh]
  541. ----
  542. -v full_path_to/config/elasticsearch.keystore:/usr/share/elasticsearch/config/elasticsearch.keystore
  543. -e KEYSTORE_PASSWORD=mypassword
  544. ----
  545. [[_c_customized_image]]
  546. ===== Using custom Docker images
  547. In some environments, it might make more sense to prepare a custom image that contains
  548. your configuration. A `Dockerfile` to achieve this might be as simple as:
  549. [source,sh,subs="attributes"]
  550. --------------------------------------------
  551. FROM docker.elastic.co/elasticsearch/elasticsearch:{version}
  552. COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
  553. --------------------------------------------
  554. You could then build and run the image with:
  555. [source,sh]
  556. --------------------------------------------
  557. docker build --tag=elasticsearch-custom .
  558. docker run -ti -v /usr/share/elasticsearch/data elasticsearch-custom
  559. --------------------------------------------
  560. Some plugins require additional security permissions.
  561. You must explicitly accept them either by:
  562. * Attaching a `tty` when you run the Docker image and allowing the permissions when prompted.
  563. * Inspecting the security permissions and accepting them (if appropriate) by adding the `--batch` flag to the plugin install command.
  564. See {plugins}/_other_command_line_parameters.html[Plugin management]
  565. for more information.
  566. [discrete]
  567. [[troubleshoot-docker-errors]]
  568. ==== Troubleshoot Docker errors for {es}
  569. Here’s how to resolve common errors when running {es} with Docker.
  570. ===== elasticsearch.keystore is a directory
  571. [source,txt]
  572. ----
  573. Exception in thread "main" org.elasticsearch.bootstrap.BootstrapException: java.io.IOException: Is a directory: SimpleFSIndexInput(path="/usr/share/elasticsearch/config/elasticsearch.keystore") Likely root cause: java.io.IOException: Is a directory
  574. ----
  575. A <<docker-keystore-bind-mount,keystore-related>> `docker run` command attempted
  576. to directly bind-mount an `elasticsearch.keystore` file that doesn't exist. If
  577. you use the `-v` or `--volume` flag to mount a file that doesn't exist, Docker
  578. instead creates a directory with the same name.
  579. To resolve this error:
  580. . Delete the `elasticsearch.keystore` directory in the `config` directory.
  581. . Update the `-v` or `--volume` flag to point to the `config` directory path
  582. rather than the keystore file's path. For an example, see
  583. <<docker-keystore-bind-mount>>.
  584. . Retry the command.
  585. ===== elasticsearch.keystore: Device or resource busy
  586. [source,txt]
  587. ----
  588. Exception in thread "main" java.nio.file.FileSystemException: /usr/share/elasticsearch/config/elasticsearch.keystore.tmp -> /usr/share/elasticsearch/config/elasticsearch.keystore: Device or resource busy
  589. ----
  590. A `docker run` command attempted to <<docker-keystore-bind-mount,update the
  591. keystore>> while directly bind-mounting the `elasticsearch.keystore` file. To
  592. update the keystore, the container requires access to other files in the
  593. `config` directory, such as `keystore.tmp`.
  594. To resolve this error:
  595. . Update the `-v` or `--volume` flag to point to the `config` directory
  596. path rather than the keystore file's path. For an example, see
  597. <<docker-keystore-bind-mount>>.
  598. . Retry the command.