[DOC] Restructures Dashboards TOC (#2628)

* Organize Dashboards TOC in logical order; copy edits for spelling and style guide compliance

Signed-off-by: vagimeli <vagimeli@amazon.com>
This commit is contained in:
Melissa Vagi 2023-02-06 14:20:14 -07:00 committed by GitHub
parent 45834d6f78
commit 65111760b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 98 additions and 108 deletions

View File

@ -1,7 +1,7 @@
---
layout: default
title: Index and snapshot management in OpenSearch Dashboards
nav_order: 15
nav_order: 80
has_children: true
redirect_from:
- /dashboards/admin-ui-index/

View File

@ -1,10 +1,10 @@
---
layout: default
title: Custom branding
nav_order: 200
title: Customizing your branding
nav_order: 15
---
# OpenSearch Dashboards custom branding
# Customizing your branding
Introduced 1.2
{: .label .label-purple }

View File

@ -1,11 +1,11 @@
---
layout: default
title: Exploring data with Discover
title: Exploring data
nav_order: 20
has_children: true
---
# Exploring data with Discover
# Exploring data
**Discover** in OpenSearch Dashboards helps you extract insights and get value out of data assets across your organization. Discover enables you to:

View File

@ -1,9 +1,7 @@
---
layout: default
title: Using maps
nav_order: 15
parent: Visualization types
grand_parent: Visualize
title: Using the Maps plugin
nav_order: 60
redirect_from:
- /dashboards/maps/
---

View File

@ -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://<host>:<port>`. 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": "<wms-map-server-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 }

View File

@ -1,7 +1,7 @@
---
layout: default
title: Quickstart guide for OpenSearch Dashboards
nav_order: 20
nav_order: 10
has_children: false
redirect_from:
- /dashboards/index/
@ -12,11 +12,8 @@ redirect_from:
This quickstart guide covers the core concepts that you need to understand to get started with OpenSearch Dashboards. You'll learn how to:
- Add sample data.
- Explore and inspect data with **Discover**.
- Visualize data with **Dashboard**.
- Add sample data.
- Explore and inspect data with **Discover**.
- Visualize data with **Dashboard**.
- Explore and inspect data.
- Visualize data.
Before you get started, make sure you've installed OpenSearch and OpenSearch Dashboards. For information on installation and configuration, see [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/).
{: .note}
@ -114,6 +111,6 @@ Alternatively, you can apply filters using the dashboard toolbar:
# Next steps
- **Visualize data**. To learn more about data visualizations in OpenSearch Dashboards, see [**Building data visualizations with Visualize**]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/).
- **Create dashboards**. To learn more about creating dashboards in OpenSearch Dashboards, see [**Creating dashboards with Dashboard**]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/).
- **Explore data**. To learn more about exploring data in OpenSearch Dashboards, see [**Exploring data with Discover**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/).
- **Visualize data**. To learn more about data visualizations in OpenSearch Dashboards, see [**Building data visualizations**]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/).
- **Create dashboards**. To learn more about creating dashboards in OpenSearch Dashboards, see [**Creating dashboards**]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/).
- **Explore data**. To learn more about exploring data in OpenSearch Dashboards, see [**Exploring data**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/).

View File

@ -1,31 +1,31 @@
---
layout: default
title: Reporting
title: Creating reports with the Dashboards interface
nav_order: 70
---
# Reporting
# Creating reports with the Dashboards interface
You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [security plugin]({{site.url}}{{site.baseurl}}/security/access-control/users-roles#predefined-roles).
CSV reports have a non-configurable 10,000 row limit. They have no explicit size limit (e.g. in MB), but extremely large documents could cause report generation to fail with an out of memory error from the V8 JavaScript engine.
CSV reports have a non-configurable 10,000 row limit. They have no explicit size limit (for example, MB), but extremely large documents could cause report generation to fail with an out of memory error from the V8 JavaScript engine.
{: .tip }
## Generating reports with the interface
## Create reports from Discovery, Visualize, Dashboard, or Notebooks
To generate a report from the interface:
Quickly generate an on-demand report from the current view.
1. From the top menu bar, choose **Reporting**.
1. For dashboards, visualizations, or notebooks, choose **Download PDF** or **Download PNG**. If you're creating a report from the Discover page, choose **Generate CSV**.
1. From the navigation panel, choose **Reporting**.
2. For dashboards, visualizations, or notebooks, choose **Download PDF** or **Download PNG**. If you're creating a report from the Discover page, choose **Generate CSV**.
Reports generate asynchronously in the background and might take a few minutes, depending on the size of the report. A notification appears when your report is ready to download.
{: .label}
1. To create a schedule-based report, choose **Create report definition**. Then proceed to [Create reports using a definition](#create-reports-using-a-definition). This option pre-fills many of the fields for you based on the visualization, dashboard, or data you were viewing.
3. To create a schedule-based report, choose **Create report definition**. Then proceed to [Create reports using a definition](#create-reports-using-a-definition). This option pre-fills many of the fields for you based on the visualization, dashboard, or data you were viewing.
## Create reports using a definition
## Creating reports using a definition
Definitions let you generate reports on a periodic schedule.
@ -38,9 +38,9 @@ Definitions let you generate reports on a periodic schedule.
1. (Optional) Add a header or footer to the report. Headers and footers are only available for dashboard, visualization, and notebook reports.
1. Under **Report trigger**, choose either **On demand** or **Schedule**.
For scheduled reports, select either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval. Cron expressions give you even more flexiblity. See [Cron expression reference]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/cron/) for more information.
For scheduled reports, select either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval, and Cron expressions give you more flexibility. See [Cron expression reference]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/cron/) for more information.
1. Choose **Create**.
2. Choose **Create**.
## Troubleshooting

View File

@ -1,8 +1,7 @@
---
layout: default
title: Using area charts
parent: Visualization types
grand_parent: Visualize
parent: Building data visualizations
nav_order: 5
---

View File

@ -1,9 +1,8 @@
---
layout: default
title: Using Gantt charts
parent: Visualization types
grand_parent: Visualize
nav_order: 60
parent: Building data visualizations
nav_order: 30
redirect_from:
- /dashboards/gantt/
---

View File

@ -1,19 +1,23 @@
---
layout: default
title: Region map visualizations
nav_order: 40
title: Using coordinate and region maps
parent: Building data visualizations
has_children: true
nav_order: 15
redirect_from:
- /dashboards/geojson-regionmaps/
---
# Region map visualizations
# Using coordinate and region maps
OpenSearch Dashboards provides basic map tiles with a standard vector map that you can use to create your region map visualizations. You can configure the base map tiles using the Web Map Service (WMS) map server.
OpenSearch has a standard set of GeoJSON files that provide a vector map with each region map. OpenSearch Dashboards also provides basic map tiles with a standard vector map to create region maps. You can configure the base map tiles using [Web Map Service (WMS)](https://www.ogc.org/standards/wms). For more information, see [Configuring WMS in OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/maptiles/).
You can't configure a server to support user-defined vector map layers. However, you can configure your own GeoJSON file and upload it for this purpose.
For air gapped environments, OpenSearch Dashboards provides a self-host maps server. For more information, see [Using the self-host maps server]({{site.url}}{{site.baseurl}}/dashboards/selfhost-maps-server/)
While you can't configure a server to support user-defined vector map layers, you can configure your own GeoJSON file and upload it for this purpose.
{: .note}
OpenSearch also has a standard set of GeoJSON files to provide a vector map with your regional maps.
## Custom vector maps with GeoJSON
## Customizing vector maps with GeoJSON
If you have a specific locale that is not provided by OpenSearch Dashboards vector maps, such as a US county or US ZIP Code, you can create your own custom vector map with a GeoJSON file. To create a custom region map you would define a geographic shape such as a polygon with multiple coordinates. To learn more about the various geographic shapes that support a custom region map location, see [Geoshape field type]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-shape/).
@ -26,7 +30,7 @@ You can use [geojson.io](https://geojson.io/#map=2/20.0/0.0) to extract GeoJSON
> * OpenSearch Dashboards Maps [`dashboards-maps`](https://github.com/opensearch-project/dashboards-maps) front-end plugin
> * OpenSearch [`geospatial`](https://github.com/opensearch-project/geospatial) backend plugin
{: .note}
### Step 1: Create a region map visualization
### Step 1: Creating a region map visualization
To create your own custom vector map, upload a JSON file that contains GEO data for your customized regional maps. The JSON file contains vector layers for visualization.
@ -41,18 +45,18 @@ Enter **Map name prefix** (for example, `usa-counties`). Your map will have the
1. Select the **Import file** button.
Once the upload is successful, you will see a pop-up prompting you to refresh the map. Select the **Refresh** button. <img src="{{site.url}}{{site.baseurl}}/images/upload-success.png" alt="message upon a successful file upload" width="280"/>
### Step 2: View the custom region map in OpenSearch Dashboards
### Step 2: Viewing the custom region map in OpenSearch Dashboards
After you upload a custom GeoJSON file, you need to set the vector map layer to custom, and select your vector map:
1. From **Layer Options > Layer settings**, select **Custom vector map**.
1. Under **Vector map**, select the name of the vector map that you just uploaded.
1. *(Optional):* Under **Style settings**, increase **Border thickness** to see the borders more clearly.
1. Select the **Update** button.
1. View your region map in the Dashboards. For example, the following image shows the Los Angeles and San Diego county regions:
2. Optional: Under **Style settings**, increase **Border thickness** to see the borders more clearly.
3. Select the **Update** button.
4. View your region map in the Dashboards. For example, the following image shows the Los Angeles and San Diego county regions:
<img src="{{site.url}}{{site.baseurl}}/images/county-region-map.png" alt="view a custom GeoJSON region map" width="700"/>
### Example GeoJSON file
#### Example GeoJSON file
The following example GeoJSON file provides coordinates for two US counties.
@ -67,3 +71,4 @@ The following example GeoJSON file provides coordinates for two US counties.
}
```

View File

@ -0,0 +1,34 @@
---
layout: default
title: Configuring a Web Map Service (WMS)
grand_parent: Building data visualizations
parent: Using coordinate and region maps
nav_order: 5
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 -%}
# Configuring a Web Map Service (WMS)
The Open Geospatial Consortium (OGC) Web Map Service (WMS) specification is an international specification for requesting dynamic maps on the web. OpenSearch Dashboards includes default map tiles. For specialized maps, you can configure a WMS on OpenSearch Dashboards following these steps:
1. Log in to OpenSearch Dashboards at `https://<host>:<port>`. For example, you can connect to OpenSearch Dashboards by connecting to [https://localhost:5601](https://localhost:5601). The default username and password are `admin`.
2. Choose **Management** > **Advanced Settings**.
3. Locate `visualization:tileMap:WMSdefaults`.
4. Change `enabled` to `true` and add the URL of a valid WMS server, as shown in the following example:
```json
{
"enabled": true,
"url": "<wms-map-server-url>",
"options": {
"format": "image/png",
"transparent": true
}
}
```
Web map services may have licensing fees or restrictions, and you are responsible for complying with any such fees or restrictions.
{: .note }

View File

@ -1,10 +1,12 @@
---
layout: default
title: Self-host maps server
nav_order: 30
title: Using the self-host maps server
grand_parent: Building data visualizations
parent: Using coordinate and region maps
nav_order: 10
---
# 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 +15,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 +51,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 +82,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.
@ -100,7 +102,7 @@ Configure the manifest URL in `opensearch_dashboards.yml`:
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
## Related articles
* [Configure WMS map server]({{site.url}}{{site.baseurl}}/dashboards/maptiles/)
* [Region map visualizations]({{site.url}}{{site.baseurl}}/dashboards/geojson-regionmaps/)
* [Configuring a Web Map Service (WMS)]({{site.url}}{{site.baseurl}}/dashboards/visualize/maptiles/)
* [Using coordinate and region maps]({{site.url}}{{site.baseurl}}/dashboards/visualize/geojson-regionmaps/)

View File

@ -1,9 +1,8 @@
---
layout: default
title: Using VisBuilder
parent: Visualization types
grand_parent: Visualize
nav_order: 50
parent: Building data visualizations
nav_order: 100
redirect_from:
- /dashboards/drag-drop-wizard/
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Visualize
nav_order: 4
title: Building data visualizations
nav_order: 40
has_children: true
---

View File

@ -1,10 +0,0 @@
---
layout: default
title: Visualization types
parent: Visualize
has_children: true
---
# Visualization types in OpenSearch Dashboards
OpenSearch Dashboards offers a range of visualization types and tools that you can use to display your data. Use the topics in this section to learn more about the capabilities of each visualization type or tool.