Fix links for 2.5 doc changes. (#2465)

* Fix links for 2.5 doc changes.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Add CLI redirect

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
This commit is contained in:
Naarcha-AWS 2023-01-24 12:12:21 -06:00 committed by GitHub
parent bf0c4f8aad
commit 5bbeac2357
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 51 additions and 39 deletions

View File

@ -199,7 +199,7 @@ GET _cluster/health?level=awareness_attributes&awareness_attribute=zone
In response to the preceding request, OpenSearch returns cluster health information only for the `zone` awareness attribute.
The unassigned shard information will be accurate only if you [enable replica count enforcement]({{site.url}}{{site.baseurl}}/opensearch/cluster#forced-replica-count-enforcement) and [configure forced awareness]({{site.url}}{{site.baseurl}}/opensearch/cluster#forced-awareness) for the awareness attribute either before cluster start or after cluster start but before any indexing requests. If you enable replica enforcement after the cluster receives indexing requests, the unassigned shard information may be inaccurate. If you don't configure replica count enforcement and forced awareness, the `unassigned_shards` field will contain -1.
The unassigned shard information will be accurate only if you [enable replica count enforcement]({{site.url}}{{site.baseurl}}/opensearch/cluster#replica-count-enforcement) and [configure forced awareness]({{site.url}}{{site.baseurl}}/opensearch/cluster#forced-awareness) for the awareness attribute either before cluster start or after cluster start but before any indexing requests. If you enable replica enforcement after the cluster receives indexing requests, the unassigned shard information may be inaccurate. If you don't configure replica count enforcement and forced awareness, the `unassigned_shards` field will contain -1.
{: .warning}
## Required permissions

View File

@ -20,7 +20,7 @@ For example, a 1.0.0 client works with an OpenSearch 1.1.0 cluster, but might no
{% comment %}
* [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/)
{% endcomment %}
* [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python/)
* [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python-low-level/)
* [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/index)
* [OpenSearch .NET clients]({{site.url}}{{site.baseurl}}/clients/dot-net/)
* [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/)

View File

@ -14,7 +14,7 @@ nav_order: 11
## Prerequisites
To use `opensearch-py-ml`, install the [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python#setup). The Python client allows OpenSearch to use the Python syntax required to run DataFrames in `opensearch-py-ml`.
To use `opensearch-py-ml`, install the [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python-low-level#setup). The Python client allows OpenSearch to use the Python syntax required to run DataFrames in `opensearch-py-ml`.
## Install `opensearch-py-ml`

View File

@ -61,7 +61,7 @@ Create an SM policy to set up automatic snapshots. An SM policy defines an autom
1. (Optional) Enter the policy description.
1. In the **Source and destination** section:
1. Select or enter source indexes either as a list or as an index pattern.
1. Select a repository for snapshots. To [create a new repository](#create-a-repository), select the **Create** button.
1. Select a repository for snapshots. To [create a new repository](#creating-a-repository), select the **Create** button.
1. In the **Snapshot schedule** section:
1. Select the desired snapshot frequency or enter a custom cron expression for snapshot frequency.
1. Select the start time and time zone.

View File

@ -1,7 +1,11 @@
---
layout: default
title: Maps
title: Using maps
nav_order: 15
parent: Visualization types
grand_parent: Visualize
redirect_from:
- /dashboards/maps/
---
# Maps

View File

@ -15,13 +15,13 @@ Dashboards has several visualization types to support your data analysis needs.
## Area charts
Area charts depict changes over time, and they are commonly used to show trends. Area charts more efficiently identify patterns in log data, such as sales data for a time range and trends over that time. See [Graphs and charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/graphs-and-charts) to learn more about how to create and use them in Dashboards.
Area charts depict changes over time, and they are commonly used to show trends. Area charts more efficiently identify patterns in log data, such as sales data for a time range and trends over that time. See [Using area charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/area/) to learn more about how to create and use them in Dashboards.
<img src="{{site.url}}{{site.baseurl}}/images/area-chart-1.png" alt="Example area chart in OpenSearch Dashboards" height="90%">
## Bar charts
Bar charts, vertical or horizontal, compare categorical data and depict changes of a variable over a period of time. See [Graphs and charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/graphs-and-charts) to learn more about how to create and use them in Dashboards.
Bar charts, vertical or horizontal, compare categorical data and depict changes of a variable over a period of time.
<table style="table-layout: fixed ; width: 100%;">
<tbody>
@ -45,7 +45,6 @@ Controls is a panel, instead of a visualization type, added to a dashboard to fi
## Data tables
Data tables, or tables, show your raw data in tabular form.
See [Data tables]({{site.url}}{{site.baseurl}}/dashboards/visualize/tables) to learn how to create and use them in Dashboards.
<img src="{{site.url}}{{site.baseurl}}/images/data-table-1.png" alt="Example data table in OpenSearch Dashboards" height="100">
@ -57,32 +56,33 @@ Gantt charts show the start, end, and duration of unique events in a sequence. G
## Gauge charts
Gauge charts look similar to an analog speedometer that reads left to right from zero. They display how much there is of the thing you are measuring, and this measurement can exist alone or in relation to another measurement, such as tracking performance against benchmarks or goals. Reference [Gauge charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/gauge) to learn how to create and use them in Dashboards.
Gauge charts look similar to an analog speedometer that reads left to right from zero. They display how much there is of the thing you are measuring, and this measurement can exist alone or in relation to another measurement, such as tracking performance against benchmarks or goals.
<img src="{{site.url}}{{site.baseurl}}/images/gauge-1.png" alt="Example gauge chart in OpenSearch Dashboards" width="90%">
## Heat maps
A heat map is a view of a histogram (a graphical representation of the distribution of numerical data) over time. Instead of using bar height as a representation of frequency, as with a histogram, heat maps display data in a tabular form using colors to differentiate where values fall in a range. See [Heat maps]({{site.url}}{{site.baseurl}}/dashboards/visualize/heat-maps) to learn how to create and use them in Dashboards.
A heat map is a view of a histogram (a graphical representation of the distribution of numerical data) over time. Instead of using bar height as a representation of frequency, as with a histogram, heat maps display data in a tabular form using colors to differentiate where values fall in a range.
<img src="{{site.url}}{{site.baseurl}}/images/heat-map-1.png" alt="Example heat map in OpenSearch Dashboards" height="65">
## Line charts
Line charts compare changes in measured values over a period of time, such as gross sales by month or gross sales and net sales by month. See [Graphs and charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/graphs-and-charts) to learn more about how to create and use them in Dashboards.
Line charts compare changes in measured values over a period of time, such as gross sales by month or gross sales and net sales by month.
<img src="{{site.url}}{{site.baseurl}}/images/line-1.png" alt="Example line graph in OpenSearch Dashboards" height="100">
## Maps
You can create two types of maps in Dashboards: Coordinate maps and Region maps. Coordinate maps show the difference between data values for each location by size. Region maps show the difference between data values for each location by varying shades of color.
### Coordinate maps
Coordinate maps show location-based data on a map. Use coordinate maps to visualize GPS data (latitude and longitude coordinates) on a map. For information about OpenSearch-supported coordinate field types, see [Geographic field types]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-shape/) and [Cartesian field types]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/xy/).
### Region maps
Region maps show patterns and trends across geographic locations. A region map is one of the basemaps in Dashboards. For information about creating custom vector maps in Dashboards, see [Region map visualizations](https://opensearch.org/docs/latest/dashboards/geojson-regionmaps/).
Region maps show patterns and trends across geographic locations. A region map is one of the basemaps in Dashboards. For information about creating custom vector maps in Dashboards, see [Region map visualizations]({{site.url}}{{site.baseurl}}/dashboards/geojson-regionmaps/).
See [Maps]({{site.url}}{{site.baseurl}}/dashboards/visualize/maps/) to learn how to create and use them in Dashboards.
@ -90,43 +90,43 @@ See [Maps]({{site.url}}{{site.baseurl}}/dashboards/visualize/maps/) to learn how
## Markdown
Markdown is a the markup language used in Dashboards to provide context to your data visualizations. Using Markdown, you can display information and instructions along with the visualization. See [Markdown]({{site.url}}{{site.baseurl}}/dashboards/visualize/markdown/) to learn how to use this markup language with visualizations in Dashboards.
Markdown is a the markup language used in Dashboards to provide context to your data visualizations. Using Markdown, you can display information and instructions along with the visualization.
<img src="{{site.url}}{{site.baseurl}}/images/markdown-1.png" alt="Example coordinate map in OpenSearch Dashboards" height="100">
## Metric values
Metric values, or number charts, compare values in different measures. For example, you can create a metrics visualization to compare two values, such as actual sales compared to sales goals. See [Metric values]({{site.url}}{{site.baseurl}}/dashboards/visualize/metric-values) to learn how to create and use them in Dashboards.
Metric values, or number charts, compare values in different measures. For example, you can create a metrics visualization to compare two values, such as actual sales compared to sales goals.
<img src="{{site.url}}{{site.baseurl}}/images/metric-chart-1.png" alt="Example metric chart in OpenSearch Dashboards" height="100">
## Pie charts
Pie charts compare values for items in a dimension, such as a percentage of a total amount. See [Pie charts]({{site.url}}{{site.baseurl}}/dashboards/visualize/pie-charts/) to learn how to create and use them in Dashboards.
Pie charts compare values for items in a dimension, such as a percentage of a total amount.
<img src="{{site.url}}{{site.baseurl}}/images/pie-1.png" alt="Example pie chart in OpenSearch Dashboards" height="100">
## TSVB
The time-series visual builder (TSVB) is a data visualization tool in Dashboards used to create detailed time-series visualizations. For example, you can use TSVB to build visualizations that show data over time, such as flights by status over time or flight delays by delay type over time. Currently, TSVB can be used to create the following Dashboards visualization types: Area, Line, Metric, Gauge, Markdown, and Data Table. See [TSVB]({{site.url}}{{site.baseurl}}/dashboards/visualize/TSVB/) to learn how to create and use this set of visualization types in Dashboards.
The time-series visual builder (TSVB) is a data visualization tool in Dashboards used to create detailed time-series visualizations. For example, you can use TSVB to build visualizations that show data over time, such as flights by status over time or flight delays by delay type over time. Currently, TSVB can be used to create the following Dashboards visualization types: Area, Line, Metric, Gauge, Markdown, and Data Table.
<img src="{{site.url}}{{site.baseurl}}/images/TSVB-1.png" alt="Example TSVB in OpenSearch Dashboards" height=100>
## Tag cloud
Tag (or word) clouds are a way to display how often a word is used in relation to other words in a dataset. The best use for this type of visual is to show word or phrase frequency. See [Tag clouds]({{site.url}}{{site.baseurl}}/dashboards/visualize/tag-clouds/) to learn how to create and use in Dashboards.
Tag (or word) clouds are a way to display how often a word is used in relation to other words in a dataset. The best use for this type of visual is to show word or phrase frequency.
<img src="{{site.url}}{{site.baseurl}}/images/word-cloud-1.png" alt="Example Tag cloud in OpenSearch Dashboards" height="100">
## Timeline
Timeline is a data visualization tool in Dashboards that you can use to create time-series visualizations. Currently, Timeline can be used to create the following Dashboards visualization types: Area and Line. See [Timelines]({{site.url}}{{site.baseurl}}/dashboards/visualize/timeline/) to learn how to create and use them in Dashboards.
Timeline is a data visualization tool in Dashboards that you can use to create time-series visualizations. Currently, Timeline can be used to create the following Dashboards visualization types: Area and Line.
<img src="{{site.url}}{{site.baseurl}}/images/timeline-1.png" alt="Example Timeline in OpenSearch Dashboards" height="100">
## VisBuilder
VisBuilder is a drag-and-drop data visualization tool in Dashboards. It gives you an immediate view of your data without the need to preselect the data source or visualization type output. Currently, VisBuilder can be used to create the following Dashboards visualization types: Area, Bar, Line, Metric, and Data Table. See [VisBuilder]({{site.url}}{{site.baseurl}}/dashboards/visbuilder/) to learn how to create and use drag-and-drop visualizations in Dashboards.
VisBuilder is a drag-and-drop data visualization tool in Dashboards. It gives you an immediate view of your data without the need to preselect the data source or visualization type output. Currently, VisBuilder can be used to create the following Dashboards visualization types: Area, Bar, Line, Metric, and Data Table. See [VisBuilder]({{site.url}}{{site.baseurl}}/dashboards/visualize/visbuilder/) to learn how to create and use drag-and-drop visualizations in Dashboards.
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Example Timeline in OpenSearch Dashboards" height="100">
@ -134,6 +134,4 @@ VisBuilder is a drag-and-drop data visualization tool in Dashboards. It gives yo
[Vega](https://vega.github.io/vega/) and [Vega-Lite](https://vega.github.io/vega-lite/) are open-source, declarative language visualization grammars for creating, sharing, and saving interactive data visualizations. Vega visualizations give you the flexibility to visualize multidimensional data using a layered approach in order to build and manipulate visualizations in a structured manner. Vega can be used to create customized visualizations using any Dashboards visualization type.
See [Vega and Vega-Lite]({{site.url}}{{site.baseurl}}/dashboards/visualize/vega) to learn how to create and use these visualization grammars in Dashboards.
<img src="{{site.url}}{{site.baseurl}}/images/vega-1.png" alt="Example Vega visualization with JSON specification in OpenSearch Dashboards" height="100">

View File

@ -3,6 +3,8 @@ layout: default
title: Configuring Data Prepper
has_children: true
nav_order: 100
redirect_from:
- /clients/data-prepper/data-prepper-reference/
---
# Configuring Data Prepper

View File

@ -4,6 +4,8 @@ title: Getting started
nav_order: 5
redirect_from:
- /clients/data-prepper/getting-started/
- /data-prepper/get-started/
- /clients/data-prepper/get-started/
---
# Getting started with Data Prepper

View File

@ -2,6 +2,8 @@
layout: default
title: Migrating from Logstash
nav_order: 30
redirect_from:
- /data-prepper/configure-logstash-data-prepper/
---
# Migrating from Logstash
@ -26,7 +28,7 @@ As of the Data Prepper 1.2 release, the following plugins from the Logstash conf
## Running Data Prepper with a Logstash configuration
1. To install Data Prepper's Docker image, see the Installing Data Prepper in [Get Started]({{site.url}}{{site.baseurl}}/data-prepper/get-started#1-installing-data-prepper).
1. To install Data Prepper's Docker image, see the Installing Data Prepper in [Get Started]({{site.url}}{{site.baseurl}}/data-prepper/getting-started#1-installing-data-prepper).
2. Run the Docker image installed in Step 1 by supplying your `logstash.conf` configuration.

View File

@ -2,6 +2,8 @@
layout: default
title: Pipelines
nav_order: 10
redirect_from:
- /clients/data-prepper/pipelines/
---
# Pipelines

View File

@ -1,7 +1,7 @@
---
layout: default
title: Debian
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 33
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Docker
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 1
redirect_from:
- /dashboards/install/docker/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Helm
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 35
redirect_from:
- /dashboards/install/helm/

View File

@ -1,7 +1,7 @@
---
layout: default
title: OpenSearch Dashboards plugins
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 50
redirect_from:
- /dashboards/install/plugins

View File

@ -1,7 +1,7 @@
---
layout: default
title: RPM
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 31
redirect_from:
- /dashboards/install/rpm/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Tarball
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 30
redirect_from:
- /dashboards/install/tar/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Configure TLS
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 40
redirect_from:
- /dashboards/install/tls/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Windows
parent: Install OpenSearch Dashboards
parent: Installing OpenSearch Dashboards
nav_order: 37
redirect_from:
- /dashboards/install/windows/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Ansible playbook
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 60
redirect_from:
- /opensearch/install/ansible/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Debian
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 55
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Docker
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 5
redirect_from:
- /opensearch/install/docker/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Helm
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 6
redirect_from:
- /opensearch/install/helm/

View File

@ -1,7 +1,7 @@
---
layout: default
title: RPM
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 51
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Tarball
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 10
redirect_from:
- /opensearch/install/tar/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Windows
parent: Install OpenSearch
parent: Installing OpenSearch
nav_order: 65
---

View File

@ -88,7 +88,7 @@ source ~/.bash_profile
Next, create a shell script file called `prepare_torch_neuron.sh`. You can copy and customize one of the following examples based on your Linux operating system:
- [Ubuntu 20.04](#ubuntu-2004)
- [Amazon Linux 2](#amazon-linux2)
- [Amazon Linux 2](#amazon-linux-2)
After you've run the scripts, exit your current terminal and open a new terminal to start OpenSearch.

View File

@ -44,7 +44,7 @@ We don't recommend setting up the same repository for multiple SM policies with
## Failure management
If a snapshot operation fails, it is retried a maximum of three times. The failure message is saved in `metadata.latest_execution` and is overwritten when a subsequent snapshot operation starts. You can view the failure message using the [explain API]({{site.url}}{{site.baseurl}}/opensearch/snapshots/sm-api#explain). When using OpenSearch Dashboards, you can view the failure message on the [policy details page]({{site.url}}{{site.baseurl}}/opensearch/snapshots/sm-dashboards#view-edit-or-delete-an-sm-policy). Possible reasons for failure include red index status and shard reallocation.
If a snapshot operation fails, it is retried a maximum of three times. The failure message is saved in `metadata.latest_execution` and is overwritten when a subsequent snapshot operation starts. You can view the failure message using the [explain API]({{site.url}}{{site.baseurl}}/opensearch/snapshots/sm-api#explain). When using OpenSearch Dashboards, you can view the failure message on the [policy details page]({{site.url}}{{site.baseurl}}/dashboards/admin-ui-index/sm-dashboards/#enable-disable-or-delete-sm-policies). Possible reasons for failure include red index status and shard reallocation.
## Security

View File

@ -3,6 +3,8 @@ layout: default
title: OpenSearch CLI
nav_order: 70
has_children: false
redirect_from:
- /clients/cli/
---
# OpenSearch CLI