docker.asciidoc 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846
  1. [[docker]]
  2. === Install {es} with Docker
  3. {es} is available as a Docker image. A list of all published Docker images and
  4. tags is available at https://www.docker.elastic.co[www.docker.elastic.co]. The
  5. source files are in
  6. https://github.com/elastic/elasticsearch/blob/{branch}/distribution/docker[Github].
  7. include::license.asciidoc[]
  8. Starting in {es} 8.0, security is enabled by default. With security enabled,
  9. {stack} {security-features} require TLS encryption for the transport networking
  10. layer, or your cluster will fail to start.
  11. ==== Install Docker
  12. Visit https://docs.docker.com/get-docker/[Get Docker] to install Docker for your
  13. environment.
  14. IMPORTANT: If using Docker Desktop, make sure to allocate at least 4GB of
  15. memory. You can adjust memory usage in Docker Desktop by going to **Settings >
  16. Resources**.
  17. ==== Pull the Docker image
  18. Use the `docker pull` command to pull the {es} image from the the Elastic Docker
  19. registry.
  20. ifeval::["{release-state}"=="unreleased"]
  21. WARNING: Version {version} of {es} has not yet been released, so no
  22. Docker image is currently available for this version.
  23. endif::[]
  24. [source,sh,subs="attributes"]
  25. ----
  26. docker pull {docker-image}
  27. ----
  28. [[docker-verify-signature]]
  29. ==== Optional: Verify the image signature
  30. Verify the signatures included in your {es} Docker images to ensure they're valid.
  31. Elastic images are signed with https://docs.sigstore.dev/cosign/overview/[Cosign] which is part of the https://www.sigstore.dev/[Sigstore] project.
  32. Cosign supports container signing, verification, and storage in an OCI registry.
  33. ifeval::["{release-state}"=="unreleased"]
  34. WARNING: Version {version} of {es} has not yet been released, so no
  35. Docker image signature is currently available for this version.
  36. endif::[]
  37. Install the appropriate https://docs.sigstore.dev/cosign/installation/[Cosign application]
  38. for your operating system.
  39. The container image signature for {es} v{version} can be verified as follows:
  40. ["source","sh",subs="attributes"]
  41. --------------------------------------------
  42. wget https://artifacts.elastic.co/cosign.pub <1>
  43. cosign verify --key cosign.pub {docker-image} <2>
  44. --------------------------------------------
  45. <1> Download the Elastic public key to verify container signature
  46. <2> Verify the container against the Elastic public key
  47. The command prints the check results and the signature payload in JSON format:
  48. [source,sh,subs="attributes"]
  49. --------------------------------------------
  50. Verification for {docker-image} --
  51. The following checks were performed on each of these signatures:
  52. - The cosign claims were validated
  53. - Existence of the claims in the transparency log was verified offline
  54. - The signatures were verified against the specified public key
  55. --------------------------------------------
  56. [[docker-cli-run-dev-mode]]
  57. ==== Run {es} in Docker
  58. Use Docker commands to start a single-node {es} cluster for development or
  59. testing. You can then run additional Docker commands to add nodes to the test
  60. cluster or run {kib}.
  61. TIP: This setup doesn't run multiple {es} nodes or {kib} by default. To create a
  62. multi-node cluster with {kib}, use Docker Compose instead. See
  63. <<docker-compose-file>>.
  64. ===== Start a single-node cluster
  65. ifeval::["{release-state}"=="unreleased"]
  66. WARNING: Version {version} of the {es} Docker image has not yet been released.
  67. endif::[]
  68. . Create a new docker network.
  69. +
  70. [source,sh]
  71. ----
  72. docker network create elastic
  73. ----
  74. . Start an {es} container.
  75. +
  76. --
  77. ifeval::["{release-state}"=="unreleased"]
  78. WARNING: Version {version} of {es} has not yet been released, so no
  79. Docker image is currently available for this version.
  80. endif::[]
  81. [source,sh,subs="attributes"]
  82. ----
  83. docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB {docker-image}
  84. ----
  85. TIP: Use the `-m` flag to set a memory limit for the container. This removes the
  86. need to <<docker-set-heap-size,manually set the JVM size>>.
  87. The command prints the `elastic` user password and an enrollment token for {kib}.
  88. --
  89. . Copy the generated `elastic` password and enrollment token. These credentials
  90. are only shown when you start {es} for the first time. You can regenerate the
  91. credentials using the following commands.
  92. +
  93. --
  94. [source,sh,subs="attributes"]
  95. ----
  96. docker exec -it es01 /usr/share/elasticsearch/bin/elasticsearch-reset-password
  97. docker exec -it es01 /usr/share/elasticsearch/bin/elasticsearch-create-enrollment-token -s kibana
  98. ----
  99. We recommend storing the `elastic` password as an environment variable in your shell. Example:
  100. [source,sh]
  101. ----
  102. export ELASTIC_PASSWORD="your_password"
  103. ----
  104. --
  105. . Copy the `http_ca.crt` SSL certificate from the container to your local machine.
  106. +
  107. [source,sh]
  108. ----
  109. docker cp es01:/usr/share/elasticsearch/config/certs/http_ca.crt .
  110. ----
  111. . Make a REST API call to {es} to ensure the {es} container is running.
  112. +
  113. [source,sh]
  114. ----
  115. curl --cacert http_ca.crt -u elastic:$ELASTIC_PASSWORD https://localhost:9200
  116. ----
  117. // NOTCONSOLE
  118. ===== Add more nodes
  119. . Use an existing node to generate a enrollment token for the new node.
  120. +
  121. --
  122. [source,sh]
  123. ----
  124. docker exec -it es01 /usr/share/elasticsearch/bin/elasticsearch-create-enrollment-token -s node
  125. ----
  126. The enrollment token is valid for 30 minutes.
  127. --
  128. . Start a new {es} container. Include the enrollment token as an environment variable.
  129. +
  130. --
  131. ifeval::["{release-state}"=="unreleased"]
  132. WARNING: Version {version} of {es} has not yet been released, so no
  133. Docker image is currently available for this version.
  134. endif::[]
  135. [source,sh,subs="attributes"]
  136. ----
  137. docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB {docker-image}
  138. ----
  139. --
  140. . Call the <<cat-nodes,cat nodes API>> to verify the node was added to the cluster.
  141. +
  142. [source,sh]
  143. ----
  144. curl --cacert http_ca.crt -u elastic:$ELASTIC_PASSWORD https://localhost:9200/_cat/nodes
  145. ----
  146. // NOTCONSOLE
  147. [[run-kibana-docker]]
  148. ===== Run {kib}
  149. . Pull the {kib} Docker image.
  150. +
  151. ifeval::["{release-state}"=="unreleased"]
  152. WARNING: Version {version} of {kib} has not yet been released, so no
  153. Docker image is currently available for this version.
  154. endif::[]
  155. +
  156. [source,sh,subs="attributes"]
  157. ----
  158. docker pull {kib-docker-image}
  159. ----
  160. . Optional: Verify the {kib} image's signature.
  161. +
  162. ifeval::["{release-state}"=="unreleased"]
  163. WARNING: Version {version} of {kib} has not yet been released, so no
  164. Docker image signature is currently available for this version.
  165. endif::[]
  166. +
  167. [source,sh,subs="attributes"]
  168. ----
  169. wget https://artifacts.elastic.co/cosign.pub
  170. cosign verify --key cosign.pub {kib-docker-image}
  171. ----
  172. . Start a {kib} container.
  173. +
  174. [source,sh,subs="attributes"]
  175. ----
  176. docker run --name kib01 --net elastic -p 5601:5601 {kib-docker-image}
  177. ----
  178. . When {kib} starts, it outputs a unique generated link to the terminal. To
  179. access {kib}, open this link in a web browser.
  180. . In your browser, enter the enrollment token that was generated when you started {es}.
  181. +
  182. To regenerate the token, run:
  183. +
  184. [source,sh]
  185. ----
  186. docker exec -it es01 /usr/share/elasticsearch/bin/elasticsearch-create-enrollment-token -s kibana
  187. ----
  188. . Log in to {kib} as the `elastic` user with the password that was generated
  189. when you started {es}.
  190. +
  191. To regenerate the password, run:
  192. +
  193. [source,sh]
  194. ----
  195. docker exec -it es01 /usr/share/elasticsearch/bin/elasticsearch-reset-password
  196. ----
  197. [[remove-containers-docker]]
  198. ===== Remove containers
  199. To remove the containers and their network, run:
  200. [source,sh,subs="attributes"]
  201. ----
  202. # Remove the Elastic network
  203. docker network rm elastic
  204. # Remove {es} containers
  205. docker rm es01
  206. docker rm es02
  207. # Remove the {kib} container
  208. docker rm kib01
  209. ----
  210. ===== Next steps
  211. You now have a test {es} environment set up. Before you start
  212. serious development or go into production with {es}, review the
  213. <<docker-prod-prerequisites,requirements and recommendations>> to apply when running {es} in Docker in production.
  214. [[elasticsearch-security-certificates]]
  215. include::security-files-reference.asciidoc[]
  216. [[docker-compose-file]]
  217. ==== Start a multi-node cluster with Docker Compose
  218. To get a multi-node {es} cluster and {kib} up and running in Docker with
  219. security enabled, you can use Docker Compose.
  220. This configuration provides a simple method of starting a secured cluster that
  221. you can use for development before building a distributed deployment with
  222. multiple hosts.
  223. ===== Prerequisites
  224. Install the appropriate https://docs.docker.com/get-docker/[Docker application]
  225. for your operating system.
  226. If you're running on Linux, install https://docs.docker.com/compose/install/[Docker Compose].
  227. [NOTE]
  228. ====
  229. Make sure that Docker is allotted at least 4GB of memory. In Docker Desktop,
  230. you configure resource usage on the Advanced tab in Preferences (macOS) or
  231. Settings (Windows).
  232. ====
  233. ===== Prepare the environment
  234. Create the following configuration files in a new, empty directory. These files
  235. are also available from the
  236. https://github.com/elastic/elasticsearch/tree/master/docs/reference/setup/install/docker[elasticsearch]
  237. repository on GitHub.
  238. --
  239. ifeval::["{release-state}"=="unreleased"]
  240. WARNING: Version {version} of {es} has not been released,
  241. so the following Docker Compose and configuration files won't work.
  242. See the {stack-gs-current}/get-started-docker.html[current version]
  243. for the latest working files.
  244. endif::[]
  245. --
  246. [discrete]
  247. [[docker-env-file]]
  248. ===== `.env`
  249. The `.env` file sets environment variables that are used when you run the
  250. `docker-compose.yml` configuration file. Ensure that you specify a strong
  251. password for the `elastic` and `kibana_system` users with the
  252. `ELASTIC_PASSWORD` and `KIBANA_PASSWORD` variables. These variable are
  253. referenced by the `docker-compose.yml` file.
  254. IMPORTANT: Your passwords must be alphanumeric, and cannot contain special
  255. characters such as `!` or `@`. The `bash` script included in the
  256. `docker-compose.yml` file only operates on alphanumeric characters.
  257. ["source","txt",subs="attributes"]
  258. ----
  259. include::docker/.env[]
  260. ----
  261. [discrete]
  262. [[docker-file]]
  263. ===== `docker-compose.yml`
  264. This `docker-compose.yml` file creates a three-node secure {es} cluster with authentication and network encryption enabled, and a {kib} instance securely connected to it.
  265. .Exposing ports
  266. ****
  267. This configuration exposes port `9200` on all network interfaces. Because
  268. of how Docker handles ports, a port that isn't bound to `localhost` leaves your
  269. {es} cluster publicly accessible, potentially ignoring any firewall settings.
  270. If you don't want to expose port `9200` to external hosts, set the value for
  271. `ES_PORT` in the `.env` file to something like `127.0.0.1:9200`. {es} will
  272. then only be accessible from the host machine itself.
  273. ****
  274. [source,yaml,subs="attributes"]
  275. ----
  276. include::docker/docker-compose.yml[]
  277. ----
  278. ===== Start your cluster with security enabled and configured
  279. . Modify the `.env` file and enter strong password values for both the
  280. `ELASTIC_PASSWORD` and `KIBANA_PASSWORD` variables.
  281. +
  282. NOTE: You must use the `ELASTIC_PASSWORD` value for further interactions with
  283. the cluster. The `KIBANA_PASSWORD` value is only used internally when
  284. configuring {kib}.
  285. . Create and start the three-node {es} cluster and {kib} instance:
  286. +
  287. ["source","sh"]
  288. ----
  289. docker-compose up -d
  290. ----
  291. . When the deployment has started, open a browser and navigate to http://localhost:5601[http://localhost:5601] to
  292. access {kib}, where you can load sample data and interact with your cluster.
  293. ===== Stop and remove the deployment
  294. To stop the cluster, run `docker-compose down`. The data in the Docker volumes
  295. is preserved and loaded when you restart the cluster with `docker-compose up`.
  296. --
  297. ["source","sh"]
  298. ----
  299. docker-compose down
  300. ----
  301. --
  302. To **delete** the network, containers, and volumes when you stop the cluster,
  303. specify the `-v` option:
  304. ["source","sh"]
  305. ----
  306. docker-compose down -v
  307. ----
  308. ===== Next steps
  309. You now have a test {es} environment set up. Before you start
  310. serious development or go into production with {es}, review the
  311. <<docker-prod-prerequisites,requirements and recommendations>> to apply when running {es} in Docker in production.
  312. [[docker-prod-prerequisites]]
  313. ==== Using the Docker images in production
  314. The following requirements and recommendations apply when running {es} in Docker in production.
  315. ===== Set `vm.max_map_count` to at least `262144`
  316. The `vm.max_map_count` kernel setting must be set to at least `262144` for production use.
  317. How you set `vm.max_map_count` depends on your platform.
  318. ====== Linux
  319. To view the current value for the `vm.max_map_count` setting, run:
  320. [source,sh]
  321. --------------------------------------------
  322. grep vm.max_map_count /etc/sysctl.conf
  323. vm.max_map_count=262144
  324. --------------------------------------------
  325. To apply the setting on a live system, run:
  326. [source,sh]
  327. --------------------------------------------
  328. sysctl -w vm.max_map_count=262144
  329. --------------------------------------------
  330. To permanently change the value for the `vm.max_map_count` setting, update the
  331. value in `/etc/sysctl.conf`.
  332. ====== macOS with https://docs.docker.com/docker-for-mac[Docker for Mac]
  333. The `vm.max_map_count` setting must be set within the xhyve virtual machine:
  334. . From the command line, run:
  335. +
  336. [source,sh]
  337. --------------------------------------------
  338. screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
  339. --------------------------------------------
  340. . Press enter and use `sysctl` to configure `vm.max_map_count`:
  341. +
  342. [source,sh]
  343. --------------------------------------------
  344. sysctl -w vm.max_map_count=262144
  345. --------------------------------------------
  346. . To exit the `screen` session, type `Ctrl a d`.
  347. ====== Windows and macOS with https://www.docker.com/products/docker-desktop[Docker Desktop]
  348. The `vm.max_map_count` setting must be set via docker-machine:
  349. [source,sh]
  350. --------------------------------------------
  351. docker-machine ssh
  352. sudo sysctl -w vm.max_map_count=262144
  353. --------------------------------------------
  354. ====== Windows with https://docs.docker.com/docker-for-windows/wsl[Docker Desktop WSL 2 backend]
  355. The `vm.max_map_count` setting must be set in the "docker-desktop" WSL instance before the
  356. {es} container will properly start. There are several ways to do this, depending
  357. on your version of Windows and your version of WSL.
  358. If you are on Windows 10 before version 22H2, or if you are on Windows 10 version 22H2 using the
  359. built-in version of WSL, you must either manually set it every time you restart Docker before starting
  360. your {es} container, or (if you do not wish to do so on every restart) you must globally set
  361. every WSL2 instance to have the `vm.max_map_count` changed. This is because these versions of WSL
  362. do not properly process the /etc/sysctl.conf file.
  363. To manually set it every time you reboot, you must run the following commands in a command prompt
  364. or PowerShell window every time you restart Docker:
  365. [source,sh]
  366. --------------------------------------------
  367. wsl -d docker-desktop -u root
  368. sysctl -w vm.max_map_count=262144
  369. --------------------------------------------
  370. If you are on these versions of WSL and you do not want to have to run those commands every
  371. time you restart Docker, you can globally change every WSL distribution with this setting
  372. by modifying your %USERPROFILE%\.wslconfig as follows:
  373. [source,text]
  374. --------------------------------------------
  375. [wsl2]
  376. kernelCommandLine = "sysctl.vm.max_map_count=262144"
  377. --------------------------------------------
  378. This will cause all WSL2 VMs to have that setting assigned when they start.
  379. If you are on Windows 11, or Windows 10 version 22H2 and have installed the Microsoft Store
  380. version of WSL, you can modify the /etc/sysctl.conf within the "docker-desktop" WSL
  381. distribution, perhaps with commands like this:
  382. [source,sh]
  383. --------------------------------------------
  384. wsl -d docker-desktop -u root
  385. vi /etc/sysctl.conf
  386. --------------------------------------------
  387. and appending a line which reads:
  388. [source,text]
  389. --------------------------------------------
  390. vm.max_map_count = 262144
  391. --------------------------------------------
  392. ===== Configuration files must be readable by the `elasticsearch` user
  393. By default, {es} runs inside the container as user `elasticsearch` using
  394. uid:gid `1000:0`.
  395. IMPORTANT: One exception is https://docs.openshift.com/container-platform/3.6/creating_images/guidelines.html#openshift-specific-guidelines[Openshift],
  396. which runs containers using an arbitrarily assigned user ID.
  397. Openshift presents persistent volumes with the gid set to `0`, which works without any adjustments.
  398. If you are bind-mounting a local directory or file, it must be readable by the `elasticsearch` user.
  399. In addition, this user must have write access to the <<path-settings,config, data and log dirs>>
  400. ({es} needs write access to the `config` directory so that it can generate a keystore).
  401. A good strategy is to grant group access to gid `0` for the local directory.
  402. For example, to prepare a local directory for storing data through a bind-mount:
  403. [source,sh]
  404. --------------------------------------------
  405. mkdir esdatadir
  406. chmod g+rwx esdatadir
  407. chgrp 0 esdatadir
  408. --------------------------------------------
  409. You can also run an {es} container using both a custom UID and GID. You
  410. must ensure that file permissions will not prevent {es} from executing. You
  411. can use one of two options:
  412. * Bind-mount the `config`, `data` and `logs`
  413. directories. If you intend to install plugins and prefer not to
  414. <<_c_customized_image, create a custom Docker image>>, you must also
  415. bind-mount the `plugins` directory.
  416. * Pass the `--group-add 0` command line option to `docker run`. This
  417. ensures that the user under which {es} is running is also a member of the
  418. `root` (GID 0) group inside the container.
  419. ===== Increase ulimits for nofile and nproc
  420. Increased ulimits for <<setting-system-settings,nofile>> and <<max-number-threads-check,nproc>>
  421. must be available for the {es} containers.
  422. Verify the https://github.com/moby/moby/tree/ea4d1243953e6b652082305a9c3cda8656edab26/contrib/init[init system]
  423. for the Docker daemon sets them to acceptable values.
  424. To check the Docker daemon defaults for ulimits, run:
  425. [source,sh,subs="attributes"]
  426. --------------------------------------------
  427. docker run --rm {docker-image} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
  428. --------------------------------------------
  429. If needed, adjust them in the Daemon or override them per container.
  430. For example, when using `docker run`, set:
  431. [source,sh]
  432. --------------------------------------------
  433. --ulimit nofile=65535:65535
  434. --------------------------------------------
  435. ===== Disable swapping
  436. Swapping needs to be disabled for performance and node stability.
  437. For information about ways to do this, see <<setup-configuration-memory>>.
  438. If you opt for the `bootstrap.memory_lock: true` approach,
  439. you also need to define the `memlock: true` ulimit in the
  440. https://docs.docker.com/engine/reference/commandline/dockerd/#default-ulimits[Docker Daemon],
  441. or explicitly set for the container as shown in the <<docker-compose-file, sample compose file>>.
  442. When using `docker run`, you can specify:
  443. [source,sh]
  444. ----
  445. -e "bootstrap.memory_lock=true" --ulimit memlock=-1:-1
  446. ----
  447. ===== Randomize published ports
  448. The image https://docs.docker.com/engine/reference/builder/#/expose[exposes]
  449. TCP ports 9200 and 9300. For production clusters, randomizing the
  450. published ports with `--publish-all` is recommended,
  451. unless you are pinning one container per host.
  452. [[docker-set-heap-size]]
  453. ===== Manually set the heap size
  454. By default, {es} automatically sizes JVM heap based on a nodes's
  455. <<node-roles,roles>> and the total memory available to the node's container. We
  456. recommend this default sizing for most production environments. If needed, you
  457. can override default sizing by manually setting JVM heap size.
  458. To manually set the heap size in production, bind mount a <<set-jvm-options,JVM
  459. options>> file under `/usr/share/elasticsearch/config/jvm.options.d` that
  460. includes your desired <<set-jvm-heap-size,heap size>> settings.
  461. For testing, you can also manually set the heap size using the `ES_JAVA_OPTS`
  462. environment variable. For example, to use 1GB, use the following command.
  463. [source,sh,subs="attributes"]
  464. ----
  465. docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="<token>" --name es01 -p 9200:9200 --net elastic -it {docker-image}
  466. ----
  467. The `ES_JAVA_OPTS` variable overrides all other JVM options.
  468. We do not recommend using `ES_JAVA_OPTS` in production.
  469. ===== Pin deployments to a specific image version
  470. Pin your deployments to a specific version of the {es} Docker image. For
  471. example +{docker-image}+.
  472. ===== Always bind data volumes
  473. You should use a volume bound on `/usr/share/elasticsearch/data` for the following reasons:
  474. . The data of your {es} node won't be lost if the container is killed
  475. . {es} is I/O sensitive and the Docker storage driver is not ideal for fast I/O
  476. . It allows the use of advanced
  477. https://docs.docker.com/engine/extend/plugins/#volume-plugins[Docker volume plugins]
  478. ===== Avoid using `loop-lvm` mode
  479. If you are using the devicemapper storage driver, do not use the default `loop-lvm` mode.
  480. Configure docker-engine to use
  481. https://docs.docker.com/engine/userguide/storagedriver/device-mapper-driver/#configure-docker-with-devicemapper[direct-lvm].
  482. ===== Centralize your logs
  483. Consider centralizing your logs by using a different
  484. https://docs.docker.com/engine/admin/logging/overview/[logging driver]. Also
  485. note that the default json-file logging driver is not ideally suited for
  486. production use.
  487. [[docker-configuration-methods]]
  488. ==== Configuring {es} with Docker
  489. When you run in Docker, the <<config-files-location,{es} configuration files>> are loaded from
  490. `/usr/share/elasticsearch/config/`.
  491. To use custom configuration files, you <<docker-config-bind-mount, bind-mount the files>>
  492. over the configuration files in the image.
  493. You can set individual {es} configuration parameters using Docker environment variables.
  494. The <<docker-compose-file, sample compose file>> and the
  495. <<docker-cli-run-dev-mode, single-node example>> use this method. You can
  496. use the setting name directly as the environment variable name. If
  497. you cannot do this, for example because your orchestration platform forbids
  498. periods in environment variable names, then you can use an alternative
  499. style by converting the setting name as follows.
  500. . Change the setting name to uppercase
  501. . Prefix it with `ES_SETTING_`
  502. . Escape any underscores (`_`) by duplicating them
  503. . Convert all periods (`.`) to underscores (`_`)
  504. For example, `-e bootstrap.memory_lock=true` becomes
  505. `-e ES_SETTING_BOOTSTRAP_MEMORY__LOCK=true`.
  506. You can use the contents of a file to set the value of the
  507. `ELASTIC_PASSWORD` or `KEYSTORE_PASSWORD` environment variables, by
  508. suffixing the environment variable name with `_FILE`. This is useful for
  509. passing secrets such as passwords to {es} without specifying them directly.
  510. For example, to set the {es} bootstrap password from a file, you can bind mount the
  511. file and set the `ELASTIC_PASSWORD_FILE` environment variable to the mount location.
  512. If you mount the password file to `/run/secrets/bootstrapPassword.txt`, specify:
  513. [source,sh]
  514. --------------------------------------------
  515. -e ELASTIC_PASSWORD_FILE=/run/secrets/bootstrapPassword.txt
  516. --------------------------------------------
  517. You can override the default command for the image to pass {es} configuration
  518. parameters as command line options. For example:
  519. [source,sh]
  520. --------------------------------------------
  521. docker run <various parameters> bin/elasticsearch -Ecluster.name=mynewclustername
  522. --------------------------------------------
  523. While bind-mounting your configuration files is usually the preferred method in production,
  524. you can also <<_c_customized_image, create a custom Docker image>>
  525. that contains your configuration.
  526. [[docker-config-bind-mount]]
  527. ===== Mounting {es} configuration files
  528. Create custom config files and bind-mount them over the corresponding files in the Docker image.
  529. For example, to bind-mount `custom_elasticsearch.yml` with `docker run`, specify:
  530. [source,sh]
  531. --------------------------------------------
  532. -v full_path_to/custom_elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml
  533. --------------------------------------------
  534. If you bind-mount a custom `elasticsearch.yml` file, ensure it includes the
  535. `network.host: 0.0.0.0` setting. This setting ensures the node is reachable for
  536. HTTP and transport traffic, provided its ports are exposed. The Docker image's
  537. built-in `elasticsearch.yml` file includes this setting by default.
  538. IMPORTANT: The container **runs {es} as user `elasticsearch` using
  539. uid:gid `1000:0`**. Bind mounted host directories and files must be accessible by this user,
  540. and the data and log directories must be writable by this user.
  541. [[docker-keystore-bind-mount]]
  542. ===== Create an encrypted {es} keystore
  543. By default, {es} will auto-generate a keystore file for <<secure-settings,secure
  544. settings>>. This file is obfuscated but not encrypted.
  545. To encrypt your secure settings with a password and have them persist outside
  546. the container, use a `docker run` command to manually create the keystore
  547. instead. The command must:
  548. * Bind-mount the `config` directory. The command will create an
  549. `elasticsearch.keystore` file in this directory. To avoid errors, do
  550. not directly bind-mount the `elasticsearch.keystore` file.
  551. * Use the `elasticsearch-keystore` tool with the `create -p` option. You'll be
  552. prompted to enter a password for the keystore.
  553. For example:
  554. [source,sh,subs="attributes"]
  555. ----
  556. docker run -it --rm \
  557. -v full_path_to/config:/usr/share/elasticsearch/config \
  558. {docker-image} \
  559. bin/elasticsearch-keystore create -p
  560. ----
  561. You can also use a `docker run` command to add or update secure settings in the
  562. keystore. You'll be prompted to enter the setting values. If the keystore is
  563. encrypted, you'll also be prompted to enter the keystore password.
  564. [source,sh,subs="attributes"]
  565. ----
  566. docker run -it --rm \
  567. -v full_path_to/config:/usr/share/elasticsearch/config \
  568. {docker-image} \
  569. bin/elasticsearch-keystore \
  570. add my.secure.setting \
  571. my.other.secure.setting
  572. ----
  573. If you've already created the keystore and don't need to update it, you can
  574. bind-mount the `elasticsearch.keystore` file directly. You can use the
  575. `KEYSTORE_PASSWORD` environment variable to provide the keystore password to the
  576. container at startup. For example, a `docker run` command might have the
  577. following options:
  578. [source,sh]
  579. ----
  580. -v full_path_to/config/elasticsearch.keystore:/usr/share/elasticsearch/config/elasticsearch.keystore
  581. -e KEYSTORE_PASSWORD=mypassword
  582. ----
  583. [[_c_customized_image]]
  584. ===== Using custom Docker images
  585. In some environments, it might make more sense to prepare a custom image that contains
  586. your configuration. A `Dockerfile` to achieve this might be as simple as:
  587. [source,sh,subs="attributes"]
  588. --------------------------------------------
  589. FROM {docker-image}
  590. COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
  591. --------------------------------------------
  592. You could then build and run the image with:
  593. [source,sh]
  594. --------------------------------------------
  595. docker build --tag=elasticsearch-custom .
  596. docker run -ti -v /usr/share/elasticsearch/data elasticsearch-custom
  597. --------------------------------------------
  598. Some plugins require additional security permissions.
  599. You must explicitly accept them either by:
  600. * Attaching a `tty` when you run the Docker image and allowing the permissions when prompted.
  601. * Inspecting the security permissions and accepting them (if appropriate) by adding the `--batch` flag to the plugin install command.
  602. See {plugins}/_other_command_line_parameters.html[Plugin management]
  603. for more information.
  604. [discrete]
  605. [[troubleshoot-docker-errors]]
  606. ==== Troubleshoot Docker errors for {es}
  607. Here’s how to resolve common errors when running {es} with Docker.
  608. ===== elasticsearch.keystore is a directory
  609. [source,txt]
  610. ----
  611. 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
  612. ----
  613. A <<docker-keystore-bind-mount,keystore-related>> `docker run` command attempted
  614. to directly bind-mount an `elasticsearch.keystore` file that doesn't exist. If
  615. you use the `-v` or `--volume` flag to mount a file that doesn't exist, Docker
  616. instead creates a directory with the same name.
  617. To resolve this error:
  618. . Delete the `elasticsearch.keystore` directory in the `config` directory.
  619. . Update the `-v` or `--volume` flag to point to the `config` directory path
  620. rather than the keystore file's path. For an example, see
  621. <<docker-keystore-bind-mount>>.
  622. . Retry the command.
  623. ===== elasticsearch.keystore: Device or resource busy
  624. [source,txt]
  625. ----
  626. 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
  627. ----
  628. A `docker run` command attempted to <<docker-keystore-bind-mount,update the
  629. keystore>> while directly bind-mounting the `elasticsearch.keystore` file. To
  630. update the keystore, the container requires access to other files in the
  631. `config` directory, such as `keystore.tmp`.
  632. To resolve this error:
  633. . Update the `-v` or `--volume` flag to point to the `config` directory
  634. path rather than the keystore file's path. For an example, see
  635. <<docker-keystore-bind-mount>>.
  636. . Retry the command.