Skip to content

Commit 187c925

Browse files
authored
Doc: Update installation info (#17532)
1 parent 8e6e183 commit 187c925

File tree

3 files changed

+101
-8
lines changed

3 files changed

+101
-8
lines changed

Diff for: docs/docset.yml

+3
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,6 @@ subs:
4141
ilm-init: "ILM"
4242
dlm: "data lifecycle management"
4343
dlm-init: "DLM"
44+
stack-version: "9.0.0"
45+
major-version: "9.0"
46+
docker-repo: "docker.elastic.co/logstash/logstash"

Diff for: docs/reference/docker.md

+30-6
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,43 @@ These images are free to use under the Elastic license. They contain open source
1313

1414
## Pulling the image [_pulling_the_image]
1515

16-
Obtaining Logstash for Docker is as simple as issuing a `docker pull` command against the Elastic Docker registry.
16+
Obtaining Logstash for Docker is as simple as issuing a `docker
17+
pull` command against the Elastic Docker registry.
1718

18-
However, version 9.0.0 of Logstash has not yet been released, so no Docker image is currently available for this version.
19+
20+
```sh subs=true
21+
docker pull {{docker-repo}}:{{stack-version}}
22+
```
23+
24+
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).
1927

2028

2129
## Verifying the image [_verifying_the_image]
2230

23-
Although it’s optional, we highly recommend verifying the signatures included with your downloaded Docker images to ensure that the images are valid.
31+
Although it's optional, we highly recommend verifying the signatures included with your downloaded Docker images to ensure that the images are valid.
32+
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.
35+
Install the appropriate Cosign application for your operating system.
2436

25-
Elastic images are signed with [Cosign](https://docs.sigstore.dev/quickstart/quickstart-cosign/) which is part of the [Sigstore](https://www.sigstore.dev/) project. Cosign supports container signing, verification, and storage in an OCI registry. Install the appropriate Cosign application for your operating system.
37+
Run the following commands to verify the container image signature for {{ls}} v{{stack-version}}:
2638

27-
Run the following commands to verify the container image signature for {{ls}} v9.0.0-beta1:
39+
```sh subs=true
40+
wget https://artifacts.elastic.co/cosign.pub <1>
41+
cosign verify --key cosign.pub {{docker-repo}}:{{stack-version}} <2>
42+
```
2843

29-
Version 9.0.0 of Logstash has not yet been released, so no Docker image is currently available for this version.
44+
1. Download the Elastic public key to verify container signature
45+
2. Verify the container against the Elastic public key
3046

47+
The command prints the check results and the signature payload in JSON format, for example:
3148

49+
```sh subs=true
50+
Verification for {{docker-repo}}:{{stack-version}} --
51+
The following checks were performed on each of these signatures:
52+
- The cosign claims were validated
53+
- Existence of the claims in the transparency log was verified offline
54+
- The signatures were verified against the specified public key
55+
```

Diff for: docs/reference/installing-logstash.md

+68-2
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,79 @@ For testing purposes, you may still run Logstash from the command line, but you
4747

4848
### APT [_apt]
4949

50-
Version 9.0.0 of Logstash has not yet been released.
50+
Download and install the Public Signing Key:
51+
52+
```
53+
wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo gpg --dearmor -o /usr/share/keyrings/elastic-keyring.gpg
54+
```
55+
56+
You may need to install the `apt-transport-https` package on Debian before proceeding:
57+
58+
```
59+
sudo apt-get install apt-transport-https
60+
```
61+
62+
Save the repository definition to /etc/apt/sources.list.d/elastic-{{major-version}}.list:
63+
64+
```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
66+
```
67+
68+
::::{warning}
69+
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.
71+
If you have added the `deb-src` entry, you will see an error like the following:
72+
73+
```
74+
Unable to find expected entry 'main/source/Sources' in Release file (Wrong sources.list entry or malformed file)
75+
```
76+
77+
Just delete the `deb-src` entry from the `/etc/apt/sources.list` file and the
78+
installation should work as expected.
79+
::::
80+
81+
Run `sudo apt-get update` and the repository is ready for use. You can install
82+
it with:
83+
84+
```sh subs=true
85+
sudo apt-get update && sudo apt-get install logstash
86+
```
87+
88+
Check out [Running Logstash](running-logstash.md) for details about managing Logstash as a system service.
5189

5290

5391
### YUM [_yum]
5492

55-
Version 9.0.0 of Logstash has not yet been released.
93+
Download and install the public signing key:
94+
95+
```sh
96+
sudo rpm --import https://artifacts.elastic.co/GPG-KEY-elasticsearch
97+
```
98+
99+
Add the following in your `/etc/yum.repos.d/` directory
100+
in a file with a `.repo` suffix, for example `logstash.repo`
101+
102+
```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
106+
gpgcheck=1
107+
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
108+
enabled=1
109+
autorefresh=1
110+
type=rpm-md
111+
```
112+
And your repository is ready for use. You can install it with:
113+
114+
```sh
115+
sudo yum install logstash
116+
```
117+
118+
::::{warning}
119+
The repositories do not work with older rpm based distributions that still use RPM v3, like CentOS5.
120+
::::
56121

122+
Check out [Running Logstash](running-logstash.md) for managing Logstash as a system service.
57123

58124
### Docker [_docker]
59125

0 commit comments

Comments
 (0)