Skip to content

Commit 8820218

Browse files
use centrally maintained version variables (elastic#17857)
1 parent f1823d8 commit 8820218

File tree

6 files changed

+23
-26
lines changed

6 files changed

+23
-26
lines changed

docs/docset.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ toc:
1414
- toc: release-notes
1515
- toc: extend
1616
subs:
17-
version: "9.0.0"
1817
logstash-ref: "https://www.elastic.co/guide/en/logstash/current"
1918
ecloud: "Elastic Cloud"
2019
ech: "Elastic Cloud Hosted"
@@ -45,8 +44,6 @@ subs:
4544
ilm-init: "ILM"
4645
dlm: "data lifecycle management"
4746
dlm-init: "DLM"
48-
stack-version: "9.0.0"
49-
major-version: "9.x"
5047
docker-repo: "docker.elastic.co/logstash/logstash"
5148
ess-leadin-short: "Elastic Cloud Hosted is available on AWS, GCP, and Azure, and you can try it for free at https://cloud.elastic.co/registration."
5249
ess-leadin: "You can run Elasticsearch on your own hardware or use Elastic Cloud Hosted, available on AWS, GCP, and Azure. Try Elastic Cloud Hosted for free: https://cloud.elastic.co/registration."

docs/reference/docker.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,27 @@ pull` command against the Elastic Docker registry.
1818

1919

2020
```sh subs=true
21-
docker pull {{docker-repo}}:{{stack-version}}
21+
docker pull {{docker-repo}}:{{version.stack}}
2222
```
2323

2424
Alternatively, you can download other Docker images that contain only features
25-
available under the Apache 2.0 license. To download the images, go to
26-
[www.docker.elastic.co](https://www.docker.elastic.co).
25+
available under the Apache 2.0 license. To download the images, go to
26+
[www.docker.elastic.co](https://www.docker.elastic.co).
2727

2828

2929
## Verifying the image [_verifying_the_image]
3030

3131
Although it's optional, we highly recommend verifying the signatures included with your downloaded Docker images to ensure that the images are valid.
3232

33-
Elastic images are signed with [Cosign](https://docs.sigstore.dev/cosign/) which is part of the [Sigstore](https://www.sigstore.dev/) project.
34-
Cosign supports container signing, verification, and storage in an OCI registry.
33+
Elastic images are signed with [Cosign](https://docs.sigstore.dev/cosign/) which is part of the [Sigstore](https://www.sigstore.dev/) project.
34+
Cosign supports container signing, verification, and storage in an OCI registry.
3535
Install the appropriate Cosign application for your operating system.
3636

37-
Run the following commands to verify the container image signature for {{ls}} v{{stack-version}}:
37+
Run the following commands to verify the container image signature for {{ls}} v{{version.stack}}:
3838

3939
```sh subs=true
4040
wget https://artifacts.elastic.co/cosign.pub <1>
41-
cosign verify --key cosign.pub {{docker-repo}}:{{stack-version}} <2>
41+
cosign verify --key cosign.pub {{docker-repo}}:{{version.stack}} <2>
4242
```
4343

4444
1. Download the Elastic public key to verify container signature
@@ -47,7 +47,7 @@ cosign verify --key cosign.pub {{docker-repo}}:{{stack-version}} <2>
4747
The command prints the check results and the signature payload in JSON format, for example:
4848

4949
```sh subs=true
50-
Verification for {{docker-repo}}:{{stack-version}} --
50+
Verification for {{docker-repo}}:{{version.stack}} --
5151
The following checks were performed on each of these signatures:
5252
- The cosign claims were validated
5353
- Existence of the claims in the transparency log was verified offline

docs/reference/first-event.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ The location of the `bin` directory varies by platform. See [Directory layout](/
3737
::::{admonition} macOS Gatekeeper warnings
3838
:class: important
3939

40-
Apple’s rollout of stricter notarization requirements affected the notarization of {{version}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
40+
Apple’s rollout of stricter notarization requirements affected the notarization of {{version.stack}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
4141

4242
```sh
4343
xattr -d -r com.apple.quarantine <archive-or-directory>
4444
```
4545

46-
For example, if the `.tar.gz` file was extracted to the default logstash-{{version}} directory, the command is:
46+
For example, if the `.tar.gz` file was extracted to the default logstash-{{version.stack}} directory, the command is:
4747

4848
```sh subs=true
49-
xattr -d -r com.apple.quarantine logstash-{{version}}
49+
xattr -d -r com.apple.quarantine logstash-{{version.stack}}
5050
```
5151

5252
Alternatively, you can add a security override if a Gatekeeper popup appears by following the instructions in the *How 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).

docs/reference/installing-logstash.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ You may need to install the `apt-transport-https` package on Debian before proce
5959
sudo apt-get install apt-transport-https
6060
```
6161

62-
Save the repository definition to /etc/apt/sources.list.d/elastic-{{major-version}}.list:
62+
Save the repository definition to /etc/apt/sources.list.d/elastic-{{version.stack | M.x}}.list:
6363

6464
```sh subs=true
65-
echo "deb [signed-by=/usr/share/keyrings/elastic-keyring.gpg] https://artifacts.elastic.co/packages/{{major-version}}/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-{{major-version}}.list
65+
echo "deb [signed-by=/usr/share/keyrings/elastic-keyring.gpg] https://artifacts.elastic.co/packages/{{version.stack | M.x}}/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-{{version.stack | M.x}}.list
6666
```
6767

6868
::::{warning}
6969
Use the `echo` method described above to add the Logstash repository.
70-
Do not use `add-apt-repository` as it will add a `deb-src` entry as well, but we do not provide a source package.
70+
Do not use `add-apt-repository` as it will add a `deb-src` entry as well, but we do not provide a source package.
7171
If you have added the `deb-src` entry, you will see an error like the following:
7272

7373
```
@@ -100,9 +100,9 @@ Add the following in your `/etc/yum.repos.d/` directory
100100
in a file with a `.repo` suffix, for example `logstash.repo`
101101

102102
```sh subs=true
103-
[logstash-{{major-version}}]
104-
name=Elastic repository for {{major-version}} packages
105-
baseurl=https://artifacts.elastic.co/packages/{{major-version}}/yum
103+
[logstash-{{version.stack | M.x}}]
104+
name=Elastic repository for {{version.stack | M.x}} packages
105+
baseurl=https://artifacts.elastic.co/packages/{{version.stack | M.x}}/yum
106106
gpgcheck=1
107107
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
108108
enabled=1

docs/reference/running-logstash-command-line.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ mapped_pages:
88
::::{admonition} macOS Gatekeeper warnings
99
:class: important
1010

11-
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
11+
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version.stack}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
1212

1313
```sh
1414
xattr -d -r com.apple.quarantine <archive-or-directory>
1515
```
1616

17-
For example, if the `.tar.gz` file was extracted to the default logstash-{{version}} directory, the command is:
17+
For example, if the `.tar.gz` file was extracted to the default logstash-{{version.stack}} directory, the command is:
1818

1919
```sh subs=true
20-
xattr -d -r com.apple.quarantine logstash-{{version}}
20+
xattr -d -r com.apple.quarantine logstash-{{version.stack}}
2121
```
2222

2323
Alternatively, you can add a security override if a Gatekeeper popup appears by following the instructions in the *How 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).

docs/reference/working-with-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ mapped_pages:
88
::::{admonition} macOS Gatekeeper warnings
99
:class: important
1010

11-
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}}, you need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
11+
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version.stack}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}}, you need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
1212

1313
```sh
1414
xattr -d -r com.apple.quarantine <archive-or-directory>
1515
```
1616

17-
For example, if the `.tar.gz` file was extracted to the default logstash-{{version}} directory, the command is:
17+
For example, if the `.tar.gz` file was extracted to the default logstash-{{version.stack}} directory, the command is:
1818

1919
```sh subs=true
20-
xattr -d -r com.apple.quarantine logstash-{{version}}
20+
xattr -d -r com.apple.quarantine logstash-{{version.stack}}
2121
```
2222

2323
Alternatively, you can add a security override if a Gatekeeper popup appears by following the instructions in the *How 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).

0 commit comments

Comments
 (0)