Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
When installing the {{stack}}, you must use the same version across the entire stack. For example, if you are using {{es}} {{stack-version}}, you install Beats {{stack-version}}, APM Server {{stack-version}}, {{es}} Hadoop {{stack-version}}, {{kib}} {{stack-version}}, and Logstash {{stack-version}}.
When installing the {{stack}}, you must use the same version across the entire stack. For example, if you are using {{es}} {{version.stack}}, you install Beats {{version.stack}}, APM Server {{version.stack}}, {{es}} Hadoop {{version.stack}}, {{kib}} {{version.stack}}, and Logstash {{version.stack}}.

If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{stack-version}}.
If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{version.stack}}.
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ If you want your add-on to run a specific version of {{es}}, use the `--elastics

To find which {{es}} versions and plugins are currently available, you can omit the version to default to the latest one and add plugins later on from the [{{heroku}} console](https://cloud.elastic.co?page=docs&placement=docs-body). To use your own custom plugins, you can upload and select these plugins in the console as well.

For example: Install the add-on version {{stack-version}} and include the phonetic analysis plugin for MY_APP:
For example: Install the add-on version {{version.stack}} and include the phonetic analysis plugin for MY_APP:

```bash subs=true
heroku addons:create foundelasticsearch --elasticsearch-version {{stack-version}} --plugins analysis-phonetic --app MY_APP
heroku addons:create foundelasticsearch --elasticsearch-version {{version.stack}} --plugins analysis-phonetic --app MY_APP
```

After the add-on gets added, you can perform future version upgrades and plugin changes through the [console](heroku-getting-started-accessing.md).
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/self-managed/_snippets/wolfi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ To use the Wolfi image, append `-wolfi` to the image tag in the Docker command.
For example:

```sh subs=true
docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{stack-version}}
docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{version.stack}}
```
6 changes: 3 additions & 3 deletions deploy-manage/deploy/self-managed/air-gapped-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,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:{{stack-version}}"
EPR_IMAGE="docker.elastic.co/package-registry/distribution:{{version.stack}}"

podman create \
--name "elastic-epr" \
Expand Down Expand Up @@ -149,7 +149,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:{{stack-version}}
-e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution:{{version.stack}}
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
Expand Down Expand Up @@ -178,7 +178,7 @@ The following example script downloads artifacts from the internet to be later s
#!/usr/bin/env bash
set -o nounset -o errexit -o pipefail

STACK_VERSION={{stack-version}}
STACK_VERSION={{version.stack}}
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"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
3. Pull the {{es}} Docker image.

```sh subs=true
docker pull docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
docker pull docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```

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.
Expand All @@ -44,13 +44,13 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes

```sh subs=true
wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```

The `cosign` command prints the check results and the signature payload in JSON format:

```sh subs=true
Verification for docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} --
Verification for docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} --
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
Expand All @@ -60,7 +60,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
5. Start an {{es}} container.

```sh subs=true
docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```

::::{tip}
Expand All @@ -71,7 +71,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:{{stack-version}}
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:{{version.stack}}
```

The command prints the `elastic` user password and an enrollment token for {{kib}}.
Expand Down Expand Up @@ -114,7 +114,7 @@ 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.

```sh subs=true
docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```

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.
Expand All @@ -128,20 +128,20 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
1. Pull the {{kib}} Docker image.

```sh subs=true
docker pull docker.elastic.co/kibana/kibana:{{stack-version}}
docker pull docker.elastic.co/kibana/kibana:{{version.stack}}
```

2. Optional: Verify the {{kib}} image’s signature.

```sh subs=true
wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{stack-version}}
cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{version.stack}}
```

3. Start a {{kib}} container.

```sh subs=true
docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{stack-version}}
docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{version.stack}}
```

4. When {{kib}} starts, it outputs a unique generated link to the terminal. To access {{kib}}, open this link in a web browser.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com
```txt subs=true
...
# Version of Elastic products
STACK_VERSION={{stack-version}}
STACK_VERSION={{version.stack}}
...
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For example:
```sh subs=true
docker run -it --rm \
-v full_path_to/config:/usr/share/elasticsearch/config \
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} \
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} \
bin/elasticsearch-keystore create -p
```

Expand All @@ -75,7 +75,7 @@ You can also use a `docker run` command to add or update secure settings in the
```sh subs=true
docker run -it --rm \
-v full_path_to/config:/usr/share/elasticsearch/config \
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} \
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} \
bin/elasticsearch-keystore \
add my.secure.setting \
my.other.secure.setting
Expand All @@ -94,7 +94,7 @@ 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:

```sh subs=true
FROM docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
FROM docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Increased ulimits for [nofile](setting-system-settings.md) and [nproc](/deploy-m
To check the Docker daemon defaults for ulimits, run:

```sh subs=true
docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} /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:
Expand Down Expand Up @@ -167,7 +167,7 @@ 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.

```sh subs=true
docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="<token>" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="<token>" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```

The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend using `ES_JAVA_OPTS` in production.
Expand All @@ -178,7 +178,7 @@ 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:

```sh subs=true
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ Download and install the archive for Linux or MacOS.

### Linux [install-linux]

The Linux archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
The Linux archive for {{es}} {{version.stack}} can be downloaded and installed as follows:

```sh subs=true
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-linux-x86_64.tar.gz
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-linux-x86_64.tar.gz.sha512
shasum -a 512 -c elasticsearch-{{stack-version}}-linux-x86_64.tar.gz.sha512 <1>
tar -xzf elasticsearch-{{stack-version}}-linux-x86_64.tar.gz
cd elasticsearch-{{stack-version}}/ <2>
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
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-<version>-linux-x86_64.tar.gz: OK`.
Expand All @@ -60,13 +60,13 @@ cd elasticsearch-{{stack-version}}/ <2>

### MacOS [install-macos]

The MacOS archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
The MacOS archive for {{es}} {{version.stack}} can be downloaded and installed as follows:

```sh subs=true
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
tar -xzf elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
cd elasticsearch-{{stack-version}}/ <2>
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-<version>-darwin-x86_64.tar.gz: OK`.
Expand All @@ -75,7 +75,7 @@ cd elasticsearch-{{stack-version}}/ <2>
::::{admonition} macOS Gatekeeper warnings
:class: important

Apple’s rollout of stricter notarization requirements affected the notarization of the {{stack-version}} {{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.
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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ You have several options for installing the {{es}} Debian package:

* [From the APT repository](#deb-repo)
* [Manually](#install-deb)

### Install from the APT repository [deb-repo]

1. You may need to install the `apt-transport-https` package on Debian before proceeding:
Expand Down Expand Up @@ -99,13 +99,13 @@ 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}} {{stack-version}} can be downloaded from the website and installed as follows:
The Debian package for {{es}} {{version.stack}} can be downloaded from the website and installed as follows:

```sh subs=true
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-amd64.deb
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-amd64.deb.sha512
shasum -a 512 -c elasticsearch-{{stack-version}}-amd64.deb.sha512 <1>
sudo dpkg -i elasticsearch-{{stack-version}}-amd64.deb
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-<version>-amd64.deb: OK`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ sudo zypper modifyrepo --enable elasticsearch && \

### Download and install the RPM manually [install-rpm]

1. Download and install the RPM for {{es}} {{stack-version}} with the following commands:
1. Download and install the RPM for {{es}} {{version.stack}} with the following commands:

```sh subs=true
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-x86_64.rpm
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-x86_64.rpm.sha512
shasum -a 512 -c elasticsearch-{{stack-version}}-x86_64.rpm.sha512 <1>
sudo rpm --install elasticsearch-{{stack-version}}-x86_64.rpm
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-<version>-x86_64.rpm: OK`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ On Windows, the {{es}} {{ml}} feature requires the Microsoft Universal C Runtime
## Step 1: Download and install the `.zip` package [install-windows]

% link url manually set
Download the `.zip` archive for {{es}} {{stack-version}} from: [https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-windows-x86_64.zip](https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-9.0.0-windows-x86_64.zip)
Download the `.zip` archive for {{es}} {{version.stack}} from: <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>`, which we will refer to as `%ES_HOME%`. In a terminal window, `cd` to the `%ES_HOME%` directory, for instance:

```sh subs=true
cd C:\Program Files\elasticsearch-{{stack-version}}
cd C:\Program Files\elasticsearch-{{version.stack}}
```

## Step 2: Enable automatic creation of system indices [windows-enable-indices]
Expand Down
Loading
Loading