Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.8] [Docs] Add instructions to verify Docker install images (#15058) #15064

Merged
merged 1 commit into from May 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/static/docker.asciidoc
Expand Up @@ -39,6 +39,45 @@ https://www.docker.elastic.co[www.docker.elastic.co].

endif::[]

==== Verifying the image

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

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

Run the following commands to verify the container image signature for {ls} v{version}:

ifeval::["{release-state}"=="unreleased"]

Version {logstash_version} of Logstash has not yet been
released, so no Docker image is currently available for this version.

endif::[]

ifeval::["{release-state}"!="unreleased"]

["source","sh",subs="attributes"]
--------------------------------------------
wget https://artifacts.elastic.co/cosign.pub <1>
cosign verify --key cosign.pub {docker-image} <2>
--------------------------------------------
<1> Download the Elastic public key to verify container signature
<2> Verify the container against the Elastic public key

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

["source","sh",subs="attributes"]
--------------------------------------------
Verification for {docker-image} --
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
--------------------------------------------

endif::[]

[[docker-config]]
=== Configuring Logstash for Docker

Expand Down