Skip to content

Commit ef53eda

Browse files
authored
Add home page and experimental features section (opensearch-project#1146)
* Add experimental features section for 2.3 Signed-off-by: Naarcha-AWS <[email protected]> * Fix typo Signed-off-by: Naarcha-AWS <[email protected]> * Add image thumbnails. Signed-off-by: Naarcha-AWS <[email protected]> * Fix table. Signed-off-by: Naarcha-AWS <[email protected]> * Remove playground section. Signed-off-by: Naarcha-AWS <[email protected]> * Move up experimental features Signed-off-by: Naarcha-AWS <[email protected]> * Make experimental features it's own page Signed-off-by: Naarcha-AWS <[email protected]> * Fix nav order Signed-off-by: Naarcha-AWS <[email protected]> * Ensure segment replication section appears in TOC. Link in experimental features files Signed-off-by: Naarcha-AWS <[email protected]> * Fix typo in breaking changes page Signed-off-by: Naarcha-AWS <[email protected]> * Add Drag and Drop wizard Signed-off-by: Naarcha-AWS <[email protected]> * Add drag and drop wizard changes Signed-off-by: Naarcha-AWS <[email protected]> * Remove experimental-features page Signed-off-by: Naarcha-AWS <[email protected]> * Add link for remote storage Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
1 parent 2426148 commit ef53eda

File tree

12 files changed

+67
-83
lines changed

12 files changed

+67
-83
lines changed

Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,5 @@ gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
3131
# Performance-booster for watching directories on Windows
3232
gem "wdm", "~> 0.1.0" if Gem.win_platform?
3333

34+
# Installs webrick dependency for building locally
35+
gem "webrick", "~> 1.7"

_dashboards/drag-drop-wizard.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
layout: default
3-
title: Wizard visualizations (experimental feature)
3+
title: Drag and drop wizard
44
nav_order: 8
55
---
66

7-
# Build visualizations by dragging and dropping fields
7+
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).
8+
{: .warning}
9+
10+
# Drag and drop wizard
811

912
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.
1013

@@ -16,35 +19,37 @@ The drag and drop visualization wizard:
1619

1720
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-ui.png" alt="Drag and drop user interface">
1821

19-
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 shouldn’t be enabled in production environments.
20-
{: .note}
2122

22-
# Enable the experimental features
23+
## Enable the wizard
2324

2425
To experiment with the drag and drop wizard, you first need to enable experimental visualizations in your OpenSearch playground:
2526

2627
1. Open [OpenSearch Dashboards playground](https://playground.opensearch.org/app/home#/).
2728
2. Go to **Management** **>** **Stack Management** **>** **Advanced Settings**.
28-
<img src="{{site.url}}{{site.baseurl}}/images/stack-managment-settings.png" alt="Stack management screenshot">
29-
1. Go to **Visualization** and turn on **Enable experimental visualizations**.
29+
<img src="{{site.url}}{{site.baseurl}}/images/stack-managment-settings.png" alt="Stack management screenshot">
30+
31+
3. Go to **Visualization** and turn on **Enable experimental visualizations**.
3032
<img src="{{site.url}}{{site.baseurl}}/images/enable-experimental-viz.png" alt="Enable experimental visualizations screenshot">
3133

32-
# Try out the drag and drop wizard in the playground or create a new visualization wizard
34+
## Create new visualization in OpenSearch Dashboards playground
3335

34-
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.
36+
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.
3537

3638
The following steps walk you through creating a new visualization using the wizard:
3739

3840
1. Open [OpenSearch Dashboards playground](https://playground.opensearch.org/app/home#/).
41+
3942
2. Under the menu icon, select **Visualize** **>** **Create visualization** **>** **Wizard**.
40-
<img src="{{site.url}}{{site.baseurl}}//images/drag-and-drop-viz-select.png" alt="Select Wizard visualization">
43+
44+
<img src="{{site.url}}{{site.baseurl}}//images/drag-and-drop-viz-select.png" alt="Select Wizard visualization">
45+
4146
3. Use sample data to add fields and generate a visualization.
4247

4348
Here’s an example visualization. Your visualization will look different depending on the sample data you select.
4449

4550
<img src="{{site.url}}{{site.baseurl}}/images/drag-drop-generated-viz.png" alt="Visualization generated using sample data in the Wizard">
4651

47-
# Related topics
52+
## Related topics
4853

4954
* [OpenSearch News, September 14, 2022](https://opensearch.org/)
5055
* [Drag and drop visualizations demo at OpenSearch Community Meeting, August 16, 2022](https://forum.opensearch.org/t/opensearch-community-meeting-2022-0816/10323)

_opensearch/segment-replication/configuration.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
---
22
layout: default
3-
title: Segment Replication Configuration
3+
title: Segment replication configuration
44
nav_order: 12
5-
parent: Segment Replication Feature
6-
grand_parent: Opensearch
5+
parent: Segment replication
76
---
87

9-
## Segment replication configuration
8+
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).
9+
{: .warning }
10+
11+
# Segment replication configuration
1012

1113
To enable the segment replication type, reference the steps below.
1214

13-
### Enabling the feature flag
15+
## Enabling the feature flag
1416

1517
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.
1618

17-
#### Enable on a node using a tarball install
19+
### Enable on a node using a tarball install
1820

1921
The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_JAVA_OPTS` or in config/jvm.options.
2022

@@ -42,15 +44,15 @@ The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_
4244
}
4345
````
4446

45-
#### Enable with Docker containers
47+
### Enable with Docker containers
4648

4749
If you're running Docker, add the following line to docker-compose.yml underneath the `opensearch-node` and `environment` section:
4850

4951
````json
5052
OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true" # Enables segment replication
5153
````
5254

53-
#### Setting the replication strategy on the index
55+
### Setting the replication strategy on the index
5456

5557
To set the replication strategy to segment replication, create an index with replication.type set to `SEGMENT`:
5658

@@ -65,10 +67,7 @@ PUT /my-index1
6567
}
6668
````
6769

68-
### Known limitations
69-
70-
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).
71-
{: .note }
70+
## Known limitations
7271

7372
1. Enabling segment replication for an existing index requires [reindexing](https://github.com/opensearch-project/OpenSearch/issues/3685).
7473
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).
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
layout: default
3-
title: Segment Replication Feature
4-
nav_order: 122
5-
parent: Opensearch
3+
title: Segment replication
4+
nav_order: 63
65
has_children: true
76
redirect_from:
87
- /opensearch/segment-replication/
98
---
109

11-
## Segment replication
10+
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).
11+
{: .warning}
1212

13-
OpenSearch 2.3 contains an experimental version of segment replication.
13+
# Segment replication
1414

1515
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.
1616

@@ -19,7 +19,7 @@ As an experimental feature, segment replication will be behind a feature flag an
1919

2020
### Potential use cases
2121

22-
- Users who have very high write loads but do not have high search requirements and are comfortable with longer refresh times.
22+
- Users who have high write loads but do not have high search requirements and are comfortable with longer refresh times.
2323
- 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.
2424

2525
This is the first step in a series of features designed to decouple reads and writes in order to lower compute costs.

breaking-changes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
3-
title: Breaking Changes
4-
nav_order: 3
3+
title: Breaking changes
4+
nav_order: 4
55
permalink: /breaking-changes/
66
---
77

images/1_search.png

923 Bytes
Loading

images/2_monitoring.png

835 Bytes
Loading

images/3_security.png

603 Bytes
Loading

images/4_tracking.png

316 Bytes
Loading

images/Flight-data.png

341 KB
Loading

0 commit comments

Comments
 (0)