Add home page and experimental features section (#1146)

* Add experimental features section for 2.3

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

* Fix typo

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

* Add image thumbnails.

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

* Fix table.

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

* Remove playground section.

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

* Move up experimental features

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

* Make experimental features it's own page

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

* Fix nav order

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

* Ensure segment replication section appears in TOC. Link in experimental features files

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

* Fix typo in breaking changes page

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

* Add Drag and Drop wizard

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

* Add drag and drop wizard changes

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

* Remove experimental-features page

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

* Add link for remote storage

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

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
This commit is contained in:
Naarcha-AWS 2022-09-14 12:27:15 -05:00 committed by GitHub
parent 2426148221
commit ef53eda3aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 68 additions and 84 deletions

View File

@ -31,3 +31,5 @@ gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.0" if Gem.win_platform?
# Installs webrick dependency for building locally
gem "webrick", "~> 1.7"

View File

@ -1,10 +1,13 @@
---
layout: default
title: Wizard visualizations (experimental feature)
title: Drag and drop wizard
nav_order: 8
---
# Build visualizations by dragging and dropping fields
The drag and drop visualization wizard an experimental feature with OpenSearch 2.3. Therefore, we do not recommend the use of drag and drop wizard in a production environment. For updates on the progress of drag and drop or if you want leave feedback that could help improve the feature, see the [Drag and drop git issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/1157).
{: .warning}
# Drag and drop wizard
You can use the drag and drop visualization wizard in OpenSearch Dashboards to create your data visualizations easily with just a few clicks or a single mouse gesture.
@ -16,35 +19,37 @@ The drag and drop visualization wizard:
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-ui.png" alt="Drag and drop user interface">
Beginning with OpenSearch release 1.3, the drag and drop wizard is available as an experimental feature. We invite you to try the wizard and let us know how you feel about it. Experimental features may change, break, or disappear at any time and shouldnt be enabled in production environments.
{: .note}
# Enable the experimental features
## Enable the wizard
To experiment with the drag and drop wizard, you first need to enable experimental visualizations in your OpenSearch playground:
1. Open [OpenSearch Dashboards playground](https://playground.opensearch.org/app/home#/).
2. Go to **Management** **>** **Stack Management** **>** **Advanced Settings**.
<img src="{{site.url}}{{site.baseurl}}/images/stack-managment-settings.png" alt="Stack management screenshot">
1. Go to **Visualization** and turn on **Enable experimental visualizations**.
<img src="{{site.url}}{{site.baseurl}}/images/stack-managment-settings.png" alt="Stack management screenshot">
3. Go to **Visualization** and turn on **Enable experimental visualizations**.
<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations screenshot">
# Try out the drag and drop wizard in the playground or create a new visualization wizard
## Create new visualization in OpenSearch Dashboards playground
You can explore the drag and drop wizard directly from the [OpenSearch Wizard playground](https://playground.opensearch.org/app/wizard), or you can create a new visualization and select wizard.
You can explore the drag and drop wizard directly from the [OpenSearch Dashboards playground](https://playground.opensearch.org/app/wizard), or you can create a new visualization and select wizard.
The following steps walk you through creating a new visualization using the wizard:
1. Open [OpenSearch Dashboards playground](https://playground.opensearch.org/app/home#/).
2. Under the menu icon, select **Visualize** **>** **Create visualization** **>** **Wizard**.
<img src="{{site.url}}{{site.baseurl}}//images/drag-and-drop-viz-select.png" alt="Select Wizard visualization">
<img src="{{site.url}}{{site.baseurl}}//images/drag-and-drop-viz-select.png" alt="Select Wizard visualization">
3. Use sample data to add fields and generate a visualization.
Heres an example visualization. Your visualization will look different depending on the sample data you select.
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data in the Wizard">
# Related topics
## Related topics
* [OpenSearch News, September 14, 2022](https://opensearch.org/)
* [Drag and drop visualizations demo at OpenSearch Community Meeting, August 16, 2022](https://forum.opensearch.org/t/opensearch-community-meeting-2022-0816/10323)

View File

@ -1,20 +1,22 @@
---
layout: default
title: Segment Replication Configuration
title: Segment replication configuration
nav_order: 12
parent: Segment Replication Feature
grand_parent: Opensearch
parent: Segment replication
---
## Segment replication configuration
Segment replication is an experimental feature. Therefore, we do not recommend the use of segment replication in a production environment. For updates on the progress of segment replication or if you want to leave feedback that could help improve the feature, see the [Segment replication issue](https://github.com/opensearch-project/OpenSearch/issues/2229).
{: .warning }
# Segment replication configuration
To enable the segment replication type, reference the steps below.
### Enabling the feature flag
## Enabling the feature flag
There are several methods for enabling segment replication, depending on the install type. You will also need to set the replication strategy to `SEGMENT` when creating the index.
#### Enable on a node using a tarball install
### Enable on a node using a tarball install
The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_JAVA_OPTS` or in config/jvm.options.
@ -42,7 +44,7 @@ The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_
}
````
#### Enable with Docker containers
### Enable with Docker containers
If you're running Docker, add the following line to docker-compose.yml underneath the `opensearch-node` and `environment` section:
@ -50,7 +52,7 @@ If you're running Docker, add the following line to docker-compose.yml underneat
OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true" # Enables segment replication
````
#### Setting the replication strategy on the index
### Setting the replication strategy on the index
To set the replication strategy to segment replication, create an index with replication.type set to `SEGMENT`:
@ -65,10 +67,7 @@ PUT /my-index1
}
````
### Known limitations
Segment replication is an experimental feature. Therefore, we do not recommend the use of segment replication in a production environment. For updates on the progress of segment replication or if you want to leave feedback that could help improve the feature, see the [Segment Replication Git Issue](https://github.com/opensearch-project/OpenSearch/issues/2229).
{: .note }
## Known limitations
1. Enabling segment replication for an existing index requires [reindexing](https://github.com/opensearch-project/OpenSearch/issues/3685).
1. Rolling upgrades are currently not supported. Full cluster restarts are required when upgrading indexes using segment replication. [Issue 3881](https://github.com/opensearch-project/OpenSearch/issues/3881).

View File

@ -1,16 +1,16 @@
---
layout: default
title: Segment Replication Feature
nav_order: 122
parent: Opensearch
title: Segment replication
nav_order: 63
has_children: true
redirect_from:
- /opensearch/segment-replication/
---
## Segment replication
Segment replication is an experimental feature with OpenSearch 2.3. Therefore, we do not recommend the use of segment replication in a production environment. For updates on the progress of segment replication or if you want leave feedback that could help improve the feature, see the [Segment replication git issue](https://github.com/opensearch-project/OpenSearch/issues/2229).
{: .warning}
OpenSearch 2.3 contains an experimental version of segment replication.
# Segment replication
With segment replication, segment files are copied across shards instead of documents being indexed on each shard copy. This improves indexing throughput and lowers resource utilization at the expense of increased network utilization.
@ -19,7 +19,7 @@ As an experimental feature, segment replication will be behind a feature flag an
### Potential use cases
- Users who have very high write loads but do not have high search requirements and are comfortable with longer refresh times.
- Users who have high write loads but do not have high search requirements and are comfortable with longer refresh times.
- Users with very high loads who want to add new nodes, as you do not need to index all nodes when adding a new node to the cluster.
This is the first step in a series of features designed to decouple reads and writes in order to lower compute costs.

View File

@ -1,7 +1,7 @@
---
layout: default
title: Breaking Changes
nav_order: 3
title: Breaking changes
nav_order: 4
permalink: /breaking-changes/
---

BIN
images/1_search.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 923 B

BIN
images/2_monitoring.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 835 B

BIN
images/3_security.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 603 B

BIN
images/4_tracking.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 316 B

BIN
images/Flight-data.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 341 KiB

View File

@ -1,6 +1,6 @@
---
layout: default
title: Get started
title: Geting Started with OpenSearch
nav_order: 1
redirect_from: /404.html
permalink: /
@ -8,63 +8,55 @@ permalink: /
# OpenSearch documentation
This site contains the technical documentation for [OpenSearch](https://opensearch.org/), the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
[Get started](#docker-quickstart){: .btn .btn-blue }
Welcome to the OpenSearch documentation! With this documentation, youll learn how to use OpenSearch &mdash; the only 100% open-source search, analytics, and visualization suite.
We have a dedicated and growing number of technical writers who are building our documentation library. We also welcome and encourage community input. To contribute, see the [Contributing](https://opensearch.org/source.html) file. A good place to start is by browsing issues labeled “_good first issue_.”
---
## Getting started
- [About OpenSearch](index.md)
- [Install OpenSearch](_opensearch/install/index.md)
- [Install OpenSearch Dashboards](_dashboards/install/plugins.md)
- [See the FAQ](https://opensearch.org/faq)
## Why use OpenSearch?
OpenSearch is well-suited to the following use cases:
With OpenSearch, you can perform the following use cases:
* Log analytics
* Real-time application monitoring
* Clickstream analytics
* Search backend
Component | Purpose
:--- | :---
[OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/) | Data store and search engine
[OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) | Search frontend and visualizations
[Security]({{site.url}}{{site.baseurl}}/security-plugin/) | Authentication and access control for your cluster
[Alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) | Receive notifications when your data meets certain conditions
[SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) | Use SQL or a piped processing language to query your data
[Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) | Automate index operations
[KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) | Find “nearest neighbors” in your vector data
[Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) | Monitor and optimize your cluster
[Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications
[ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) | Train and execute machine-learning models
[Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background
[Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) | Replicate your data across multiple OpenSearch clusters
![](images/1_search.png) | ![](images/2_monitoring.png)|![](images/3_security.png) | ![](images/4_tracking.png)
:--- | :--- | :--- | :--- |
**Fast, Scalable Full-text Search** | **Application and Infrastructure Monitoring** | **Security and Event Information Management** | **Operational Health Tracking**
Help users find the right information within your application, website, or data lake catalog. | Easily store and analyze log data, and set automated alerts for underperformance. | Centralize logs to enable real-time security monitoring and forensic analysis. | Use observability logs, metrics, and traces to monitor your applications and business in real time.
Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
**Additional features and plugins:**
For specifics around the project, see the [FAQ](https://opensearch.org/faq/).
---
OpenSearch has several features and plugins to help index, secure, monitor, and analyze your data. Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
- [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) - Identify atypical data and receive automatic notifications
- [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) - Find “nearest neighbors” in your vector data
- [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) - Monitor and optimize your cluster
- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) - Use SQL or a piped processing language to query your data
- [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) - Automate index operations
- [ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) - Train and execute machine-learning models
- [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) - Run search requests in the background
- [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) - Replicate your data across multiple OpenSearch clusters
## Docker quickstart
Docker
{: .label .label-green }
The best way to try out OpenSearch is to use Docker Compose. Setting up OpenSearch with Docker Compose sets up a two-node cluster of OpenSearch plus OpenSearch Dashboards.
1. Install and start [Docker Desktop](https://www.docker.com/products/docker-desktop).
1. Run the following commands:
```bash
docker pull opensearchproject/opensearch:{{site.opensearch_version}}
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}}
```
1. In a new terminal session, run:
```bash
curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200'
```
1. [Create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) your first index.
```bash
@ -98,33 +90,18 @@ Docker
To learn more, see [Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker/) and [Docker security configuration]({{site.url}}{{site.baseurl}}/opensearch/install/docker-security/).
---
## Installation
For more comprehensive installation instructions for other download types, such as tarballs, see these pages:
- [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/)
- [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/)
## The secure path forward
OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must [configure the security plugin manually]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/): your own certificates, your own authentication method, your own users, and your own passwords.
OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must [configure the security plugin manually]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/) with your own certificates, authentication method, users, and passwords.
## Looking for the Javadoc?
See [opensearch.org/javadocs/](https://opensearch.org/javadocs/).
## Get involved
[OpenSearch](https://opensearch.org) is supported by Amazon Web Services. All components are available under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) on [GitHub](https://github.com/opensearch-project/).
The project welcomes GitHub issues, bug fixes, features, plugins, documentation---anything at all. To get involved, see [Contributing](https://opensearch.org/source.html) on the OpenSearch website.
---
<small>OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.</small>

View File

@ -7,11 +7,12 @@ permalink: /version-history/
# Version history
OpenSearch version | Release highlights | Release date
OpenSearch version | Release highlights | Release date |
:--- | :--- | :--- | :---
[2.3.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.3.0.md) | This release includes the following experimental features: [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/), [remote-backed storage]({{site.url}}{{site.baseurl}}/opensearch/remote/), and [drag and drop]({{site.url}}{{site.baseurl}}/dashboards/drag-drop-wizard/) for OpenSearch Dashboards. Experimental features allow you to test new functionality in OpenSearch. Because these features are still being developed, your testing and feedback can help shape the development of the feature before it's official released. We do not recommend use of experimental features in production. Additionally, this release Adds maketime and makedate datetime functions for the SQL plugin. Creates a new [OpenSearch Playground](https://playground.opensearch.org) demo site for OpenSearch Dashboards. For a full list of release highlights, see the Release Notes. | 14 September 2022
[2.2.1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.2.1.md) | Includes gradle updates and bug fixes for gradle check. | 01 September 2022
[2.2.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.2.0.md) | Includes support for Logistic Regression and RCFSummarize machine learning algorithms in ML Commons, Lucene or C-based Nmslib and Faiss libraries for approximate k-NN search, search by relevance using SQL and PPL queries, custom region maps for visualizations, and rollup enhancements. For a full list of release highlights, see the Release Notes. | 11 August 2022
[2.1.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.1.0.md) | Includes support for dedicated ML node in the ML Commons plugin, relevance search and other features in SQL, multi-terms aggretation, and Snapshot Management. For a full list of release highlights, see the Release Notes. | 07 July 2022
[2.1.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.1.0.md) | Includes support for dedicated ML node in the ML Commons plugin, relevance search and other features in SQL, multi-terms aggregation, and Snapshot Management. For a full list of release highlights, see the Release Notes. | 07 July 2022
[2.0.1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.1.md) | Includes bug fixes and maintenance updates for Alerting and Anomaly Detection. | 16 June 2022
[2.0.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.0.md) | Includes document-level monitors for alerting, OpenSearch Notifications plugins, and Geo Map Tiles in OpenSearch Dashboards. Also adds support for Lucene 9 and bug fixes for all OpenSearch plugins. For a full list of release highlights, see the Release Notes. | 26 May 2022
[2.0.0-rc1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.0.0-rc1.md) | The Release Candidate for 2.0.0. This version allows you to preview the upcoming 2.0.0 release before the GA release. The preview release adds document level alerting, support for Lucene 9, and the ability to use term lookup queries in document level security. | 3 May 2022
@ -20,7 +21,7 @@ OpenSearch version | Release highlights | Release date
[1.3.3](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.3.md) | Adds enhancements to Anomaly Detection and ML Commons. Bug fixes for Anomaly Detection, Observability, and k-NN. | 9 June 2022
[1.3.2](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.2.md) | Bug fixes for Anomaly Detection and the Security Dashboards Plugin, adds the option to install OpenSearch using RPM, as well as enhancements to the ML Commons execute task, and the removal of the job-scheduler zip in Anomaly Detection. | 5 May 2022
[1.3.1](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.1.md) | Bug fixes when using document-level security, and adjusted ML Commons to use the latest RCF jar and protostuff to RCF model serialization. | 30 March 2022
[1.3.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.0.md) | Adds Model Type Validation to Validate Detector API, continuous transforms, custom actions, applied policy parameter to Explain API, default action retries, and new rollover and transition conditions to Index Management, new ML Commons plugin, parse command to SQL, Application Analytics, Live Tail, Correlation, and Events Flyout to Observbility, and auto backport and support for OPENSEARCH_JAVA_HOME to Performance Analyzer. Bug fixes. | 17 March 2022
[1.3.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.3.0.md) | Adds Model Type Validation to Validate Detector API, continuous transforms, custom actions, applied policy parameter to Explain API, default action retries, and new rollover and transition conditions to Index Management, new ML Commons plugin, parse command to SQL, Application Analytics, Live Tail, Correlation, and Events Flyout to Observability, and auto backport and support for OPENSEARCH_JAVA_HOME to Performance Analyzer. Bug fixes. | 17 March 2022
[1.2.4](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.2.4.md) | Updates Performance Analyzer, SQL, and Security plugins to Log4j 2.17.1, Alerting and Job Scheduler to cron-utils 9.1.6, and gson in Anomaly Detection and SQL. | 18 January 2022
[1.2.3](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-1.2.3.md) | Updates the version of Log4j used in OpenSearch to Log4j 2.17.0 as recommended by the advisory in [CVE-2021-45105](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45105). | 22 December 2021
[1.2.0](https://github.com/opensearch-project/OpenSearch/blob/main/release-notes/opensearch.release-notes-1.2.0.md) | Adds observability, new validation API for Anomaly Detection, shard-level indexing back-pressure, new "match" query type for SQL and PPL, support for Faiss libraries in k-NN, and custom Dashboards branding. | 23 November 2021