Updating to address peer review feedback

Author: yetanothertw

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:<specific.version>
+docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:<SPECIFIC.VERSION.NUMBER>
 ```
-You can download and install a specific version of the {{version.stack.base | M }} stack by replacing `<specific.version>` with the version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+You can download and install a specific version of the {{stack}} by replacing `<SPECIFIC.VERSION.NUMBER>` with the version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 :::
 
 ::::

deploy-manage/deploy/self-managed/air-gapped-install.md

@@ -119,15 +119,15 @@ podman create \
 :::
 
 :::{tab-item} Specific version
-Replace `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{stack}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` 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:<specific.version>"
+EPR_IMAGE="docker.elastic.co/package-registry/distribution:<SPECIFIC.VERSION.NUMBER>"
 
 podman create \
   --name "elastic-epr" \
@@ -196,7 +196,7 @@ WantedBy=default.target
 :::
 
 ::::::{tab-item} Specific version
-Replace `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{stack}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` 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:<specific.version>
+  -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution:<SPECIFIC.VERSION.NUMBER>
 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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{stack}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
 #!/usr/bin/env bash
 set -o nounset -o errexit -o pipefail
 
-STACK_VERSION=<specific.version>
+STACK_VERSION=<SPECIFIC.VERSION.NUMBER>
 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"}

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Replace `<SPECIFIC.VERSION.NUMBER>` with the {{stack}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
     ```sh subs=true
-    docker pull docker.elastic.co/elasticsearch/elasticsearch:<specific.version>
+    docker pull docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
     ```
     :::
 
@@ -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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` 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:<specific.version>
+    cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
     ```
 
     The `cosign` command prints the check results and the signature payload in JSON format:
 
     ```sh subs=true
-    Verification for docker.elastic.co/elasticsearch/elasticsearch:<specific.version> --
+    Verification for docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER> --
     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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` with it.
     ```sh subs=true
-    docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:<specific.version>
+    docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
     ```
 
     ::::{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:<specific.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:<SPECIFIC.VERSION.NUMBER>
     ```
 
     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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` with it.
     ```sh subs=true
-    docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:<specific.version>
+    docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
     ```
     :::
     ::::
@@ -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 `<specific.version>` with the {{kib}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` with it.
     ```sh subs=true
-    docker pull docker.elastic.co/kibana/kibana:<specific.version>
+    docker pull docker.elastic.co/kibana/kibana:<SPECIFIC.VERSION.NUMBER>
     ```
     :::
     ::::
@@ -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 `<specific.version>` with the {{kib}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` with it.
     ```sh subs=true
     wget https://artifacts.elastic.co/cosign.pub
-    cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:<specific.version>
+    cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:<SPECIFIC.VERSION.NUMBER>
     ```
     :::
     ::::
@@ -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 `<specific.version>` with the {{kib}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Use the same {{stack}} version number as the Docker image you pulled earlier and replace `<SPECIFIC.VERSION.NUMBER>` with it.
      ```sh subs=true
-    docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:<specific.version>
+    docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:<SPECIFIC.VERSION.NUMBER>
     ```
     :::
     ::::

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+    Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
     ```txt subs=true
     ...
     # Version of Elastic products
-    STACK_VERSION=<specific.version>
+    STACK_VERSION=<SPECIFIC.VERSION.NUMBER>
     ...
     :::
     ::::

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` 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:<specific.version> \
+docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER> \
 bin/elasticsearch-keystore create -p
 ```
 :::
@@ -105,11 +105,11 @@ my.other.secure.setting
 
 :::{tab-item} Specific version
 :sync: specific
-Replace `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` 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:<specific.version> \
+docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER> \
 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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-FROM docker.elastic.co/elasticsearch/elasticsearch:<specific.version>
+FROM docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
 COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
 ```
 :::

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-docker run --rm docker.elastic.co/elasticsearch/elasticsearch:<specific.version> /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
+docker run --rm docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER> /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="<token>" --name
 
 :::{tab-item} Specific version
 :sync: specific
-Replace `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```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:<specific.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:<SPECIFIC.VERSION.NUMBER>
 ```
 :::
 ::::
@@ -216,9 +216,9 @@ docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
 
 :::{tab-item} Specific version
 :sync: specific
-Replace `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-docker.elastic.co/elasticsearch/elasticsearch:<specific.version>
+docker.elastic.co/elasticsearch/elasticsearch:<SPECIFIC.VERSION.NUMBER>
 ```
 :::
 ::::

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-linux-x86_64.tar.gz
-wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-linux-x86_64.tar.gz.sha512
-shasum -a 512 -c elasticsearch-<specific.version>-linux-x86_64.tar.gz.sha512 <1>
-tar -xzf elasticsearch-<specific.version>-linux-x86_64.tar.gz
-cd elasticsearch-<specific.version>/ <2>
+wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-linux-x86_64.tar.gz
+wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-linux-x86_64.tar.gz.sha512
+shasum -a 512 -c elasticsearch-<SPECIFIC.VERSION.NUMBER>-linux-x86_64.tar.gz.sha512 <1>
+tar -xzf elasticsearch-<SPECIFIC.VERSION.NUMBER>-linux-x86_64.tar.gz
+cd elasticsearch-<SPECIFIC.VERSION.NUMBER>/ <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`.
+1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<SPECIFIC.VERSION.NUMBER>-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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-darwin-x86_64.tar.gz
-curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
-tar -xzf elasticsearch-<specific.version>-darwin-x86_64.tar.gz
-cd elasticsearch-<specific.version>/ <2>
+curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-darwin-x86_64.tar.gz
+curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
+tar -xzf elasticsearch-<SPECIFIC.VERSION.NUMBER>-darwin-x86_64.tar.gz
+cd elasticsearch-<SPECIFIC.VERSION.NUMBER>/ <2>
 ```
-1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<specific-version>-darwin-x86_64.tar.gz: OK`.
+1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<SPECIFIC.VERSION.NUMBER>-darwin-x86_64.tar.gz: OK`.
 2. This directory is known as `$ES_HOME`.
 :::
 :::

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 `<specific.version>` with the {{es}} version number you want. For example, you can replace `<specific.version>` with {{version.stack.base}}.
+Replace `<SPECIFIC.VERSION.NUMBER>` with the {{es}} version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
 ```sh subs=true
-wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-amd64.deb
-wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<specific.version>-amd64.deb.sha512
-shasum -a 512 -c elasticsearch-<specific.version>-amd64.deb.sha512 <1>
-sudo dpkg -i elasticsearch-<specific.version>-amd64.deb
+wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-amd64.deb
+wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<SPECIFIC.VERSION.NUMBER>-amd64.deb.sha512
+shasum -a 512 -c elasticsearch-<SPECIFIC.VERSION.NUMBER>-amd64.deb.sha512 <1>
+sudo dpkg -i elasticsearch-<SPECIFIC.VERSION.NUMBER>-amd64.deb
 ```
-1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch-<specific-version>-amd64.deb: OK`.
+1. Compares the SHA of the downloaded Debian package and the published checksum, which should output `elasticsearch-<SPECIFIC.VERSION.NUMBER>-amd64.deb: OK`.
 :::
 ::::