Skip to content

Commit

Permalink
[Docs][Maps] Update EMS Server instructions (#195419)
Browse files Browse the repository at this point in the history
## Summary

Small improvements to the Elastic Maps Service documentation:

* fixes the reference to the Docker image to pull
* adds details about using `cosign` to verify the image pulled 
* updates the screenshot to a more recent UI.
  • Loading branch information
jsanz authored Oct 10, 2024
1 parent 7a53d81 commit ad8cec1
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 14 deletions.
45 changes: 31 additions & 14 deletions docs/maps/connect-to-ems.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:ems: Elastic Maps Service
:ems-docker-repo: docker.elastic.co/elastic-maps-service/elastic-maps-server
:ems-docker-image: {ems-docker-repo}:{version}-amd64
:ems-docker-image: {ems-docker-repo}:{version}
:ems-headers-url: https://deployment-host

[[maps-connect-to-ems]]
Expand Down Expand Up @@ -81,34 +81,53 @@ If you cannot connect to {ems} from the {kib} server or browser clients, and you

{hosted-ems} is a self-managed version of {ems} offered as a Docker image that provides both the EMS basemaps and EMS boundaries. The image is bundled with basemaps up to zoom level 8. After connecting it to your {es} cluster for license validation, you have the option to download and configure a more detailed basemaps database.

You can use +docker pull+ to download the {hosted-ems} image from the Elastic Docker registry.

. Pull the {hosted-ems} Docker image.
+
ifeval::["{release-state}"=="unreleased"]
Version {version} of {hosted-ems} has not yet been released, so no Docker image is currently available for this version.
WARNING: Version {version} of {hosted-ems} has not yet been released.
No Docker image is currently available for this version.
endif::[]

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

+
["source","bash",subs="attributes"]
----------------------------------
docker pull {ems-docker-image}
----------------------------------

Start {hosted-ems} and expose the default port `8080`:
. Optional: Install
https://docs.sigstore.dev/system_config/installation/[Cosign] for your
environment. Then use Cosign to verify the {es} image's signature.
+
[source,sh,subs="attributes"]
----
wget https://artifacts.elastic.co/cosign.pub
cosign verify --key cosign.pub {ems-docker-image}
----
+
The `cosign` command prints the check results and the signature payload in JSON format:
+
[source,sh,subs="attributes"]
--------------------------------------------
Verification for {ems-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
--------------------------------------------


. Start {hosted-ems} and expose the default port `8080`:
+
["source","bash",subs="attributes"]
----------------------------------
docker run --rm --init --publish 8080:8080 \
{ems-docker-image}
----------------------------------

+
Once {hosted-ems} is running, follow instructions from the webpage at `localhost:8080` to define a configuration file and optionally download a more detailed basemaps database.

+
[role="screenshot"]
image::images/elastic-maps-server-instructions.png[Set-up instructions]

endif::[]

[float]
[[elastic-maps-server-configuration]]
==== Configuration
Expand Down Expand Up @@ -193,7 +212,6 @@ One way to configure {hosted-ems} is to provide `elastic-maps-server.yml` via bi

["source","yaml",subs="attributes"]
--------------------------------------------
version: '2'
services:
ems-server:
image: {ems-docker-image}
Expand All @@ -212,7 +230,6 @@ These variables can be set with +docker-compose+ like this:

["source","yaml",subs="attributes"]
----------------------------------------------------------
version: '2'
services:
ems-server:
image: {ems-docker-image}
Expand Down
Binary file modified docs/maps/images/elastic-maps-server-instructions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad8cec1

Please sign in to comment.