diff --git a/_dashboards/maps.md b/_dashboards/maps/maps.md similarity index 98% rename from _dashboards/maps.md rename to _dashboards/maps/maps.md index 809f5f55f3..746686dfef 100644 --- a/_dashboards/maps.md +++ b/_dashboards/maps/maps.md @@ -1,10 +1,12 @@ --- layout: default -title: Maps -nav_order: 15 +title: Creating maps in OpenSearch Dashboards +nav_order: 70 +redirect_from: + - /dashboards/maps/ --- -# Maps +# Creating maps in OpenSearch Dashboards With OpenSearch Dashboards, you can create maps to visualize your geographical data. OpenSearch lets you construct map visualizations with multiple layers, combining data across different indexes. You can build each layer from a different index pattern. Additionally, you can configure maps to show specific data at different zoom levels. OpenSearch maps are powered by the OpenSearch maps service, which uses vector tiles to render maps. diff --git a/_dashboards/maps/maptiles.md b/_dashboards/maps/maptiles.md new file mode 100644 index 0000000000..cd77b5452b --- /dev/null +++ b/_dashboards/maps/maptiles.md @@ -0,0 +1,40 @@ +--- +layout: default +title: Using Web Map Service +parent: Creating maps in OpenSearch Dashboards +nav_order: 10 +redirect_from: + - /docs/opensearch-dashboards/maptiles/ +--- + +{%- comment -%}The `/docs/opensearch-dashboards/maptiles/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%} + +# Using Web Map Service + +OpenSearch supports [Web Map Service (WMS)](https://www.ogc.org/standards/wms). WMS is necessary for customizing region and coordinate maps in OpenSearch Dashboards. + +To add a WMS custom map, perform the following steps: + +1. On the top menu bar, go to **OpenSearch Plugins > Maps**. +1. Select **Create map**. You can now see the default OpenSearch basemap. +1. In the **Layers** panel, select **Add layer**. +1. In the **Custom type** dropdown list, select **Web Map Service (WMS)**. +1. In the Data tab, enter data for the required fields: + - WMS URL + - WMS layers + - WMS version + - WMS format +1. (Optional) Enter data for the optional fields: + - WMS CRS + - WMS box + - WMS attribution + - WMS styles +1. Select the **Settings** tab to edit the layer settings. +1. Enter the layer name in Name. +1. (Optional) Enter the layer description in Description. +1. (Optional) Select the zoom levels and opacity for this layer. +1. Select **Update**. + +## Related links + +- [Using region maps](dashboards/visualize/geojson-regionmaps/) \ No newline at end of file diff --git a/_dashboards/selfhost-maps-server.md b/_dashboards/maps/selfhost-maps-server.md similarity index 91% rename from _dashboards/selfhost-maps-server.md rename to _dashboards/maps/selfhost-maps-server.md index fd0b8f5796..ddd7b71a5f 100644 --- a/_dashboards/selfhost-maps-server.md +++ b/_dashboards/maps/selfhost-maps-server.md @@ -1,10 +1,13 @@ --- layout: default -title: Self-host maps server -nav_order: 30 +title: Using the self-host maps server +parent: Creating maps in OpenSearch Dashboards +nav_order: 20 +redirect_from: + - /docs/opensearch-dashboards/selfhost-maps-server/ --- -# Self-host maps server +# Using the self-host maps server The self-host maps server for OpenSearch Dashboards allows users to access the default maps service in air-gapped environments. OpenSearch-compatible map URLs include a map manifest with map tiles and vectors, the map tiles, and the map vectors. @@ -13,13 +16,13 @@ The following sections provide steps for setting up and using the self-host maps You can access the `maps-server` image via the official OpenSearch [Docker Hub repository](https://hub.docker.com/u/opensearchproject). {: .note} -## Pull Docker image +## Pulling the Docker image Open your terminal and run the following command: `docker pull opensearch/opensearch-maps-server` -## Set up the server +## Setting up the server You must set up the map tiles before running the server. You have two setup options: Use the OpenSearch-provided maps service tiles set, or generate the raster tiles set. @@ -49,7 +52,7 @@ docker run \ To generate the raster tiles set, use the [raster tile generation pipeline](https://github.com/opensearch-project/maps/tree/main/tiles-generation/cdk) and then use the tiles set absolute path to create a volume to start the server. -## Start the server +## Starting the server Use the following command to start the server using the Docker volume `tiles-data`. The following command is an example using host URL "localhost" and port "8080": @@ -80,7 +83,7 @@ Confirm the server is running by opening each of the following links in a browse * Map tiles URL: `http://localhost:8080/tiles/data/{z}/{x}/{y}.png` * Map tiles demo URL: `http://localhost:8080/` -## Use the self-host maps server with OpenSearch Dashboards +## Using the self-host maps server with OpenSearch Dashboards You can use the self-host maps server with OpenSearch Dashboards by either adding the parameter to `opensearch_dashboards.yml` or configuring the default WMS properties in OpenSearch Dashboards. @@ -99,8 +102,3 @@ Configure the manifest URL in `opensearch_dashboards.yml`: ## Licenses Tiles are generated per [Terms of Use for Natural Earth vector map data](https://www.naturalearthdata.com/about/terms-of-use/) and [Copyright and License for OpenStreetMap](https://www.openstreetmap.org/copyright). - -## Related links - -* [Configure WMS map server]({{site.url}}{{site.baseurl}}/dashboards/maptiles/) -* [Region map visualizations]({{site.url}}{{site.baseurl}}/dashboards/geojson-regionmaps/) \ No newline at end of file diff --git a/_dashboards/maptiles.md b/_dashboards/maptiles.md deleted file mode 100644 index 0be3a13c35..0000000000 --- a/_dashboards/maptiles.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: WMS map server -nav_order: 20 -redirect_from: - - /docs/opensearch-dashboards/maptiles/ ---- - -{%- comment -%}The `/docs/opensearch-dashboards/maptiles/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%} - -# Configure WMS map server - -OpenSearch Dashboards includes default map tiles, but if you need more specialized maps, you can configure OpenSearch Dashboards to use a WMS map server: - -1. Open OpenSearch Dashboards at `https://:`. For example, [https://localhost:5601](https://localhost:5601). -1. If necessary, log in. -1. Choose **Management** and **Advanced Settings**. -1. Locate `visualization:tileMap:WMSdefaults`. -1. Change `enabled` to true and add the URL of a valid WMS map server: - - ```json - { - "enabled": true, - "url": "", - "options": { - "format": "image/png", - "transparent": true - } - } - ``` - -Map services often have licensing fees or restrictions. You're responsible for all such considerations on any map server that you specify. -{: .note }