Skip to content

Commit 8664051

Browse files
Naarcha-AWSNaarcha-AWS
authored
Add migrations section (opensearch-project#8873)
* Add migrations section. Signed-off-by: Archer <[email protected]> * Add back upgrade pages. Make them less migration focused. Signed-off-by: Archer <[email protected]> * Add back in upgrade pages. Signed-off-by: Archer <[email protected]> * Remove upgrade section. Add redirects. Signed-off-by: Archer <[email protected]> * Update migration-console-commands-references.md Signed-off-by: Naarcha-AWS <[email protected]> * Implement doc review. Signed-off-by: Archer <[email protected]> * Fix getting started headers. Signed-off-by: Archer <[email protected]> * Fix parent child relationship for Deploying migration assistant Signed-off-by: Archer <[email protected]> * Update _migration-assistant/migration-phases/assessing-your-cluster-for-migration.md Signed-off-by: Naarcha-AWS <[email protected]> * Additional feedback Signed-off-by: Archer <[email protected]> * Add permalink for migration console Signed-off-by: Archer <[email protected]> * Add redirects for index pages. Signed-off-by: Archer <[email protected]> * Final edits. Signed-off-by: Archer <[email protected]> * Fix headings. Signed-off-by: Archer <[email protected]> * Add copy buttons. Signed-off-by: Archer <[email protected]> * Last copy button. Signed-off-by: Archer <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
1 parent 2ec6da7 commit 8664051

28 files changed

+216
-453
lines changed

‎_config.yml

+15-8
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ collections:
3131
install-and-configure:
3232
permalink: /:collection/:path/
3333
output: true
34-
upgrade-to:
35-
permalink: /:collection/:path/
36-
output: true
3734
im-plugin:
3835
permalink: /:collection/:path/
3936
output: true
@@ -94,6 +91,9 @@ collections:
9491
data-prepper:
9592
permalink: /:collection/:path/
9693
output: true
94+
migration-assistant:
95+
permalink: /:collection/:path/
96+
output: true
9797
tools:
9898
permalink: /:collection/:path/
9999
output: true
@@ -137,11 +137,6 @@ opensearch_collection:
137137
install-and-configure:
138138
name: Install and upgrade
139139
nav_fold: true
140-
upgrade-to:
141-
name: Migrate to OpenSearch
142-
# nav_exclude: true
143-
nav_fold: true
144-
# search_exclude: true
145140
im-plugin:
146141
name: Managing Indexes
147142
nav_fold: true
@@ -213,6 +208,12 @@ clients_collection:
213208
name: Clients
214209
nav_fold: true
215210

211+
migration_assistant_collection:
212+
collections:
213+
migration-assistant:
214+
name: Migration Assistant
215+
nav_fold: true
216+
216217
benchmark_collection:
217218
collections:
218219
benchmark:
@@ -252,6 +253,12 @@ defaults:
252253
values:
253254
section: "benchmark"
254255
section-name: "Benchmark"
256+
-
257+
scope:
258+
path: "_migration-assistant"
259+
values:
260+
section: "migration-assistant"
261+
section-name: "Migration Assistant"
255262

256263
# Enable or disable the site search
257264
# By default, just-the-docs enables its JSON file-based search. We also have an OpenSearch-driven search functionality.

‎_data/top_nav.yml

+2
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ items:
6363
url: /docs/latest/clients/
6464
- label: Benchmark
6565
url: /docs/latest/benchmark/
66+
- label: Migration Assistant
67+
url: /docs/latest/migration-assistant/
6668
- label: Platform
6769
url: /platform/index.html
6870
children:

‎_includes/cards.html

+7-1
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,14 @@
3030
<p class="description">Measure performance metrics for your OpenSearch cluster</p>
3131
<p class="last-link">Documentation &#x2192;</p>
3232
</div>
33+
34+
<div class="card">
35+
<a href="{{site.url}}/docs/latest/migration-assistant/" class='card-link'></a>
36+
<p class="heading">Migration Assistant</p>
37+
<p class="description">Migrate to OpenSearch from other platforms</p>
38+
<p class="last-link">Documentation &#x2192;</p>
39+
</div>
3340
</div>
3441

3542
</div>
3643

37-

‎_layouts/default.html

+2
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@
8787
{% assign section = site.clients_collection.collections %}
8888
{% elsif page.section == "benchmark" %}
8989
{% assign section = site.benchmark_collection.collections %}
90+
{% elsif page.section == "migration-assistant" %}
91+
{% assign section = site.migration_assistant_collection.collections %}
9092
{% endif %}
9193

9294
{% if section %}

‎_migrations/deploying-migration-assistant/configuration-options.md renamed to ‎_migration-assistant/deploying-migration-assistant/configuration-options.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Configuration options
44
nav_order: 15
5-
parent: Deploying migration assistant
5+
parent: Deploying Migration Assistant
66
---
77

88
# Configuration options
@@ -61,6 +61,7 @@ The following CDK performs a backfill migrations using RFS:
6161
}
6262
}
6363
```
64+
{% include copy.html %}
6465

6566
Performing an RFS backfill migration requires an existing snapshot.
6667

@@ -104,6 +105,7 @@ The following sample CDK performs a live capture migration with C&R:
104105
}
105106
}
106107
```
108+
{% include copy.html %}
107109

108110
Performing a live capture migration requires that a Capture Proxy be configured to capture incoming traffic and send it to the target cluster using the Traffic Replayer service. For arguments available in `captureProxyExtraArgs`, refer to the `@Parameter` fields [here](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). For `trafficReplayerExtraArgs`, refer to the `@Parameter` fields [here](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). At a minimum, no extra arguments may be needed.
109111

@@ -125,17 +127,18 @@ Both the source and target cluster can use no authentication, authentication lim
125127

126128
### No authentication
127129

128-
```
130+
```json
129131
"sourceCluster": {
130132
"endpoint": <SOURCE_CLUSTER_ENDPOINT>,
131133
"version": "ES 7.10",
132134
"auth": {"type": "none"}
133135
}
134136
```
137+
{% include copy.html %}
135138

136139
### Basic authentication
137140

138-
```
141+
```json
139142
"sourceCluster": {
140143
"endpoint": <SOURCE_CLUSTER_ENDPOINT>,
141144
"version": "ES 7.10",
@@ -146,10 +149,11 @@ Both the source and target cluster can use no authentication, authentication lim
146149
}
147150
}
148151
```
152+
{% include copy.html %}
149153

150154
### Signature Version 4 authentication
151155

152-
```
156+
```json
153157
"sourceCluster": {
154158
"endpoint": <SOURCE_CLUSTER_ENDPOINT>,
155159
"version": "ES 7.10",
@@ -160,6 +164,7 @@ Both the source and target cluster can use no authentication, authentication lim
160164
}
161165
}
162166
```
167+
{% include copy.html %}
163168

164169
The `serviceSigningName` can be `es` for an Elasticsearch or OpenSearch domain, or `aoss` for an OpenSearch Serverless collection.
165170

‎_migrations/deploying-migration-assistant/iam-and-security-groups-for-existing-clusters.md renamed to ‎_migration-assistant/deploying-migration-assistant/iam-and-security-groups-for-existing-clusters.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: IAM and security groups for existing clusters
44
nav_order: 20
5-
parent: Deploying migration assistant
5+
parent: Deploying Migration Assistant
66
---
77

88
# IAM and security groups for existing clusters
@@ -33,7 +33,7 @@ For an OpenSearch Serverless Collection, you will need to configure both network
3333
The Collection should have a network policy that uses the `VPC` access type. This requires creating a VPC endpoint on the VPC used for the solution. The VPC endpoint should be configured for the private subnets of the VPC and should attach the `osClusterAccessSG` security group.
3434

3535
2. **Data Access Policy Configuration**:
36-
The data access policy should grant permission to perform all [index operations](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html#serverless-data-supported-permissions) ↗ (`aoss:*`) for all indexes in the Collection. The IAM task roles of the applicable Migration services (Traffic Replayer, Migration Console, Reindex-from-Snapshot) should be used as the principals for this data access policy.
36+
The data access policy should grant permission to perform all [index operations](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html#serverless-data-supported-permissions) (`aoss:*`) for all indexes in the Collection. The IAM task roles of the applicable Migration services (Traffic Replayer, migration console, `Reindex-from-Snapshot`) should be used as the principals for this data access policy.
3737

3838
## Capture Proxy on Coordinator Nodes of Source Cluster
3939

@@ -68,7 +68,3 @@ Before [setting up Capture Proxy instances](https://github.com/opensearch-projec
6868
]
6969
}
7070
```
71-
72-
## Related Links
73-
74-
- [OpenSearch traffic capture setup]

‎_migrations/deploying-migration-assistant/index.md renamed to ‎_migration-assistant/deploying-migration-assistant/index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
layout: default
33
title: Deploying Migration Assistant
4-
nav_order: 10
4+
nav_order: 15
5+
has_children: true
6+
permalink: /deploying-migration-assistant/
7+
redirect-from:
8+
- /deploying-migration-assistant/index/
59
---
610

711
# Deploying Migration Assistant

0 commit comments

Comments
 (0)