From bfbf9a85ff89f0a5aaff6279e80601cf317c6300 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 5 Aug 2025 15:31:00 +0100 Subject: [PATCH 1/9] Adds a tip that explains how to install other 9.x versions In case someone needs to install an older version of the Elasticsearch 9.x series, I'm adding a tip admonition to explain that they can replace the versions in the code examples with the version that they want. I'm using variables so that this guidance isn't hardcoded and doesn't require version bumps in the future. Fixes #2234 --- ...nstall-elasticsearch-from-archive-on-linux-macos.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index 42992bb614..1a599231c3 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -56,7 +56,9 @@ cd elasticsearch-{{version.stack}}/ <2> 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. - +:::{tip} +You can install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +::: ### MacOS [install-macos] @@ -77,7 +79,7 @@ cd elasticsearch-{{version.stack}}/ <2> Apple’s rollout of stricter notarization requirements affected the notarization of the {{version.stack}} {{es}} artifacts. If macOS displays a dialog when you first run {{es}} that interrupts it, then you need to take an action to allow it to run. -To prevent Gatekeeper checks on the {{es}} files, run the following command on the downloaded .tar.gz archive or the directory to which was extracted: +To prevent Gatekeeper checks on the {{es}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which it was extracted: ```sh xattr -d -r com.apple.quarantine @@ -86,6 +88,10 @@ xattr -d -r com.apple.quarantine Alternatively, you can add a security override by following the instructions in the *If you want to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491). :::: +:::{tip} +You can install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +::: + ## Step 2: Enable automatic creation of system indices [targz-enable-indices] :::{include} _snippets/enable-auto-indices.md From 043e3aafc4dfb724e0c992f43524b32376270030 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 5 Aug 2025 15:54:31 +0100 Subject: [PATCH 2/9] Add the note to other stack installation-related topics --- .../install-elasticsearch-from-archive-on-linux-macos.md | 4 ++-- .../self-managed/install-elasticsearch-with-debian-package.md | 4 ++++ .../deploy/self-managed/install-elasticsearch-with-rpm.md | 4 ++++ .../self-managed/install-elasticsearch-with-zip-on-windows.md | 4 ++++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index 1a599231c3..7c683b15ff 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -57,7 +57,7 @@ cd elasticsearch-{{version.stack}}/ <2> 2. This directory is known as `$ES_HOME`. :::{tip} -You can install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. ::: ### MacOS [install-macos] @@ -89,7 +89,7 @@ Alternatively, you can add a security override by following the instructions in :::: :::{tip} -You can install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. ::: ## Step 2: Enable automatic creation of system indices [targz-enable-indices] diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md index 413ad087fb..1056147fce 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md @@ -110,6 +110,10 @@ sudo dpkg -i elasticsearch-{{version.stack}}-amd64.deb 1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. +:::{tip} +You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +::: + ## Step 3: Set up the node for connectivity :::{include} _snippets/node-connectivity.md diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md index ad0c9d0c21..c0a9883e72 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md @@ -97,6 +97,10 @@ sudo zypper modifyrepo --enable elasticsearch && \ :::{include} _snippets/skip-set-kernel-params.md ::: + :::{tip} + You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. + ::: + 2. Copy the terminal output from the install command to a local file. In particular, you’ll need the password for the built-in `elastic` superuser account. The output also contains the commands to enable {{es}} to [run as a service](#running-systemd). ## Step 3: Set up the node for connectivity diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md index afd05b9e22..04ccd463c0 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md @@ -50,6 +50,10 @@ Unzip it with your favorite unzip tool. This will create a folder called `elasti cd C:\Program Files\elasticsearch-{{version.stack}} ``` +:::{tip} +You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +::: + ## Step 2: Enable automatic creation of system indices [windows-enable-indices] :::{include} _snippets/enable-auto-indices.md From 952593ddbe8d32460c3295234c84aaab0561e5cb Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 5 Aug 2025 17:26:53 +0100 Subject: [PATCH 3/9] Trialing a tabs approach for older versions --- .../_snippets/tip-install-other-9-versions.md | 3 + .../deploy/self-managed/_snippets/wolfi.md | 15 +++- .../install-elasticsearch-docker-basic.md | 73 ++++++++++++++++++- ...asticsearch-from-archive-on-linux-macos.md | 6 +- ...stall-elasticsearch-with-debian-package.md | 3 +- .../install-elasticsearch-with-rpm.md | 3 +- ...stall-elasticsearch-with-zip-on-windows.md | 3 +- 7 files changed, 94 insertions(+), 12 deletions(-) create mode 100644 deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md diff --git a/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md b/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md new file mode 100644 index 0000000000..90a4360333 --- /dev/null +++ b/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md @@ -0,0 +1,3 @@ +:::{tip} +You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +::: \ No newline at end of file diff --git a/deploy-manage/deploy/self-managed/_snippets/wolfi.md b/deploy-manage/deploy/self-managed/_snippets/wolfi.md index fd7c45fd8d..4892a876de 100644 --- a/deploy-manage/deploy/self-managed/_snippets/wolfi.md +++ b/deploy-manage/deploy/self-managed/_snippets/wolfi.md @@ -4,6 +4,19 @@ To use the Wolfi image, append `-wolfi` to the image tag in the Docker command. For example: +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{version.stack}} -``` \ No newline at end of file +``` +::: + +:::{tab-item} Specific version +```sh subs=true +docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi: +``` +You can download and install a specific version of {{es}} {{version.stack.base | M }} by replacing `` with the version number you want. For example, you can replace `` with {{version.stack.base}}. +::: + +:::: \ No newline at end of file diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md index 089ca3afe2..1ec82cb4d6 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md @@ -34,12 +34,26 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 3. Pull the {{es}} Docker image. + ::::{tab-set} + + :::{tab-item} Latest ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker pull docker.elastic.co/elasticsearch/elasticsearch: + ``` + ::: 4. Optional: Install [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/) for your environment. Then use Cosign to verify the {{es}} image’s signature. + ::::{tab-set} + + :::{tab-item} Latest $$$docker-verify-signature$$$ ```sh subs=true @@ -56,9 +70,35 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes - Existence of the claims in the transparency log was verified offline - The signatures were verified against the specified public key ``` + ::: + + :::{tab-item} Specific version + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + $$$docker-verify-signature$$$ + + ```sh subs=true + wget https://artifacts.elastic.co/cosign.pub + cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: + ``` + + The `cosign` command prints the check results and the signature payload in JSON format: + + ```sh subs=true + Verification for docker.elastic.co/elasticsearch/elasticsearch: -- + The following checks were performed on each of these signatures: + - The cosign claims were validated + - Existence of the claims in the transparency log was verified offline + - The signatures were verified against the specified public key + ``` + ::: + :::: + 5. Start an {{es}} container. + ::::::{tab-set} + + :::::{tab-item} Latest ```sh subs=true docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` @@ -67,7 +107,6 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes Use the `-m` flag to set a memory limit for the container. This removes the need to [manually set the JVM size](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md#docker-set-heap-size). :::: - {{ml-cap}} features such as [semantic search with ELSER](/solutions/search/semantic-search/semantic-search-elser-ingest-pipelines.md) require a larger container with more than 1GB of memory. If you intend to use the {{ml}} capabilities, then start the container with this command: ```sh subs=true @@ -75,6 +114,27 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ``` The command prints the `elastic` user password and an enrollment token for {{kib}}. + ::::: + + :::::{tab-item} Specific version + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + ``` + + ::::{tip} + Use the `-m` flag to set a memory limit for the container. This removes the need to [manually set the JVM size](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md#docker-set-heap-size). + :::: + + {{ml-cap}} features such as [semantic search with ELSER](/solutions/search/semantic-search/semantic-search-elser-ingest-pipelines.md) require a larger container with more than 1GB of memory. If you intend to use the {{ml}} capabilities, then start the container with this command: + + ```sh subs=true + docker run --name es01 --net elastic -p 9200:9200 -it -m 6GB -e "xpack.ml.use_auto_machine_memory_percent=true" docker.elastic.co/elasticsearch/elasticsearch: + ``` + + The command prints the `elastic` user password and an enrollment token for {{kib}}. + ::::: + :::::: 6. Copy the generated `elastic` password and enrollment token. These credentials are only shown when you start {{es}} for the first time. You can regenerate the credentials using the following commands. @@ -113,9 +173,20 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 2. Start a new {{es}} container. Include the enrollment token as an environment variable. + ::::{tab-set} + + :::{tab-item} Latest ```sh subs=true docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` + ::: + :::{tab-item} Specific version + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + ``` + ::: + :::: 3. Call the [cat nodes API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes) to verify the node was added to the cluster. diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index 7c683b15ff..208cb322f9 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -56,8 +56,7 @@ cd elasticsearch-{{version.stack}}/ <2> 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. -:::{tip} -You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +:::{include} _snippets/tip-install-other-9-versions.md ::: ### MacOS [install-macos] @@ -88,8 +87,7 @@ xattr -d -r com.apple.quarantine Alternatively, you can add a security override by following the instructions in the *If you want to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491). :::: -:::{tip} -You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +:::{include} _snippets/tip-install-other-9-versions.md ::: ## Step 2: Enable automatic creation of system indices [targz-enable-indices] diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md index 1056147fce..0884b1373d 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md @@ -110,8 +110,7 @@ sudo dpkg -i elasticsearch-{{version.stack}}-amd64.deb 1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. -:::{tip} -You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +:::{include} _snippets/tip-install-other-9-versions.md ::: ## Step 3: Set up the node for connectivity diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md index c0a9883e72..746ec469e5 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md @@ -97,8 +97,7 @@ sudo zypper modifyrepo --enable elasticsearch && \ :::{include} _snippets/skip-set-kernel-params.md ::: - :::{tip} - You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. + :::{include} _snippets/tip-install-other-9-versions.md ::: 2. Copy the terminal output from the install command to a local file. In particular, you’ll need the password for the built-in `elastic` superuser account. The output also contains the commands to enable {{es}} to [run as a service](#running-systemd). diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md index 04ccd463c0..e00d3d7e76 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md @@ -50,8 +50,7 @@ Unzip it with your favorite unzip tool. This will create a folder called `elasti cd C:\Program Files\elasticsearch-{{version.stack}} ``` -:::{tip} -You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. +:::{include} _snippets/tip-install-other-9-versions.md ::: ## Step 2: Enable automatic creation of system indices [windows-enable-indices] From ed96a16dc44dbac23478efead0f27f3e5baecf23 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Tue, 5 Aug 2025 18:12:03 +0100 Subject: [PATCH 4/9] Added tabs to assess this approach --- .../install-elasticsearch-docker-basic.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md index 1ec82cb4d6..b9f32426f5 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md @@ -198,22 +198,57 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 1. Pull the {{kib}} Docker image. + ::::{tab-set} + + :::{tab-item} Latest ```sh subs=true docker pull docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + :::{tab-item} Specific version + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker pull docker.elastic.co/kibana/kibana: + ``` + ::: + :::: 2. Optional: Verify the {{kib}} image’s signature. + ::::{tab-set} + + :::{tab-item} Latest ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + :::{tab-item} Specific version + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + wget https://artifacts.elastic.co/cosign.pub + cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: + ``` + ::: + :::: + 3. Start a {{kib}} container. + ::::{tab-set} + + :::{tab-item} Latest ```sh subs=true docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + :::{tab-item} Specific version + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: + ``` + ::: + :::: 4. When {{kib}} starts, it outputs a unique generated link to the terminal. To access {{kib}}, open this link in a web browser. 5. In your browser, enter the enrollment token that was generated when you started {{es}}. From d6ea951554e00d075d50c03b3c588510e92c988c Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 6 Aug 2025 17:33:05 +0100 Subject: [PATCH 5/9] Updating topics to include tabs instead of the tip --- .../_snippets/tip-install-other-9-versions.md | 3 -- ...asticsearch-from-archive-on-linux-macos.md | 47 ++++++++++++++---- ...stall-elasticsearch-with-debian-package.md | 19 ++++++-- .../install-elasticsearch-with-rpm.md | 48 ++++++++++++++----- ...stall-elasticsearch-with-zip-on-windows.md | 18 ++++++- 5 files changed, 106 insertions(+), 29 deletions(-) delete mode 100644 deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md diff --git a/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md b/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md deleted file mode 100644 index 90a4360333..0000000000 --- a/deploy-manage/deploy/self-managed/_snippets/tip-install-other-9-versions.md +++ /dev/null @@ -1,3 +0,0 @@ -:::{tip} -You can download and install another version of {{es}} {{version.stack.base | M }} by replacing {{version.stack}} with the version number you want. For example, you can replace {{version.stack}} with {{version.stack.base}}. -::: \ No newline at end of file diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index 208cb322f9..200c67964a 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -43,8 +43,12 @@ Download and install the archive for Linux or MacOS. ### Linux [install-linux] -The Linux archive for {{es}} {{version.stack}} can be downloaded and installed as follows: +The Linux archive for {{es}} can be downloaded and installed as follows: +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{es}} {{version.stack}} archive, enter: ```sh subs=true wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-linux-x86_64.tar.gz wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-linux-x86_64.tar.gz.sha512 @@ -52,26 +56,56 @@ shasum -a 512 -c elasticsearch-{{version.stack}}-linux-x86_64.tar.gz.sha512 <1> tar -xzf elasticsearch-{{version.stack}}-linux-x86_64.tar.gz cd elasticsearch-{{version.stack}}/ <2> ``` - 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. +::: -:::{include} _snippets/tip-install-other-9-versions.md +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz.sha512 +shasum -a 512 -c elasticsearch--linux-x86_64.tar.gz.sha512 <1> +tar -xzf elasticsearch--linux-x86_64.tar.gz +cd elasticsearch-/ <2> +``` +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. +2. This directory is known as `$ES_HOME`. ::: +:::: + ### MacOS [install-macos] -The MacOS archive for {{es}} {{version.stack}} can be downloaded and installed as follows: +The MacOS archive for {{es}} can be downloaded and installed as follows: +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{es}} {{version.stack}} archive, enter: ```sh subs=true curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> tar -xzf elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz cd elasticsearch-{{version.stack}}/ <2> ``` - 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--darwin-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf elasticsearch--darwin-x86_64.tar.gz +cd elasticsearch-/ <2> +``` +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--darwin-x86_64.tar.gz: OK`. +2. This directory is known as `$ES_HOME`. +::: +::: +:::: ::::{admonition} macOS Gatekeeper warnings :class: important @@ -87,9 +121,6 @@ xattr -d -r com.apple.quarantine Alternatively, you can add a security override by following the instructions in the *If you want to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491). :::: -:::{include} _snippets/tip-install-other-9-versions.md -::: - ## Step 2: Enable automatic creation of system indices [targz-enable-indices] :::{include} _snippets/enable-auto-indices.md diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md index 0884b1373d..5f119c671e 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md @@ -99,19 +99,32 @@ Examine `/etc/apt/sources.list.d/elasticsearch-9.x.list` for the duplicate entry ### Download and install the Debian package manually [install-deb] -The Debian package for {{es}} {{version.stack}} can be downloaded from the website and installed as follows: +The Debian package for {{es}} can be downloaded from the website and installed as follows: +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{es}} {{version.stack}} package, enter: ```sh subs=true wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-amd64.deb wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-amd64.deb.sha512 shasum -a 512 -c elasticsearch-{{version.stack}}-amd64.deb.sha512 <1> sudo dpkg -i elasticsearch-{{version.stack}}-amd64.deb ``` - 1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. +::: -:::{include} _snippets/tip-install-other-9-versions.md +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb.sha512 +shasum -a 512 -c elasticsearch--amd64.deb.sha512 <1> +sudo dpkg -i elasticsearch--amd64.deb +``` +1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. ::: +:::: ## Step 3: Set up the node for connectivity diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md index 746ec469e5..16c64e9881 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md @@ -83,22 +83,44 @@ sudo zypper modifyrepo --enable elasticsearch && \ ### Download and install the RPM manually [install-rpm] -1. Download and install the RPM for {{es}} {{version.stack}} with the following commands: +1. Download and install the RPM for {{es}} with the following commands: + +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{es}} {{version.stack}} RPM, enter: + ```sh subs=true + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-x86_64.rpm + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-x86_64.rpm.sha512 + shasum -a 512 -c elasticsearch-{{version.stack}}-x86_64.rpm.sha512 <1> + sudo rpm --install elasticsearch-{{version.stack}}-x86_64.rpm + ``` + 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `elasticsearch--x86_64.rpm: OK`. + + :::{include} _snippets/skip-set-kernel-params.md + ::: + +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm.sha512 + shasum -a 512 -c elasticsearch--x86_64.rpm.sha512 <1> + sudo rpm --install elasticsearch--x86_64.rpm + ``` + 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `elasticsearch--x86_64.rpm: OK`. + + :::{include} _snippets/skip-set-kernel-params.md + ::: - ```sh subs=true - wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-x86_64.rpm - wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-x86_64.rpm.sha512 - shasum -a 512 -c elasticsearch-{{version.stack}}-x86_64.rpm.sha512 <1> - sudo rpm --install elasticsearch-{{version.stack}}-x86_64.rpm - ``` - - 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `elasticsearch--x86_64.rpm: OK`. +::: +:::: + - :::{include} _snippets/skip-set-kernel-params.md - ::: + - :::{include} _snippets/tip-install-other-9-versions.md - ::: 2. Copy the terminal output from the install command to a local file. In particular, you’ll need the password for the built-in `elastic` superuser account. The output also contains the commands to enable {{es}} to [run as a service](#running-systemd). diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md index e00d3d7e76..a892e5fb87 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md @@ -41,17 +41,31 @@ On Windows, the {{es}} {{ml}} feature requires the Microsoft Universal C Runtime ## Step 1: Download and install the `.zip` package [install-windows] +::::{tab-set} + +:::{tab-item} Latest % link url manually set Download the `.zip` archive for {{es}} {{version.stack}} from: [https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-windows-x86_64.zip](https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-windows-x86_64.zip) -Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for instance: +Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-{{version.stack}}`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for example: ```sh subs=true cd C:\Program Files\elasticsearch-{{version.stack}} ``` +::: + +:::{tab-item} Specific version +Download the `.zip` archive for the {{es}} version that you want from the [Past Releases](https://www.elastic.co/downloads/past-releases) page. + +Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for example: -:::{include} _snippets/tip-install-other-9-versions.md +```sh subs=true +cd C:\Program Files\elasticsearch- +``` +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ::: +:::: + ## Step 2: Enable automatic creation of system indices [windows-enable-indices] From 0fa0734ffcf7a95f3568f254db5e98dfdc011e34 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Wed, 6 Aug 2025 18:14:53 +0100 Subject: [PATCH 6/9] Add tabs to remaining Elasticsearch install content --- .../deploy/self-managed/air-gapped-install.md | 161 +++++++++++++++++- .../install-elasticsearch-docker-compose.md | 17 +- .../install-elasticsearch-docker-configure.md | 45 +++++ .../install-elasticsearch-docker-prod.md | 36 ++++ 4 files changed, 255 insertions(+), 4 deletions(-) diff --git a/deploy-manage/deploy/self-managed/air-gapped-install.md b/deploy-manage/deploy/self-managed/air-gapped-install.md index 08a90fbe95..55fea4cf74 100644 --- a/deploy-manage/deploy/self-managed/air-gapped-install.md +++ b/deploy-manage/deploy/self-managed/air-gapped-install.md @@ -87,10 +87,13 @@ Besides setting up the EPR service, you also need to [configure {{kib}}](/deploy ### Additional {{package-registry}} examples -:::{dropdown} Script to generate a SystemD service file on a RHEL 8 system +:::::{dropdown} Script to generate a SystemD service file on a RHEL 8 system The following script generates a SystemD service file on a RHEL 8 system in order to run EPR with Podman in a production environment. +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true #!/usr/bin/env bash @@ -115,10 +118,42 @@ podman create \ ``` ::: -:::{dropdown} SystemD service file launched as a Podman service +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +#!/usr/bin/env bash + +EPR_BIND_ADDRESS="0.0.0.0" +EPR_BIND_PORT="8443" +EPR_TLS_CERT="/etc/elastic/epr/epr.pem" +EPR_TLS_KEY="/etc/elastic/epr/epr-key.pem" +EPR_IMAGE="docker.elastic.co/package-registry/distribution:" + +podman create \ + --name "elastic-epr" \ + -p "$EPR_BIND_ADDRESS:$EPR_BIND_PORT:$EPR_BIND_PORT" \ + -v "$EPR_TLS_CERT:/etc/ssl/epr.crt:ro" \ + -v "$EPR_TLS_KEY:/etc/ssl/epr.key:ro" \ + -e "EPR_ADDRESS=0.0.0.0:$EPR_BIND_PORT" \ + -e "EPR_TLS_CERT=/etc/ssl/epr.crt" \ + -e "EPR_TLS_KEY=/etc/ssl/epr.key" \ + "$EPR_IMAGE" + +## creates service file in the root directory +# podman generate systemd --new --files --name elastic-epr --restart-policy always +``` +::: +:::: + +::::: + +:::::{dropdown} SystemD service file launched as a Podman service The following is an example of an actual SystemD service file for an EPR, launched as a Podman service. +::::{tab-set} + +:::{tab-item} Latest ```ini subs=true # container-elastic-epr.service # autogenerated by Podman 4.1.1 @@ -160,6 +195,52 @@ WantedBy=default.target ``` ::: +::::::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```ini subs=true +# container-elastic-epr.service +# autogenerated by Podman 4.1.1 +# Wed Oct 19 13:12:33 UTC 2022 + +[Unit] +Description=Podman container-elastic-epr.service +Documentation=man:podman-generate-systemd(1) +Wants=network-online.target +After=network-online.target +RequiresMountsFor=%t/containers + +[Service] +Environment=PODMAN_SYSTEMD_UNIT=%n +Restart=always +TimeoutStopSec=70 +ExecStartPre=/bin/rm -f %t/%n.ctr-id +ExecStart=/usr/bin/podman run \ + --cidfile=%t/%n.ctr-id \ + --cgroups=no-conmon \ + --rm \ + --sdnotify=conmon \ + -d \ + --replace \ + --name elastic-epr \ + -p 0.0.0.0:8443:8443 \ + -v /etc/elastic/epr/epr.pem:/etc/ssl/epr.crt:ro \ + -v /etc/elastic/epr/epr-key.pem:/etc/ssl/epr.key:ro \ + -e EPR_ADDRESS=0.0.0.0:8443 \ + -e EPR_TLS_CERT=/etc/ssl/epr.crt \ + -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution: +ExecStop=/usr/bin/podman stop --ignore --cidfile=%t/%n.ctr-id +ExecStopPost=/usr/bin/podman rm -f --ignore --cidfile=%t/%n.ctr-id +Type=notify +NotifyAccess=all + +[Install] +WantedBy=default.target +``` +::: +:::: + +::::: + ## {{artifact-registry}} [air-gapped-elastic-artifact-registry] Air-gapped install of the {{artifact-registry}} is necessary in order to enable {{agent}} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/reference/fleet/air-gapped.md#host-artifact-registry) in the {{fleet}} and {{elastic-agent}} Guide. @@ -170,10 +251,13 @@ When setting up own web server, such as NGINX, to function as the {{artifact-reg ### Additional {{artifact-registry}} examples -:::{dropdown} Artifact download script +:::::{dropdown} Artifact download script The following example script downloads artifacts from the internet to be later served as a private Elastic Package Registry. +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true #!/usr/bin/env bash set -o nounset -o errexit -o pipefail @@ -241,6 +325,77 @@ done ``` ::: +::::::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +#!/usr/bin/env bash +set -o nounset -o errexit -o pipefail + +STACK_VERSION= +ARTIFACT_DOWNLOADS_BASE_URL=https://artifacts.elastic.co/downloads + +DOWNLOAD_BASE_DIR=${DOWNLOAD_BASE_DIR:?"Make sure to set DOWNLOAD_BASE_DIR when running this script"} + +COMMON_PACKAGE_PREFIXES="apm-server/apm-server beats/auditbeat/auditbeat beats/elastic-agent/elastic-agent beats/filebeat/filebeat beats/heartbeat/heartbeat beats/metricbeat/metricbeat beats/osquerybeat/osquerybeat beats/packetbeat/packetbeat cloudbeat/cloudbeat endpoint-dev/endpoint-security fleet-server/fleet-server" + +WIN_ONLY_PACKAGE_PREFIXES="beats/winlogbeat/winlogbeat" + +RPM_PACKAGES="beats/elastic-agent/elastic-agent" +DEB_PACKAGES="beats/elastic-agent/elastic-agent" + +function download_packages() { + local url_suffix="$1" + local package_prefixes="$2" + + local _url_suffixes="$url_suffix ${url_suffix}.sha512 ${url_suffix}.asc" + local _pkg_dir="" + local _dl_url="" + + for _download_prefix in $package_prefixes; do + for _pkg_url_suffix in $_url_suffixes; do + _pkg_dir=$(dirname ${DOWNLOAD_BASE_DIR}/${_download_prefix}) + _dl_url="${ARTIFACT_DOWNLOADS_BASE_URL}/${_download_prefix}-${_pkg_url_suffix}" + (mkdir -p $_pkg_dir && cd $_pkg_dir && curl -O "$_dl_url") + done + done +} + +# and we download +for _os in linux windows; do + case "$_os" in + linux) + PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.tar.gz" + ;; + windows) + PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.zip" + ;; + *) + echo "[ERROR] Something happened" + exit 1 + ;; + esac + + download_packages "$PKG_URL_SUFFIX" "$COMMON_PACKAGE_PREFIXES" + + if [[ "$_os" = "windows" ]]; then + download_packages "$PKG_URL_SUFFIX" "$WIN_ONLY_PACKAGE_PREFIXES" + fi + + if [[ "$_os" = "linux" ]]; then + download_packages "${STACK_VERSION}-x86_64.rpm" "$RPM_PACKAGES" + download_packages "${STACK_VERSION}-amd64.deb" "$DEB_PACKAGES" + fi +done + + +## selinux tweaks +# semanage fcontext -a -t "httpd_sys_content_t" '/opt/elastic-packages(/.*)?' +# restorecon -Rv /opt/elastic-packages +``` +::: +:::: +::::: + :::{dropdown} NGINX config for private {{artifact-registry}} web server The following is an example NGINX configuration for running a web server for the {{artifact-registry}}. diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md index 038bef4541..d14e7e2c3d 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md @@ -39,14 +39,29 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com ... ``` -5. In the `.env` file, set `STACK_VERSION` to the current {{stack}} version. +5. Edit the `.env` file to set the `STACK_VERSION`: + ::::{tab-set} + + :::{tab-item} Latest + Set the stack version to the current {{es}} {{version.stack}} version. ```txt subs=true ... # Version of Elastic products STACK_VERSION={{version.stack}} ... ``` + ::: + + :::{tab-item} Specific version + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```txt subs=true + ... + # Version of Elastic products + STACK_VERSION= + ... + ::: + :::: 6. By default, the Docker Compose configuration exposes port `9200` on all network interfaces. diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md index 3f79072ba2..723547d991 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md @@ -63,15 +63,33 @@ To encrypt your secure settings with a password and have them persist outside th For example: +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} \ bin/elasticsearch-keystore create -p ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker run -it --rm \ +-v full_path_to/config:/usr/share/elasticsearch/config \ +docker.elastic.co/elasticsearch/elasticsearch: \ +bin/elasticsearch-keystore create -p +``` +::: +:::: You can also use a `docker run` command to add or update secure settings in the keystore. You’ll be prompted to enter the setting values. If the keystore is encrypted, you’ll also be prompted to enter the keystore password. +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ @@ -80,6 +98,20 @@ bin/elasticsearch-keystore \ add my.secure.setting \ my.other.secure.setting ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker run -it --rm \ +-v full_path_to/config:/usr/share/elasticsearch/config \ +docker.elastic.co/elasticsearch/elasticsearch: \ +bin/elasticsearch-keystore \ +add my.secure.setting \ +my.other.secure.setting +``` +::: +:::: If you’ve already created the keystore and don’t need to update it, you can bind-mount the `elasticsearch.keystore` file directly. You can use the `KEYSTORE_PASSWORD` environment variable to provide the keystore password to the container at startup. For example, a `docker run` command might have the following options: @@ -93,10 +125,23 @@ If you’ve already created the keystore and don’t need to update it, you can In some environments, it might make more sense to prepare a custom image that contains your configuration. A `Dockerfile` to achieve this might be as simple as: +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true FROM docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/ ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +FROM docker.elastic.co/elasticsearch/elasticsearch: +COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/ +``` +::: +:::: You could then build and run the image with: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md index 24de6e0da7..b0176006ad 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md @@ -131,9 +131,21 @@ Increased ulimits for [nofile](setting-system-settings.md) and [nproc](/deploy-m To check the Docker daemon defaults for ulimits, run: +::::{tab-set} + + :::{tab-item} Latest ```sh subs=true docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker run --rm docker.elastic.co/elasticsearch/elasticsearch: /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' +``` +::: +:::: If needed, adjust them in the Daemon or override them per container. For example, when using `docker run`, set: @@ -166,9 +178,21 @@ To manually set the heap size in production, bind mount a [JVM options](elastics For testing, you can also manually set the heap size using the `ES_JAVA_OPTS` environment variable. For example, to use 1GB, use the following command. +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch: +``` +::: +:::: The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend using `ES_JAVA_OPTS` in production. @@ -177,9 +201,21 @@ The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend Pin your deployments to a specific version of the {{es}} Docker image. For example: +::::{tab-set} + +:::{tab-item} Latest ```sh subs=true docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` +::: + +:::{tab-item} Specific version +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker.elastic.co/elasticsearch/elasticsearch: +``` +::: +:::: ## Always bind data volumes [_always_bind_data_volumes] From e471b5ceedb4e2b02fd58c37b08372cc6a567686 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Thu, 7 Aug 2025 13:20:05 +0100 Subject: [PATCH 7/9] Adds Kibana topics + tab grouping & sync --- .../deploy/self-managed/_snippets/wolfi.md | 6 +- .../install-elasticsearch-docker-basic.md | 28 +++- .../install-elasticsearch-docker-compose.md | 4 +- .../install-elasticsearch-docker-configure.md | 12 +- .../install-elasticsearch-docker-prod.md | 14 +- ...asticsearch-from-archive-on-linux-macos.md | 8 +- ...tall-kibana-from-archive-on-linux-macos.md | 41 +++++ .../self-managed/install-kibana-on-windows.md | 16 ++ .../install-kibana-with-debian-package.md | 17 ++ .../install-kibana-with-docker.md | 150 ++++++++++++++++++ .../self-managed/install-kibana-with-rpm.md | 17 ++ 11 files changed, 294 insertions(+), 19 deletions(-) diff --git a/deploy-manage/deploy/self-managed/_snippets/wolfi.md b/deploy-manage/deploy/self-managed/_snippets/wolfi.md index 4892a876de..25412141cf 100644 --- a/deploy-manage/deploy/self-managed/_snippets/wolfi.md +++ b/deploy-manage/deploy/self-managed/_snippets/wolfi.md @@ -5,18 +5,20 @@ To use the Wolfi image, append `-wolfi` to the image tag in the Docker command. For example: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{version.stack}} ``` ::: :::{tab-item} Specific version +:sync: specific ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi: ``` -You can download and install a specific version of {{es}} {{version.stack.base | M }} by replacing `` with the version number you want. For example, you can replace `` with {{version.stack.base}}. +You can download and install a specific version of the {{version.stack.base | M }} stack by replacing `` with the version number you want. For example, you can replace `` with {{version.stack.base}}. ::: :::: \ No newline at end of file diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md index b9f32426f5..85330fa8ec 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md @@ -35,14 +35,16 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 3. Pull the {{es}} Docker image. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch: @@ -52,8 +54,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 4. Optional: Install [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/) for your environment. Then use Cosign to verify the {{es}} image’s signature. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest $$$docker-verify-signature$$$ ```sh subs=true @@ -73,6 +76,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. $$$docker-verify-signature$$$ @@ -97,8 +101,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 5. Start an {{es}} container. ::::::{tab-set} - + :group: docker :::::{tab-item} Latest + :sync: latest ```sh subs=true docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` @@ -117,6 +122,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::::: :::::{tab-item} Specific version + :sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: @@ -174,13 +180,15 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 2. Start a new {{es}} container. Include the enrollment token as an environment variable. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest ```sh subs=true docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: @@ -199,13 +207,15 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 1. Pull the {{kib}} Docker image. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest ```sh subs=true docker pull docker.elastic.co/kibana/kibana:{{version.stack}} ``` ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker pull docker.elastic.co/kibana/kibana: @@ -216,14 +226,16 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 2. Optional: Verify the {{kib}} image’s signature. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{version.stack}} ``` ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub @@ -236,13 +248,15 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes 3. Start a {{kib}} container. ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest ```sh subs=true docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{version.stack}} ``` ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md index d14e7e2c3d..3d0530046a 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md @@ -42,8 +42,9 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com 5. Edit the `.env` file to set the `STACK_VERSION`: ::::{tab-set} - + :group: docker :::{tab-item} Latest + :sync: latest Set the stack version to the current {{es}} {{version.stack}} version. ```txt subs=true ... @@ -54,6 +55,7 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com ::: :::{tab-item} Specific version + :sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```txt subs=true ... diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md index 723547d991..e57b773eb9 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md @@ -64,8 +64,9 @@ To encrypt your secure settings with a password and have them persist outside th For example: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ @@ -75,6 +76,7 @@ bin/elasticsearch-keystore create -p ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -it --rm \ @@ -88,8 +90,9 @@ bin/elasticsearch-keystore create -p You can also use a `docker run` command to add or update secure settings in the keystore. You’ll be prompted to enter the setting values. If the keystore is encrypted, you’ll also be prompted to enter the keystore password. ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ @@ -101,6 +104,7 @@ my.other.secure.setting ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -it --rm \ @@ -126,8 +130,9 @@ If you’ve already created the keystore and don’t need to update it, you can In some environments, it might make more sense to prepare a custom image that contains your configuration. A `Dockerfile` to achieve this might be as simple as: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true FROM docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/ @@ -135,6 +140,7 @@ COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsea ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true FROM docker.elastic.co/elasticsearch/elasticsearch: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md index b0176006ad..11d89ec41c 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md @@ -132,14 +132,16 @@ Increased ulimits for [nofile](setting-system-settings.md) and [nproc](/deploy-m To check the Docker daemon defaults for ulimits, run: ::::{tab-set} - - :::{tab-item} Latest +:group: docker +:::{tab-item} Latest +:sync: latest ```sh subs=true docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' ``` ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run --rm docker.elastic.co/elasticsearch/elasticsearch: /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' @@ -179,14 +181,16 @@ To manually set the heap size in production, bind mount a [JVM options](elastics For testing, you can also manually set the heap size using the `ES_JAVA_OPTS` environment variable. For example, to use 1GB, use the following command. ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch: @@ -202,14 +206,16 @@ The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend Pin your deployments to a specific version of the {{es}} Docker image. For example: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest ```sh subs=true docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker.elastic.co/elasticsearch/elasticsearch: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index 200c67964a..c8f18969cf 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -46,8 +46,9 @@ Download and install the archive for Linux or MacOS. The Linux archive for {{es}} can be downloaded and installed as follows: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest To download and install the {{es}} {{version.stack}} archive, enter: ```sh subs=true wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-linux-x86_64.tar.gz @@ -61,6 +62,7 @@ cd elasticsearch-{{version.stack}}/ <2> ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz @@ -80,8 +82,9 @@ cd elasticsearch-/ <2> The MacOS archive for {{es}} can be downloaded and installed as follows: ::::{tab-set} - +:group: docker :::{tab-item} Latest +:sync: latest To download and install the {{es}} {{version.stack}} archive, enter: ```sh subs=true curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz @@ -94,6 +97,7 @@ cd elasticsearch-{{version.stack}}/ <2> ::: :::{tab-item} Specific version +:sync: specific Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz diff --git a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md index 91420be2c5..c7f13c99b5 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md @@ -29,6 +29,11 @@ macOS is supported for development purposes only and is not covered under the su The Linux archive for {{kib}} {{version.stack}} can be downloaded and installed as follows: +::::{tab-set} +:group: docker-kib +:::{tab-item} Latest +:sync: latest +To download and install the {{kib}} {{version.stack}} archive, enter: ```sh subs=true curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-linux-x86_64.tar.gz curl https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> @@ -38,11 +43,32 @@ cd kibana-{{version.stack}}/ <2> 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$KIBANA_HOME`. +::: + +:::{tab-item} Specific version +:sync: specific +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +curl -O https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf kibana--linux-x86_64.tar.gz +cd kibana-/ <2> +``` + +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--linux-x86_64.tar.gz: OK`. +2. This directory is known as `$KIBANA_HOME`. +::: +:::: ### MacOS [install-darwin64] The Darwin archive for {{kib}} {{version.stack}} can be downloaded and installed as follows: +::::{tab-set} +:group: docker-kib +:::{tab-item} Latest +:sync: latest +To download and install the {{kib}} {{version.stack}} archive, enter: ```sh subs=true curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-darwin-x86_64.tar.gz curl https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> @@ -52,7 +78,22 @@ cd kibana-{{version.stack}}/ <2> 1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--darwin-x86_64.tar.gz: OK`. 2. This directory is known as `$KIBANA_HOME`. +::: + +:::{tab-item} Specific version +:sync: specific +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +curl -O https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf kibana--darwin-x86_64.tar.gz +cd kibana-/ <2> +``` +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--darwin-x86_64.tar.gz: OK`. +2. This directory is known as `$KIBANA_HOME`. +::: +:::: ::::{admonition} macOS Gatekeeper warnings :class: important diff --git a/deploy-manage/deploy/self-managed/install-kibana-on-windows.md b/deploy-manage/deploy/self-managed/install-kibana-on-windows.md index c0799768ca..252aefc1b8 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-kibana-on-windows.md @@ -18,6 +18,9 @@ products: ## Step 1: Download and install the `.zip` package [install-windows] +::::{tab-set} + +:::{tab-item} Latest Download the .zip windows archive for {{kib}} {{version.stack}} from [https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-windows-x86_64.zip](https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-windows-x86_64.zip) Unzip it with your favorite unzip tool. This will create a folder called kibana-{{version.stack}}-windows-x86_64, which we will refer to as `$KIBANA_HOME`. In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: @@ -25,6 +28,19 @@ Unzip it with your favorite unzip tool. This will create a folder called kibana- ```sh subs=true CD c:\kibana-{{version.stack}}-windows-x86_64 ``` +::: + +:::{tab-item} Specific version +Download the `.zip` archive for the {{kib}} version that you want from the [Past Releases](https://www.elastic.co/downloads/past-releases) page. + +Unzip it with your favorite unzip tool. This will create a folder called kibana--windows-x86_64, which we will refer to as `$KIBANA_HOME`. In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: + +```sh subs=true +CD c:\kibana-}-windows-x86_64 +``` +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +::: +:::: ## Step 2: Start {{es}} and generate an enrollment token for {{kib}} [windows-enroll] diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md index 635504b4da..8d2eb5ddf0 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md @@ -80,6 +80,10 @@ Examine `/etc/apt/sources.list.d/kibana-9.x.list` for the duplicate entry or loc The Debian package for {{kib}} {{version.stack}} can be downloaded from the website and installed as follows: +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{kib}} {{version.stack}} package, enter: ```sh subs=true wget https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-amd64.deb shasum -a 512 kibana-{{version.stack}}-amd64.deb <1> @@ -87,8 +91,21 @@ sudo dpkg -i kibana-{{version.stack}}-amd64.deb ``` 1. Compare the SHA produced by shasum with the [published SHA](https://artifacts.elastic.co/downloads/kibana/kibana-9.0.0-amd64.deb.sha512). +% version manually specified in the link above +::: + +:::{tab-item} Specific version +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +wget https://artifacts.elastic.co/downloads/kibana/kibana--amd64.deb +shasum -a 512 kibana--amd64.deb <1> +sudo dpkg -i kibana--amd64.deb +``` +1. Compare the SHA produced by shasum with the [published SHA](https://artifacts.elastic.co/downloads/kibana/kibana-9.0.0-amd64.deb.sha512). % version manually specified in the link above +::: +:::: ## Step 3: Start {{es}} and generate an enrollment token for {{kib}} [deb-enroll] diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md index 1be37fc9f5..4834833014 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md @@ -48,12 +48,30 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod 3. Pull the {{es}} Docker image. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker pull docker.elastic.co/elasticsearch/elasticsearch: + ``` + ::: + :::: 4. Optional: Install [Cosign](https://docs.sigstore.dev/system_config/installation/) for your environment. Then use Cosign to verify the {{es}} image’s signature. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} @@ -68,12 +86,47 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod - Existence of the claims in the transparency log was verified offline - The signatures were verified against the specified public key ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + wget https://artifacts.elastic.co/cosign.pub + cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: + ``` + + The `cosign` command prints the check results and the signature payload in JSON format: + + ```sh subs=true + Verification for docker.elastic.co/elasticsearch/elasticsearch: -- + The following checks were performed on each of these signatures: + - The cosign claims were validated + - Existence of the claims in the transparency log was verified offline + - The signatures were verified against the specified public key + ``` + ::: + :::: 5. Start an {{es}} container. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + ``` + ::: + :::: ::::{tip} Use the `-m` flag to set a memory limit for the container. This removes the need to [manually set the JVM size](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md#docker-set-heap-size). @@ -91,22 +144,65 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod 7. Pull the {{kib}} Docker image. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true docker pull docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker pull docker.elastic.co/kibana/kibana: + ``` + ::: + :::: 8. Optional: Verify the {{kib}} image’s signature. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + wget https://artifacts.elastic.co/cosign.pub + cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: + ``` + ::: + :::: 9. Start a {{kib}} container. + ::::{tab-set} + :group: docker + :::{tab-item} Latest + :sync: latest ```sh subs=true docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{version.stack}} ``` + ::: + + :::{tab-item} Specific version + :sync: specific + Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + ```sh subs=true + docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: + ``` + ::: + :::: 10. When {{kib}} starts, it outputs a unique generated link to the terminal. To access {{kib}}, open this link in a web browser. 11. In your browser, enter the enrollment token that was generated when you started {{es}}. @@ -150,6 +246,10 @@ The Docker images provide several methods for configuring {{kib}}. The conventio One way to configure {{kib}} on Docker is to provide `kibana.yml` via bind-mounting. With `docker-compose`, the bind-mount can be specified like this: +::::{tab-set} +:group: docker-kib +:::{tab-item} Latest +:sync: latest ```yaml subs=true version: '2' services: @@ -158,16 +258,46 @@ services: volumes: - ./kibana.yml:/usr/share/kibana/config/kibana.yml ``` +::: + +:::{tab-item} Specific version +:sync: specific +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```yaml subs=true +version: '2' +services: + kibana: + image: docker.elastic.co/kibana/kibana: + volumes: + - ./kibana.yml:/usr/share/kibana/config/kibana.yml +``` +::: +:::: ## Persist the {{kib}} keystore [_persist_the_kib_keystore] By default, {{kib}} auto-generates a keystore file for secure settings at startup. To persist your [secure settings](/deploy-manage/security/secure-settings.md), use the `kibana-keystore` utility to bind-mount the parent directory of the keystore to the container. For example: +::::{tab-set} +:group: docker-kib +:::{tab-item} Latest +:sync: latest ```sh subs=true docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana:{{version.stack}} bin/kibana-keystore create docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana:{{version.stack}} bin/kibana-keystore add test_keystore_setting ``` +::: + +:::{tab-item} Specific version +:sync: specific +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore create +docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore add test_keystore_setting +``` +::: +:::: ### Environment variable configuration [environment-variable-config] @@ -195,6 +325,10 @@ Supplying array options can be tricky. The following example shows the syntax fo These variables can be set with `docker-compose` like this: +::::{tab-set} +:group: docker-kib +:::{tab-item} Latest +:sync: latest ```yaml subs=true version: '2' services: @@ -204,6 +338,22 @@ services: SERVER_NAME: kibana.example.org ELASTICSEARCH_HOSTS: '[":9200",":9200",":9200"]' ``` +::: + +:::{tab-item} Specific version +:sync: specific +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```yaml subs=true +version: '2' +services: + kibana: + image: docker.elastic.co/kibana/kibana: + environment: + SERVER_NAME: kibana.example.org + ELASTICSEARCH_HOSTS: '[":9200",":9200",":9200"]' +``` +::: +:::: Since environment variables are translated to CLI arguments, they take precedence over settings configured in `kibana.yml`. diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md index 04a98ca2dc..dd95dd959c 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md @@ -69,6 +69,10 @@ sudo zypper install kibana <3> The RPM for {{kib}} {{version.stack}} can be downloaded from the website and installed as follows: +::::{tab-set} + +:::{tab-item} Latest +To download and install the {{kib}} {{version.stack}} RPM, enter: ```sh subs=true wget https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-x86_64.rpm wget https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-x86_64.rpm.sha512 @@ -77,7 +81,20 @@ sudo rpm --install kibana-{{version.stack}}-x86_64.rpm ``` 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `kibana--x86_64.rpm: OK`. +::: +:::{tab-item} Specific version +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +```sh subs=true +wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm +wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm.sha512 +shasum -a 512 -c kibana--x86_64.rpm.sha512 <1> +sudo rpm --install kibana--x86_64.rpm +``` + +1. Compares the SHA of the downloaded RPM and the published checksum, which should output `kibana--x86_64.rpm: OK`. +::: +:::: ## Step 3: Start {{es}} and generate an enrollment token for {{kib}} [rpm-enroll] From 10b9013badffcfd34b32ed987d753c1424672dd9 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Fri, 8 Aug 2025 16:47:30 +0100 Subject: [PATCH 8/9] Updating to address peer review feedback --- .../deploy/self-managed/_snippets/wolfi.md | 4 +- .../deploy/self-managed/air-gapped-install.md | 12 +++--- .../install-elasticsearch-docker-basic.md | 32 +++++++-------- .../install-elasticsearch-docker-compose.md | 6 +-- .../install-elasticsearch-docker-configure.md | 12 +++--- .../install-elasticsearch-docker-prod.md | 12 +++--- ...asticsearch-from-archive-on-linux-macos.md | 26 ++++++------ ...stall-elasticsearch-with-debian-package.md | 12 +++--- .../install-elasticsearch-with-rpm.md | 12 +++--- ...stall-elasticsearch-with-zip-on-windows.md | 18 +++++++-- ...tall-kibana-from-archive-on-linux-macos.md | 26 ++++++------ .../self-managed/install-kibana-on-windows.md | 20 +++++++--- .../install-kibana-with-debian-package.md | 9 +++-- .../install-kibana-with-docker.md | 40 +++++++++---------- .../self-managed/install-kibana-with-rpm.md | 13 +++--- 15 files changed, 139 insertions(+), 115 deletions(-) diff --git a/deploy-manage/deploy/self-managed/_snippets/wolfi.md b/deploy-manage/deploy/self-managed/_snippets/wolfi.md index 25412141cf..34377f5820 100644 --- a/deploy-manage/deploy/self-managed/_snippets/wolfi.md +++ b/deploy-manage/deploy/self-managed/_snippets/wolfi.md @@ -16,9 +16,9 @@ docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{version.stack} :::{tab-item} Specific version :sync: specific ```sh subs=true -docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi: +docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi: ``` -You can download and install a specific version of the {{version.stack.base | M }} stack by replacing `` with the version number you want. For example, you can replace `` with {{version.stack.base}}. +You can download and install a specific version of the {{stack}} by replacing `` with the version number you want. For example, you can replace `` with {{version.stack.base}}. ::: :::: \ No newline at end of file diff --git a/deploy-manage/deploy/self-managed/air-gapped-install.md b/deploy-manage/deploy/self-managed/air-gapped-install.md index 55fea4cf74..2baff63b4e 100644 --- a/deploy-manage/deploy/self-managed/air-gapped-install.md +++ b/deploy-manage/deploy/self-managed/air-gapped-install.md @@ -119,7 +119,7 @@ podman create \ ::: :::{tab-item} Specific version -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true #!/usr/bin/env bash @@ -127,7 +127,7 @@ EPR_BIND_ADDRESS="0.0.0.0" EPR_BIND_PORT="8443" EPR_TLS_CERT="/etc/elastic/epr/epr.pem" EPR_TLS_KEY="/etc/elastic/epr/epr-key.pem" -EPR_IMAGE="docker.elastic.co/package-registry/distribution:" +EPR_IMAGE="docker.elastic.co/package-registry/distribution:" podman create \ --name "elastic-epr" \ @@ -196,7 +196,7 @@ WantedBy=default.target ::: ::::::{tab-item} Specific version -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```ini subs=true # container-elastic-epr.service # autogenerated by Podman 4.1.1 @@ -227,7 +227,7 @@ ExecStart=/usr/bin/podman run \ -v /etc/elastic/epr/epr-key.pem:/etc/ssl/epr.key:ro \ -e EPR_ADDRESS=0.0.0.0:8443 \ -e EPR_TLS_CERT=/etc/ssl/epr.crt \ - -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution: + -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution: ExecStop=/usr/bin/podman stop --ignore --cidfile=%t/%n.ctr-id ExecStopPost=/usr/bin/podman rm -f --ignore --cidfile=%t/%n.ctr-id Type=notify @@ -326,12 +326,12 @@ done ::: ::::::{tab-item} Specific version -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true #!/usr/bin/env bash set -o nounset -o errexit -o pipefail -STACK_VERSION= +STACK_VERSION= ARTIFACT_DOWNLOADS_BASE_URL=https://artifacts.elastic.co/downloads DOWNLOAD_BASE_DIR=${DOWNLOAD_BASE_DIR:?"Make sure to set DOWNLOAD_BASE_DIR when running this script"} diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md index 85330fa8ec..d0b1fb5412 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md @@ -45,9 +45,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes :::{tab-item} Specific version :sync: specific - Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true - docker pull docker.elastic.co/elasticsearch/elasticsearch: + docker pull docker.elastic.co/elasticsearch/elasticsearch: ``` ::: @@ -77,18 +77,18 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes :::{tab-item} Specific version :sync: specific - Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. $$$docker-verify-signature$$$ ```sh subs=true wget https://artifacts.elastic.co/cosign.pub - cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: + cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: ``` The `cosign` command prints the check results and the signature payload in JSON format: ```sh subs=true - Verification for docker.elastic.co/elasticsearch/elasticsearch: -- + Verification for docker.elastic.co/elasticsearch/elasticsearch: -- The following checks were performed on each of these signatures: - The cosign claims were validated - Existence of the claims in the transparency log was verified offline @@ -123,9 +123,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes :::::{tab-item} Specific version :sync: specific - Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. ```sh subs=true - docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: ``` ::::{tip} @@ -135,7 +135,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes {{ml-cap}} features such as [semantic search with ELSER](/solutions/search/semantic-search/semantic-search-elser-ingest-pipelines.md) require a larger container with more than 1GB of memory. If you intend to use the {{ml}} capabilities, then start the container with this command: ```sh subs=true - docker run --name es01 --net elastic -p 9200:9200 -it -m 6GB -e "xpack.ml.use_auto_machine_memory_percent=true" docker.elastic.co/elasticsearch/elasticsearch: + docker run --name es01 --net elastic -p 9200:9200 -it -m 6GB -e "xpack.ml.use_auto_machine_memory_percent=true" docker.elastic.co/elasticsearch/elasticsearch: ``` The command prints the `elastic` user password and an enrollment token for {{kib}}. @@ -189,9 +189,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::: :::{tab-item} Specific version :sync: specific - Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. ```sh subs=true - docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + docker run -e ENROLLMENT_TOKEN="" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: ``` ::: :::: @@ -216,9 +216,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::: :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. ```sh subs=true - docker pull docker.elastic.co/kibana/kibana: + docker pull docker.elastic.co/kibana/kibana: ``` ::: :::: @@ -236,10 +236,10 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::: :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub - cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: + cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: ``` ::: :::: @@ -257,9 +257,9 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes ::: :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. ```sh subs=true - docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: + docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: ``` ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md index 3d0530046a..1864d9c948 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md @@ -45,7 +45,7 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com :group: docker :::{tab-item} Latest :sync: latest - Set the stack version to the current {{es}} {{version.stack}} version. + Set the stack version to the current {{stack}} version. ```txt subs=true ... # Version of Elastic products @@ -56,11 +56,11 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com :::{tab-item} Specific version :sync: specific - Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```txt subs=true ... # Version of Elastic products - STACK_VERSION= + STACK_VERSION= ... ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md index e57b773eb9..4491cd39fa 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md @@ -77,11 +77,11 @@ bin/elasticsearch-keystore create -p :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ -docker.elastic.co/elasticsearch/elasticsearch: \ +docker.elastic.co/elasticsearch/elasticsearch: \ bin/elasticsearch-keystore create -p ``` ::: @@ -105,11 +105,11 @@ my.other.secure.setting :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ -docker.elastic.co/elasticsearch/elasticsearch: \ +docker.elastic.co/elasticsearch/elasticsearch: \ bin/elasticsearch-keystore \ add my.secure.setting \ my.other.secure.setting @@ -141,9 +141,9 @@ COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsea :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -FROM docker.elastic.co/elasticsearch/elasticsearch: +FROM docker.elastic.co/elasticsearch/elasticsearch: COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/ ``` ::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md index 11d89ec41c..bd6855d832 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md @@ -142,9 +142,9 @@ docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -docker run --rm docker.elastic.co/elasticsearch/elasticsearch: /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' +docker run --rm docker.elastic.co/elasticsearch/elasticsearch: /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' ``` ::: :::: @@ -191,9 +191,9 @@ docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch: +docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch: ``` ::: :::: @@ -216,9 +216,9 @@ docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -docker.elastic.co/elasticsearch/elasticsearch: +docker.elastic.co/elasticsearch/elasticsearch: ``` ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md index c8f18969cf..7fd307328b 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md @@ -63,15 +63,15 @@ cd elasticsearch-{{version.stack}}/ <2> :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz -wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz.sha512 -shasum -a 512 -c elasticsearch--linux-x86_64.tar.gz.sha512 <1> -tar -xzf elasticsearch--linux-x86_64.tar.gz -cd elasticsearch-/ <2> +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--linux-x86_64.tar.gz.sha512 +shasum -a 512 -c elasticsearch--linux-x86_64.tar.gz.sha512 <1> +tar -xzf elasticsearch--linux-x86_64.tar.gz +cd elasticsearch-/ <2> ``` -1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. ::: :::: @@ -98,14 +98,14 @@ cd elasticsearch-{{version.stack}}/ <2> :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz -curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> -tar -xzf elasticsearch--darwin-x86_64.tar.gz -cd elasticsearch-/ <2> +curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf elasticsearch--darwin-x86_64.tar.gz +cd elasticsearch-/ <2> ``` -1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--darwin-x86_64.tar.gz: OK`. +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch--darwin-x86_64.tar.gz: OK`. 2. This directory is known as `$ES_HOME`. ::: ::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md index 5f119c671e..4127a56d20 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md @@ -115,14 +115,14 @@ sudo dpkg -i elasticsearch-{{version.stack}}-amd64.deb ::: :::{tab-item} Specific version -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true -wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb -wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb.sha512 -shasum -a 512 -c elasticsearch--amd64.deb.sha512 <1> -sudo dpkg -i elasticsearch--amd64.deb +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb +wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--amd64.deb.sha512 +shasum -a 512 -c elasticsearch--amd64.deb.sha512 <1> +sudo dpkg -i elasticsearch--amd64.deb ``` -1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. +1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch--amd64.deb: OK`. ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md index 16c64e9881..6275624564 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md @@ -103,14 +103,14 @@ To download and install the {{es}} {{version.stack}} RPM, enter: ::: :::{tab-item} Specific version -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true - wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm - wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm.sha512 - shasum -a 512 -c elasticsearch--x86_64.rpm.sha512 <1> - sudo rpm --install elasticsearch--x86_64.rpm + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm + wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch--x86_64.rpm.sha512 + shasum -a 512 -c elasticsearch--x86_64.rpm.sha512 <1> + sudo rpm --install elasticsearch--x86_64.rpm ``` - 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `elasticsearch--x86_64.rpm: OK`. + 1. Compares the SHA of the downloaded RPM and the published checksum, which should output `elasticsearch--x86_64.rpm: OK`. :::{include} _snippets/skip-set-kernel-params.md ::: diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md index a892e5fb87..63e7623a50 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md @@ -47,7 +47,15 @@ On Windows, the {{es}} {{ml}} feature requires the Microsoft Universal C Runtime % link url manually set Download the `.zip` archive for {{es}} {{version.stack}} from: [https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-windows-x86_64.zip](https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-windows-x86_64.zip) -Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-{{version.stack}}`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for example: +Unzip it with your favorite unzip tool. This will create a folder with the following name: + +```text subs=true +elasticsearch-{{version.stack}} +``` + +We will refer to this folder as `%ES_HOME%`. + +In a terminal window, `cd` to the `%ES_HOME%` directory, for example: ```sh subs=true cd C:\Program Files\elasticsearch-{{version.stack}} @@ -57,12 +65,14 @@ cd C:\Program Files\elasticsearch-{{version.stack}} :::{tab-item} Specific version Download the `.zip` archive for the {{es}} version that you want from the [Past Releases](https://www.elastic.co/downloads/past-releases) page. -Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for example: +Unzip it with your favorite unzip tool. This will create a folder called `elasticsearch-`, where `` is the version you downloaded. We will refer to this folder as `%ES_HOME%`. + +In a terminal window, `cd` to the `%ES_HOME%` directory, for example: ```sh subs=true -cd C:\Program Files\elasticsearch- +cd C:\Program Files\elasticsearch- ``` -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{es}} version you installed. ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md index c7f13c99b5..75ba2234a0 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md @@ -47,15 +47,16 @@ cd kibana-{{version.stack}}/ <2> :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Because {{kib}} is an {{stack}} product, you must install the same version number that's used across the stack. Replace `` with the {{stack}} version. +For more information, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version). ```sh subs=true -curl -O https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz -curl https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> -tar -xzf kibana--linux-x86_64.tar.gz -cd kibana-/ <2> +curl -O https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf kibana--linux-x86_64.tar.gz +cd kibana-/ <2> ``` -1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--linux-x86_64.tar.gz: OK`. +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--linux-x86_64.tar.gz: OK`. 2. This directory is known as `$KIBANA_HOME`. ::: :::: @@ -82,15 +83,16 @@ cd kibana-{{version.stack}}/ <2> :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Because {{kib}} is an {{stack}} product, you must install the same version number that's used across the stack. Replace `` with the {{stack}} version. +For more information, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version). ```sh subs=true -curl -O https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz -curl https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> -tar -xzf kibana--darwin-x86_64.tar.gz -cd kibana-/ <2> +curl -O https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz +curl https://artifacts.elastic.co/downloads/kibana/kibana--darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1> +tar -xzf kibana--darwin-x86_64.tar.gz +cd kibana-/ <2> ``` -1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--darwin-x86_64.tar.gz: OK`. +1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `kibana--darwin-x86_64.tar.gz: OK`. 2. This directory is known as `$KIBANA_HOME`. ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-kibana-on-windows.md b/deploy-manage/deploy/self-managed/install-kibana-on-windows.md index 252aefc1b8..6d8ba29ee5 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-on-windows.md +++ b/deploy-manage/deploy/self-managed/install-kibana-on-windows.md @@ -23,7 +23,14 @@ products: :::{tab-item} Latest Download the .zip windows archive for {{kib}} {{version.stack}} from [https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-windows-x86_64.zip](https://artifacts.elastic.co/downloads/kibana/kibana-{{version.stack}}-windows-x86_64.zip) -Unzip it with your favorite unzip tool. This will create a folder called kibana-{{version.stack}}-windows-x86_64, which we will refer to as `$KIBANA_HOME`. In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: +Unzip it with your favorite unzip tool. This will create a folder with the following name: + +```text subs=true +kibana-{{version.stack}}-windows-x86_64 +``` +We will refer to this folder as `$KIBANA_HOME`. + +In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: ```sh subs=true CD c:\kibana-{{version.stack}}-windows-x86_64 @@ -31,14 +38,17 @@ CD c:\kibana-{{version.stack}}-windows-x86_64 ::: :::{tab-item} Specific version -Download the `.zip` archive for the {{kib}} version that you want from the [Past Releases](https://www.elastic.co/downloads/past-releases) page. +Download the `.zip` archive for the {{kib}} version that you want from the [Past Releases](https://www.elastic.co/downloads/past-releases) page. +If you're unsure about which version to install, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version) for more information about version compatibility. + +Unzip it with your favorite unzip tool. This will create a folder called `kibana--windows-x86_64`, where `` is the version you downloaded. We will refer to this folder as `$KIBANA_HOME`. -Unzip it with your favorite unzip tool. This will create a folder called kibana--windows-x86_64, which we will refer to as `$KIBANA_HOME`. In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: +In a terminal window, CD to the `$KIBANA_HOME` directory, for instance: ```sh subs=true -CD c:\kibana-}-windows-x86_64 +CD c:\kibana-}-windows-x86_64 ``` -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{kib}} version number you installed. ::: :::: diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md index 8d2eb5ddf0..342d760d52 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md @@ -95,11 +95,12 @@ sudo dpkg -i kibana-{{version.stack}}-amd64.deb ::: :::{tab-item} Specific version -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{kib}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. +If you're unsure about which version to install, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version) for more information about version compatibility. ```sh subs=true -wget https://artifacts.elastic.co/downloads/kibana/kibana--amd64.deb -shasum -a 512 kibana--amd64.deb <1> -sudo dpkg -i kibana--amd64.deb +wget https://artifacts.elastic.co/downloads/kibana/kibana--amd64.deb +shasum -a 512 kibana--amd64.deb <1> +sudo dpkg -i kibana--amd64.deb ``` 1. Compare the SHA produced by shasum with the [published SHA](https://artifacts.elastic.co/downloads/kibana/kibana-9.0.0-amd64.deb.sha512). diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md index 4834833014..6ae0845c65 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md @@ -59,9 +59,9 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + Replace `` with the {{stack}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. ```sh subs=true - docker pull docker.elastic.co/elasticsearch/elasticsearch: + docker pull docker.elastic.co/elasticsearch/elasticsearch: ``` ::: :::: @@ -90,16 +90,16 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub - cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: + cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: ``` The `cosign` command prints the check results and the signature payload in JSON format: ```sh subs=true - Verification for docker.elastic.co/elasticsearch/elasticsearch: -- + Verification for docker.elastic.co/elasticsearch/elasticsearch: -- The following checks were performed on each of these signatures: - The cosign claims were validated - Existence of the claims in the transparency log was verified offline @@ -121,9 +121,9 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the stack version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```sh subs=true - docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: + docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: ``` ::: :::: @@ -155,9 +155,9 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled for {{es}} and replace with it. ```sh subs=true - docker pull docker.elastic.co/kibana/kibana: + docker pull docker.elastic.co/kibana/kibana: ``` ::: :::: @@ -176,10 +176,10 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub - cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: + cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: ``` ::: :::: @@ -197,9 +197,9 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```sh subs=true - docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: + docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: ``` ::: :::: @@ -262,12 +262,12 @@ services: :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. ```yaml subs=true version: '2' services: kibana: - image: docker.elastic.co/kibana/kibana: + image: docker.elastic.co/kibana/kibana: volumes: - ./kibana.yml:/usr/share/kibana/config/kibana.yml ``` @@ -291,10 +291,10 @@ docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```sh subs=true -docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore create -docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore add test_keystore_setting +docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore create +docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore add test_keystore_setting ``` ::: :::: @@ -342,12 +342,12 @@ services: :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. ```yaml subs=true version: '2' services: kibana: - image: docker.elastic.co/kibana/kibana: + image: docker.elastic.co/kibana/kibana: environment: SERVER_NAME: kibana.example.org ELASTICSEARCH_HOSTS: '[":9200",":9200",":9200"]' diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md index dd95dd959c..2eb1a3fdeb 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md @@ -84,15 +84,16 @@ sudo rpm --install kibana-{{version.stack}}-x86_64.rpm ::: :::{tab-item} Specific version -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the {{kib}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. +If you're unsure about which version to install, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version) for more information about version compatibility. ```sh subs=true -wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm -wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm.sha512 -shasum -a 512 -c kibana--x86_64.rpm.sha512 <1> -sudo rpm --install kibana--x86_64.rpm +wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm +wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm.sha512 +shasum -a 512 -c kibana--x86_64.rpm.sha512 <1> +sudo rpm --install kibana--x86_64.rpm ``` -1. Compares the SHA of the downloaded RPM and the published checksum, which should output `kibana--x86_64.rpm: OK`. +1. Compares the SHA of the downloaded RPM and the published checksum, which should output `kibana--x86_64.rpm: OK`. ::: :::: From 5621b074ec85218c1d3e4eef018476dc892ec726 Mon Sep 17 00:00:00 2001 From: Vlada Chirmicci Date: Mon, 11 Aug 2025 12:43:16 +0100 Subject: [PATCH 9/9] More review edits for consistency --- .../install-elasticsearch-docker-basic.md | 4 ++-- .../install-elasticsearch-docker-configure.md | 6 +++--- .../install-elasticsearch-docker-prod.md | 6 +++--- ...stall-kibana-from-archive-on-linux-macos.md | 2 +- .../install-kibana-with-debian-package.md | 3 +-- .../self-managed/install-kibana-with-docker.md | 18 +++++++++--------- .../self-managed/install-kibana-with-rpm.md | 3 +-- 7 files changed, 20 insertions(+), 22 deletions(-) diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md index d0b1fb5412..a533f16214 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md @@ -45,7 +45,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes :::{tab-item} Specific version :sync: specific - Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. + Replace `` with the {{stack}} version number you want. For example, you can replace `` with {{version.stack.base}}. You'll use this same version number throughout this tutorial. ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch: ``` @@ -77,7 +77,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled earlier and replace `` with it. + Replace `` with the version of the Docker image you downloaded. $$$docker-verify-signature$$$ ```sh subs=true diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md index 4491cd39fa..9d55ab9f22 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md @@ -77,7 +77,7 @@ bin/elasticsearch-keystore create -p :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ @@ -105,7 +105,7 @@ my.other.secure.setting :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run -it --rm \ -v full_path_to/config:/usr/share/elasticsearch/config \ @@ -141,7 +141,7 @@ COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsea :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true FROM docker.elastic.co/elasticsearch/elasticsearch: COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/ diff --git a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md index bd6855d832..2ceae2eb42 100644 --- a/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md +++ b/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md @@ -142,7 +142,7 @@ docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run --rm docker.elastic.co/elasticsearch/elasticsearch: /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su' ``` @@ -191,7 +191,7 @@ docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch: ``` @@ -216,7 +216,7 @@ docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} :::{tab-item} Specific version :sync: specific -Replace `` with the {{es}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker.elastic.co/elasticsearch/elasticsearch: ``` diff --git a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md index 75ba2234a0..e24f015332 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md +++ b/deploy-manage/deploy/self-managed/install-kibana-from-archive-on-linux-macos.md @@ -47,7 +47,7 @@ cd kibana-{{version.stack}}/ <2> :::{tab-item} Specific version :sync: specific -Because {{kib}} is an {{stack}} product, you must install the same version number that's used across the stack. Replace `` with the {{stack}} version. +Because {{kib}} is an {{stack}} product, you must install the same version number as the rest of your {{stack}} components. Replace `` with the version that's used across your entire stack. For example, you can use {{version.stack.base}}. For more information, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version). ```sh subs=true curl -O https://artifacts.elastic.co/downloads/kibana/kibana--linux-x86_64.tar.gz diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md index 342d760d52..f1e301277a 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-debian-package.md @@ -95,8 +95,7 @@ sudo dpkg -i kibana-{{version.stack}}-amd64.deb ::: :::{tab-item} Specific version -Replace `` with the {{kib}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. -If you're unsure about which version to install, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version) for more information about version compatibility. +Because {{kib}} is an {{stack}} product, you must install the same version number as the rest of your {{stack}} components. Replace `` with the version that's used across your entire stack. For example, you can use {{version.stack.base}}. ```sh subs=true wget https://artifacts.elastic.co/downloads/kibana/kibana--amd64.deb shasum -a 512 kibana--amd64.deb <1> diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md index 6ae0845c65..f2784be84d 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-docker.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-docker.md @@ -59,7 +59,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Replace `` with the {{stack}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. + Because {{kib}} is an {{stack}} product, you must install the same version number as the rest of your {{stack}} components. Replace `` with the version that's used across your entire stack. For example, you can use {{version.stack.base}}. You'll use this same version number throughout this tutorial. ```sh subs=true docker pull docker.elastic.co/elasticsearch/elasticsearch: ``` @@ -90,7 +90,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. + Replace `` with the version of the Docker image you downloaded. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch: @@ -121,7 +121,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. + Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch: ``` @@ -155,7 +155,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled for {{es}} and replace with it. + Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker pull docker.elastic.co/kibana/kibana: ``` @@ -176,7 +176,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. + Replace `` with the version of the Docker image you downloaded. ```sh subs=true wget https://artifacts.elastic.co/cosign.pub cosign verify --key cosign.pub docker.elastic.co/kibana/kibana: @@ -197,7 +197,7 @@ This setup doesn’t run multiple {{es}} nodes by default. To create a multi-nod :::{tab-item} Specific version :sync: specific - Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. + Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana: ``` @@ -262,7 +262,7 @@ services: :::{tab-item} Specific version :sync: specific -Replace `` with the {{kib}} version number you want. For example, you can replace `` with {{version.stack.base}}. +Replace `` with the version of the Docker image you downloaded. ```yaml subs=true version: '2' services: @@ -291,7 +291,7 @@ docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path :::{tab-item} Specific version :sync: specific -Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. +Replace `` with the version of the Docker image you downloaded. ```sh subs=true docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore create docker run -it --rm -v full_path_to/config:/usr/share/kibana/config -v full_path_to/data:/usr/share/kibana/data docker.elastic.co/kibana/kibana: bin/kibana-keystore add test_keystore_setting @@ -342,7 +342,7 @@ services: :::{tab-item} Specific version :sync: specific -Use the same {{stack}} version number as the Docker image you pulled earlier and replace with it. +Replace `` with the version of the Docker image you downloaded. ```yaml subs=true version: '2' services: diff --git a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md index 2eb1a3fdeb..7fae5cbfb6 100644 --- a/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md +++ b/deploy-manage/deploy/self-managed/install-kibana-with-rpm.md @@ -84,8 +84,7 @@ sudo rpm --install kibana-{{version.stack}}-x86_64.rpm ::: :::{tab-item} Specific version -Replace `` with the {{kib}} version number you want to install. For example, you can replace `` with {{version.stack.base}}. -If you're unsure about which version to install, refer to [{{es}} version](/deploy-manage/deploy/self-managed/install-kibana.md#elasticsearch-version) for more information about version compatibility. +Because {{kib}} is an {{stack}} product, you must install the same version number as the rest of your {{stack}} components. Replace `` with the version that's used across your entire stack. For example, you can use {{version.stack.base}}. ```sh subs=true wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm wget https://artifacts.elastic.co/downloads/kibana/kibana--x86_64.rpm.sha512