Skip to content

Commit bb44d73

Browse files
authored
Migration Assistant updates and feedback (opensearch-project#10020)
* Migration Assistant updates and feedback. Signed-off-by: Archer <[email protected]> * Remove cruft from other MAT branch Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
1 parent 2c118d5 commit bb44d73

File tree

5 files changed

+46
-36
lines changed

5 files changed

+46
-36
lines changed
Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,37 @@
11
# Migration paths for Migration Assistant
22
migration_paths:
3-
- source: "Elasticsearch 5.6"
3+
- source: "Elasticsearch 5.x"
44
targets:
5-
- "OpenSearch 1.3"
6-
- "OpenSearch 2.19"
7-
- "OpenSearch 3.0"
8-
- source: "Elasticsearch 6.8"
5+
- "OpenSearch 1.x"
6+
- "OpenSearch 2.x"
7+
- "OpenSearch 3.x"
8+
- source: "Elasticsearch 6.x"
99
targets:
10-
- "OpenSearch 1.3"
11-
- "OpenSearch 2.19"
12-
- "OpenSearch 3.0"
13-
- source: "Elasticsearch 7.10"
10+
- "OpenSearch 1.x"
11+
- "OpenSearch 2.x"
12+
- "OpenSearch 3.x"
13+
- source: "Elasticsearch 7.x"
1414
targets:
15-
- "OpenSearch 1.3"
16-
- "OpenSearch 2.19"
17-
- "OpenSearch 3.0"
18-
- source: "Elasticsearch 7.17"
15+
- "OpenSearch 1.x"
16+
- "OpenSearch 2.x"
17+
- "OpenSearch 3.x"
18+
- source: "Elasticsearch 7.x"
1919
targets:
20-
- "OpenSearch 1.3"
21-
- "OpenSearch 2.19"
22-
- "OpenSearch 3.0"
23-
- source: "OpenSearch 1.3"
20+
- "OpenSearch 1.x"
21+
- "OpenSearch 2.x"
22+
- "OpenSearch 3.x"
23+
- source: "Elasticsearch 8.x"
2424
targets:
25-
- "OpenSearch 2.19"
26-
- "OpenSearch 3.0"
27-
- source: "OpenSearch 2.19"
25+
- "OpenSearch 2.x"
26+
- "OpenSearch 3.x"
27+
- source: "OpenSearch 1.x"
2828
targets:
29-
- "OpenSearch 2.19"
30-
- "OpenSearch 3.0"
31-
- source: "OpenSearch 3.0"
29+
- "OpenSearch 2.x"
30+
- "OpenSearch 3.x"
31+
- source: "OpenSearch 2.x"
3232
targets:
33-
- "OpenSearch 3.0"
33+
- "OpenSearch 2.x"
34+
- "OpenSearch 3.x"
35+
- source: "OpenSearch 3.x"
36+
targets:
37+
- "OpenSearch 3.x"

_migration-assistant/deploying-migration-assistant/configuration-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Both the source and target cluster can use no authentication, authentication lim
166166
```
167167
{% include copy.html %}
168168

169-
The `serviceSigningName` can be `es` for an Elasticsearch or OpenSearch domain, or `aoss` for an OpenSearch Serverless collection.
169+
The `serviceSigningName` can be `es` for an Elasticsearch or OpenSearch domain.
170170

171171
All of these authentication options apply to both source and target clusters.
172172

_migration-assistant/deploying-migration-assistant/getting-started-data-migration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Getting started with data migration
44
parent: Deploying Migration Assistant
55
nav_order: 10
66
redirect_from:
7-
- /upgrade-to/upgrade-to/
87
- /upgrade-to/snapshot-migrate/
98
- /migration-assistant/getting-started-with-data-migration/
109
---

_migration-assistant/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ redirect_from:
1010
- /migration-assistant/index/
1111
- /upgrade-to/index/
1212
- /upgrade-to/
13+
- /upgrade-to/upgrade-to/
1314
---
1415

1516
# Migration Assistant for OpenSearch
@@ -69,7 +70,7 @@ The design deployed in AWS is as follows:
6970
1. Client traffic is directed to the existing cluster.
7071
2. An Application Load Balancer with capture proxies relays traffic to a source while replicating data to Amazon Managed Streaming for Apache Kafka (Amazon MSK).
7172
3. Using the migration console, you can initiate metadata migration to establish indexes, templates, component templates, and aliases on the target cluster.
72-
4. With continuous traffic capture in place, you can use a `reindex-from-snapshot` process to capture data from your current index.
73+
4. With continuous traffic capture in place, you can use a `Reindex-from-Snapshot` process to capture data from your current index.
7374
4. Once `Reindex-from-Snapshot` is complete, captured traffic is replayed from Amazon MSK to the target cluster by the traffic replayer.
7475
5. Performance and behavior of traffic sent to the source and target clusters are compared by reviewing logs and metrics.
7576
6. After confirming that the target cluster's functionality meets expectations, clients are redirected to the new target.

_migration-assistant/is-migration-assistant-right-for-you.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ There are also tools available for migrating cluster configuration, templates, a
4848
</tbody>
4949
</table>
5050

51+
### Future migration paths
52+
53+
To see the OpenSearch migrations roadmap, go to [OpenSearch Migrations - Roadmap](https://github.com/orgs/opensearch-project/projects/229/views/1).
54+
5155
### Supported source and target platforms
5256

5357
The following source and target platforms are supported:
@@ -74,7 +78,7 @@ Migration Assistant supports the following AWS Regions:
7478
- AWS GovCloud (US-East)[^1]
7579
- AWS GovCloud (US-West)[^1]
7680

77-
[^1]: GovCloud does not support `reindex-from-snapshot` (RFS) shard sizes above 80 GiB. Ensure your shard sizes are within this limit when planning migrations with RFS in the listed GovCloud regions.
81+
[^1]: GovCloud does not support `Reindex-from-Snapshot` (RFS) shard sizes above 80 GiB. Ensure your shard sizes are within this limit when planning migrations with RFS in the listed GovCloud regions.
7882

7983
### Future migration paths
8084

@@ -86,13 +90,15 @@ Before starting a migration, consider the scope of the components involved. The
8690

8791
| Component | Supported | Recommendations |
8892
| :--- |:--- | :--- |
89-
| **Documents** | Yes | Migrate existing data with `reindex-from-snapshot` (RFS) and live traffic with Capture and Replay. |
90-
| **Index settings** | Yes | Migrate with the metadata migration tool. |
91-
| **Index mappings** | Yes | Migrate with the metadata migration tool. |
92-
| **Index templates** | Yes | Migrate with the metadata migration tool. |
93-
| **Component templates** | Yes | Migrate with the metadata migration tool. |
94-
| **Aliases** | Yes | Migrate with the metadata migration tool. |
95-
| **Index State Management (ISM) policies** | Expected in 2025 | Manually migrate using an API. |
96-
| **Elasticsearch Kibana dashboards** | Expected in 2025 | This tool is only needed when used to migrate Elasticsearch Kibana Dashboards to OpenSearch Dashboards. To start, export JSON files from Kibana and import them into OpenSearch Dashboards; before importing, use the [`dashboardsSanitizer`](https://github.com/opensearch-project/opensearch-migrations/tree/main/dashboardsSanitizer) tool on X-Pack visualizations like Canvas and Lens in Kibana Dashboards, as they may require recreation for compatibility with OpenSearch. |
93+
| **Documents** | Yes | Migrate existing data with `Reindex-from-Snapshot` (RFS) and live traffic with Capture and Replay. |
94+
| **Index settings** | Yes | Migrate with the `Metadata-Migration-Tool`. |
95+
| **Index mappings** | Yes | Migrate with the `Metadata-Migration-Tool`. |
96+
| **Index templates** | Yes | Migrate with the `Metadata-Migration-Tool`. |
97+
| **Component templates** | Yes | Migrate with the `Metadata-Migration-Tool`. |
98+
| **Aliases** | Yes | Migrate with the `Metadata-Migration-Tool`. |
99+
| **Index State Management (ISM) policies** | Expected in 2025 | Manually migrate using an API. For more information about ISM support, see [issue #944](https://github.com/opensearch-project/opensearch-migrations/issues/944). |
100+
| **Elasticsearch (Kibana)[^2] dashboards** | Expected in 2025 | This tool is only needed when used to migrate Elasticsearch Kibana Dashboards to OpenSearch Dashboards. To start, export JSON files from Kibana and import them into OpenSearch Dashboards. For Elasticsearch versions Elasticsearch 7.10.2 to 7.17, use the [`dashboardsSanitizer`](https://github.com/opensearch-project/opensearch-migrations/tree/main/dashboardsSanitizer) tool before importing X-Pack visualizations like Canvas and Lens in Kibana Dashboards, as they may require recreation for compatibility with OpenSearch.|
97101
| **Security constructs** | No | Configure roles and permissions based on cloud provider recommendations. For example, if using AWS, leverage AWS Identity and Access Management (IAM) for enhanced security management. |
98102
| **Plugins** | No | Check plugin compatibility; some Elasticsearch plugins may not have direct OpenSearch equivalents. |
103+
104+
[^2]: Kibana 5.0--7.10.2 will be supported with Elasticsearch Kibana to OpenSearch Dashboards Support on all supported source paths. Kibana 8+ is unsupported. For more information, see [issue #944](https://github.com/opensearch-project/opensearch-migrations/issues/944).

0 commit comments

Comments
 (0)