Skip to content

Refactor Migrations and Upgrades Documentation #10169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 75 commits into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
df3f743
Restructured "Is Migration Assistant Right for you?" page.
sumobrian Jun 29, 2025
c62887a
Broke down limitation by component. Minor editorial changes.
sumobrian Jun 29, 2025
b58adc4
Removed "Chossing migration approach" since it will be revised and in…
sumobrian Jun 29, 2025
84a25c1
Rename Migration Assistant section
Naarcha-AWS Jul 1, 2025
a28ad15
Fix broken links
Naarcha-AWS Jul 1, 2025
9d68c5a
Add addition upgrade options section
sumobrian Jul 2, 2025
b6b1220
Fix home cards page
Naarcha-AWS Jul 2, 2025
3e364fa
Updated requirements around VPC connectivity.
sumobrian Jul 2, 2025
abdfa96
Restructured migration journey and added migration phases.
sumobrian Jul 3, 2025
8d2509b
Merge branch 'ma_phases' into migration-upgrade
sumobrian Jul 3, 2025
49e03ab
Remove 3.x source support
sumobrian Jul 3, 2025
a4a178c
Modifications, fixes, and clarity for migration phases.
sumobrian Jul 3, 2025
198c448
Moved assets from _migration-upgrade to _migration-assistant
sumobrian Jul 3, 2025
1f59780
Add Migration Assistant to _config.yml
sumobrian Jul 3, 2025
12b5282
Merge branch 'main' into migration-upgrade
Naarcha-AWS Jul 3, 2025
2a8b601
Add additional redirects
Naarcha-AWS Jul 10, 2025
a8ac2c9
More structure fixes and redirects
Naarcha-AWS Jul 10, 2025
ca73bb0
Fix merge conflict
Naarcha-AWS Jul 10, 2025
5566d10
Revered MA card to point to MA, renamed path to migrate-and-upgrade
sumobrian Jul 12, 2025
3725f61
Restructure checkpoint
sumobrian Jul 15, 2025
4243802
Fixed breadcrumbs. More TOC changes for upgrades and migations. Fixed…
sumobrian Jul 17, 2025
1b87b08
Working structural changes with no broken links
sumobrian Jul 23, 2025
5dc7b8c
Made TOC casing titles consistent and changed the order.
sumobrian Jul 23, 2025
9112345
Merge upstream changes into migration-upgrade branch
sumobrian Jul 23, 2025
5557037
Allow symlink to MA without warnings.
sumobrian Jul 23, 2025
2713514
Updated verbiage for MA zstd limitation
sumobrian Jul 23, 2025
07bd77a
Fix breadcrumbs and added redirects for old page paths
sumobrian Jul 24, 2025
ad062d7
Updated broken links
sumobrian Jul 24, 2025
07b5dcb
Update to confirm to style guide
sumobrian Jul 25, 2025
b639732
Update deploy to reference C&R
sumobrian Jul 25, 2025
d70c8df
More convention changes
sumobrian Jul 25, 2025
a832e31
Moved MA back to it's own collection due to framework limitations. Up…
sumobrian Jul 26, 2025
b680d66
Add Migration Assistant to primary TOC
sumobrian Jul 28, 2025
2940bf9
Fix PR review comments: remove duplicate redirects, fix heading hiera…
sumobrian Jul 29, 2025
6346ecd
Merge upstream/main into migration-upgrade branch
sumobrian Jul 29, 2025
0ff3cd0
Fix example and details formatting
kolchfa-aws Jul 29, 2025
0950b6b
Merge branch 'migration-upgrade' of https://github.com/opensearch-pro…
kolchfa-aws Jul 29, 2025
d493020
Fix broken links
sumobrian Jul 29, 2025
5edbf52
Merge branch 'migration-upgrade' of github.com:opensearch-project/doc…
sumobrian Jul 29, 2025
f13c97b
Removed code font from header
sumobrian Jul 29, 2025
1d8730a
Removed deprecated page and moved the rolling upgrade lab.
sumobrian Jul 30, 2025
cc12d63
Fix Vale issues: punctuation, spacing, and terminology consistency
sumobrian Jul 30, 2025
11657eb
Fix Vale issues in migration assistant documentation
sumobrian Jul 30, 2025
20af845
Fix additional Vale issues in migration assistant documentation
sumobrian Jul 30, 2025
9461195
Fix Vale terminology issues: replace 'indices' with 'indexes'
sumobrian Jul 30, 2025
d8dcf90
Fix Vale table heading capitalization issues
sumobrian Jul 30, 2025
b0c3800
Fix final Vale issues in migration assistant documentation
sumobrian Jul 30, 2025
fcb8777
Fix Vale issues in snapshot-restore documentation
sumobrian Jul 30, 2025
2312ea3
Fix Vale directional language issue in assessment documentation
sumobrian Jul 30, 2025
d66c028
Fix Vale issues in deploy documentation
sumobrian Jul 30, 2025
fa35ccb
Fixed unecessary .etc.
sumobrian Jul 30, 2025
df60df3
Merge remote-tracking branch 'upstream/main' into migration-upgrade
sumobrian Jul 30, 2025
c55b106
Made Capture-and-Replay references consistent.
sumobrian Jul 30, 2025
f8904ac
Merge branch 'main' into migration-upgrade
sumobrian Jul 30, 2025
e34aa37
Small fixes
kolchfa-aws Jul 30, 2025
09eafe6
Fix migration-matrix boarder
sumobrian Jul 30, 2025
2cd4fbd
Merge branch 'migration-upgrade' of github.com:opensearch-project/doc…
sumobrian Jul 30, 2025
121447e
Changed capitalization inconsistencies.
sumobrian Jul 31, 2025
8e2ce61
Resolve merge conflict: remove upgrade-opensearch index.md as part of…
sumobrian Jul 31, 2025
921d62a
Update _migrate-or-upgrade/index.md
natebower Jul 31, 2025
7dd7e1b
Update _migrate-or-upgrade/index.md
sumobrian Jul 31, 2025
413b0cc
Update _migrate-or-upgrade/index.md
sumobrian Jul 31, 2025
851e65f
More editorial changes
sumobrian Jul 31, 2025
ac1efdd
Merge branch 'migration-upgrade' of github.com:opensearch-project/doc…
sumobrian Jul 31, 2025
beadd7d
Submitting changes requested.
sumobrian Jul 31, 2025
d80c034
Update _migrate-or-upgrade/snapshot-restore/index.md
natebower Jul 31, 2025
25a279b
Submitting changes requested.
sumobrian Jul 31, 2025
4c4052f
Merge branch 'migration-upgrade' of github.com:opensearch-project/doc…
sumobrian Jul 31, 2025
acdcaa1
Submitting changes requested.
sumobrian Jul 31, 2025
cae4cd9
Submitting changes requested.
sumobrian Jul 31, 2025
9f9c945
Submitting changes requested.
sumobrian Jul 31, 2025
ae79142
Submitting changes requested.
sumobrian Jul 31, 2025
d82c9ac
Remove content related to local deployments
sumobrian Jul 31, 2025
c0477e5
Fixed javascript breaking changes path
sumobrian Aug 1, 2025
e52068b
Merge branch 'main' into migration-upgrade
sumobrian Aug 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/vale/styles/Vocab/OpenSearch/Plugins/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Index Management plugin
Job Scheduler
Job Scheduler plugin
k-NN plugin
Metadata Migration Tool
ML Commons
ML Commons plugin
Neural Search plugin
Expand Down
1 change: 1 addition & 0 deletions .github/vale/styles/Vocab/OpenSearch/Products/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ Querqy
Query Workbench
RankLib
Reindex-from-Snapshot
Replayer
RCF Summarize
RPM Package Manager
Ruby
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/snapshots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ redirect_from:
**Introduced 1.0**
{: .label .label-purple }

The snapshot APIs allow you to manage snapshots and snapshot repositories.
The snapshot APIs allow you to manage snapshots and snapshot repositories.
2 changes: 1 addition & 1 deletion _benchmark/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This tutorial outlines how to quickly install OpenSearch Benchmark and run your

To perform the Quickstart steps, you'll need to fulfill the following prerequisites:

- A currently active OpenSearch cluster. For instructions on how to create an OpenSearch cluster, see [Creating a cluster]({{site.url}}{{site.baseurl}}//tuning-your-cluster/index/).
- A currently active OpenSearch cluster. For instructions on how to create an OpenSearch cluster, see [Creating a cluster]({{site.url}}{{site.baseurl}}/tuning-your-cluster/index/).
- Git 2.3 or greater.
- Python 3.8 or later

Expand Down
14 changes: 10 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ collections:
data-prepper:
permalink: /:collection/:path/
output: true
migrate-or-upgrade:
permalink: /:collection/:path/
output: true
migration-assistant:
permalink: /:collection/:path/
output: true
Expand Down Expand Up @@ -142,7 +145,10 @@ opensearch_collection:
name: Tutorials
nav_fold: true
install-and-configure:
name: Install and upgrade
name: Install and configure
nav_fold: true
migrate-or-upgrade:
name: Migrate or upgrade
nav_fold: true
tuning-your-cluster:
name: Creating and tuning your cluster
Expand Down Expand Up @@ -218,7 +224,7 @@ clients_collection:
migration_assistant_collection:
collections:
migration-assistant:
name: Migration Assistant
name: Migration Assistant for OpenSearch
nav_fold: true

benchmark_collection:
Expand Down Expand Up @@ -265,7 +271,7 @@ defaults:
path: "_migration-assistant"
values:
section: "migration-assistant"
section-name: "Migration Assistant"
section-name: "Migration Assistant for OpenSearch"

# Enable or disable the site search
# By default, just-the-docs enables its JSON file-based search. We also have an OpenSearch-driven search functionality.
Expand Down Expand Up @@ -352,4 +358,4 @@ exclude:
- .bundle/
- _site/
- spec-insert
- release-notes
- release-notes
91 changes: 91 additions & 0 deletions _data/migration-scenarios.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
scenarios:
- title: "Scenario 1: Backfill only"
steps:
- title: "Assessment"
url: "/migration-assistant/migration-phases/assessment/"
- title: "Deploy"
url: "/migration-assistant/migration-phases/deploy/"
substeps:
- title: "Verify backfill components"
url: "/migration-assistant/migration-phases/deploy/verifying-backfill-components/"
- title: "Configuration options"
url: "/migration-assistant/migration-phases/deploy/configuration-options/"
- title: "IAM and security groups for existing clusters"
url: "/migration-assistant/migration-phases/deploy/iam-and-security-groups-for-existing-clusters/"
- title: "Create a snapshot"
url: "/migration-assistant/migration-phases/create-snapshot/"
- title: "Migrate metadata"
url: "/migration-assistant/migration-phases/migrate-metadata/"
substeps:
- title: "Managing type mapping deprecation"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-type-mapping-deprecation/"
- title: "Handling breaking changes in field types"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-field-type-breaking-changes/"
- title: "Backfill"
url: "/migration-assistant/migration-phases/backfill/"
- title: "Teardown"
url: "/migration-assistant/migration-phases/remove-migration-infrastructure/"

- title: "Scenario 2: Live capture only"
steps:
- title: "Assessment"
url: "/migration-assistant/migration-phases/assessment/"
- title: "Deploy"
url: "/migration-assistant/migration-phases/deploy/"
substeps:
- title: "IAM and security groups for existing clusters"
url: "/migration-assistant/migration-phases/deploy/iam-and-security-groups-for-existing-clusters/"
- title: "Configuration options"
url: "/migration-assistant/migration-phases/deploy/configuration-options/"
- title: "Verify live capture components"
url: "/migration-assistant/migration-phases/deploy/verifying-live-capture-components/"
- title: "Reroute traffic from the source to the Capture Proxy"
url: "/migration-assistant/migration-phases/reroute-source-to-proxy/"
- title: "Migrate metadata"
url: "/migration-assistant/migration-phases/migrate-metadata/"
substeps:
- title: "Managing type mapping deprecation"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-type-mapping-deprecation/"
- title: "Handling breaking changes in field types"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-field-type-breaking-changes/"
- title: "Replay captured traffic"
url: "/migration-assistant/migration-phases/replay-captured-traffic/"
- title: "Reroute traffic from the Capture Proxy to the target"
url: "/migration-assistant/migration-phases/reroute-traffic-from-capture-proxy-to-target/"
- title: "Teardown"
url: "/migration-assistant/migration-phases/remove-migration-infrastructure/"

- title: "Scenario 3: Live capture with backfill"
steps:
- title: "Assessment"
url: "/migration-assistant/migration-phases/assessment/"
- title: "Deploy"
url: "/migration-assistant/migration-phases/deploy/"
substeps:
- title: "IAM and security groups for existing clusters"
url: "/migration-assistant/migration-phases/deploy/iam-and-security-groups-for-existing-clusters/"
- title: "Configuration options"
url: "/migration-assistant/migration-phases/deploy/configuration-options/"
- title: "Verify backfill components"
url: "/migration-assistant/migration-phases/deploy/verifying-backfill-components/"
- title: "Verify live capture components"
url: "/migration-assistant/migration-phases/deploy/verifying-live-capture-components/"
- title: "Reroute traffic from the source to the Capture Proxy"
url: "/migration-assistant/migration-phases/reroute-source-to-proxy/"
- title: "Create a snapshot"
url: "/migration-assistant/migration-phases/create-snapshot/"
- title: "Migrate metadata"
url: "/migration-assistant/migration-phases/migrate-metadata/"
substeps:
- title: "Managing type mapping deprecation"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-type-mapping-deprecation/"
- title: "Handling breaking changes in field types"
url: "/migration-assistant/migration-phases/migrate-metadata/handling-field-type-breaking-changes/"
- title: "Backfill"
url: "/migration-assistant/migration-phases/backfill/"
- title: "Replay captured traffic"
url: "/migration-assistant/migration-phases/replay-captured-traffic/"
- title: "Reroute traffic from the Capture Proxy to the target"
url: "/migration-assistant/migration-phases/reroute-traffic-from-capture-proxy-to-target/"
- title: "Teardown"
url: "/migration-assistant/migration-phases/remove-migration-infrastructure/"
3 changes: 1 addition & 2 deletions _includes/home_cards.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,9 @@
<div class="home-card">
<a href="{{site.url}}{{site.latesturl}}/migration-assistant/" class='card-link'></a>
<p class="heading">Migration Assistant</p>
<p class="description">Migrate to OpenSearch.</p>
<p class="description">Simplify your upgrade or migration to OpenSearch.</p>
<p class="last-link">Documentation &#x2192;</p>
</div>
</div>

</div>

33 changes: 33 additions & 0 deletions _includes/migration-scenarios.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{% assign scenarios = include.scenarios %}

{% for scenario in scenarios %}
<div class="scenario-container" id="scenario-{{ forloop.index }}">
<div class="scenario-title">{{ scenario.title }}</div>

<ol>
{% for step in scenario.steps %}
<li>
{% if step.url %}
<a href="{{ site.url }}{{ site.baseurl }}{{ step.url }}">{{ step.title }}</a>
{% else %}
{{ step.title }}
{% endif %}

{% if step.substeps %}
<ul>
{% for substep in step.substeps %}
<li>
{% if substep.url %}
<a href="{{ site.url }}{{ site.baseurl }}{{ substep.url }}">{{ substep.title }}</a>
{% else %}
{{ substep.title }}
{% endif %}
</li>
{% endfor %}
</ul>
{% endif %}
</li>
{% endfor %}
</ol>
</div>
{% endfor %}
75 changes: 72 additions & 3 deletions _includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,28 @@
{%- if node.parent == nil -%}
{%- unless node.nav_exclude -%}
{% assign nested_owned_tree_id = include.owned_tree_id | append: "_" | append: forloop.index | append: "_" | append: node.title | append: "_navitems" | replace: " ", "_" %}
<li role="none" class="nav-list-item{% if page.collection == include.key and page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
{%- comment -%}Check if current page is a descendant of this node{%- endcomment -%}
{%- assign is_ancestor = false -%}
{%- if page.collection == include.key -%}
{%- if page.url == node.url or page.parent == node.title or page.grand_parent == node.title -%}
{%- assign is_ancestor = true -%}
{%- else -%}
{%- comment -%}Check for 4-level deep pages{%- endcomment -%}
{%- for child in pages_list -%}
{%- if child.parent == node.title -%}
{%- for grand_child in pages_list -%}
{%- if grand_child.parent == child.title and grand_child.grand_parent == node.title -%}
{%- if page.parent == grand_child.title -%}
{%- assign is_ancestor = true -%}
{%- break -%}
{%- endif -%}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
{%- endif -%}
<li role="none" class="nav-list-item{% if is_ancestor %} active{% endif %}">
{%- if node.has_children -%}
<a
role="treeitem"
Expand All @@ -89,7 +110,22 @@
<ul role="tree" class="nav-list" id="{{ nested_owned_tree_id }}">
{%- for child in children_list -%}
{%- unless child.nav_exclude -%}
<li role="none" class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
{%- comment -%}Check if current page is a descendant of this child{%- endcomment -%}
{%- assign child_is_ancestor = false -%}
{%- if page.url == child.url or page.parent == child.title -%}
{%- assign child_is_ancestor = true -%}
{%- else -%}
{%- comment -%}Check for 4-level deep pages{%- endcomment -%}
{%- for grand_child in pages_list -%}
{%- if grand_child.parent == child.title and grand_child.grand_parent == node.title -%}
{%- if page.parent == grand_child.title -%}
{%- assign child_is_ancestor = true -%}
{%- break -%}
{%- endif -%}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
<li role="none" class="nav-list-item{% if child_is_ancestor %} active{% endif %}">
{%- if child.has_children -%}
{% assign nested_nested_owned_tree_id = nested_owned_tree_id | append: "_" | append: forloop.index | append: "_" | append: child.title | append: "_navitems" | replace: " ", "_" %}
<a
Expand All @@ -112,13 +148,46 @@
<ul role="tree" class="nav-list" id="{{ nested_nested_owned_tree_id }}">
{%- for grand_child in grand_children_list -%}
{%- unless grand_child.nav_exclude -%}
<li role="none" class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
{%- comment -%}Check if current page is a descendant of this grand_child{%- endcomment -%}
{%- assign grand_child_is_ancestor = false -%}
{%- if page.url == grand_child.url or page.parent == grand_child.title -%}
{%- assign grand_child_is_ancestor = true -%}
{%- endif -%}
<li role="none" class="nav-list-item{% if grand_child_is_ancestor %} active{% endif %}">
{%- if grand_child.has_children -%}
{% assign nested_nested_nested_owned_tree_id = nested_nested_owned_tree_id | append: "_" | append: forloop.index | append: "_" | append: grand_child.title | append: "_navitems" | replace: " ", "_" %}
<a
role="treeitem"
aria-owns="{{ nested_nested_nested_owned_tree_id }}"
{%- if page.url == grand_child.url -%}aria-current="page"{%- endif -%}
href="#"
class="nav-list-expander"
><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
{%- endif -%}
<a
role="treeitem"
{%- if grand_child.has_children -%}aria-owns="{{ nested_nested_nested_owned_tree_id }}"{%- endif -%}
{%- if page.url == grand_child.url -%}aria-current="page"{%- endif -%}
href="{{ grand_child.url | absolute_url }}"
class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}"
>{{ grand_child.title }}</a>
{%- if grand_child.has_children -%}
{%- assign great_grand_children_list = pages_list | where: "parent", grand_child.title -%}
<ul role="tree" class="nav-list" id="{{ nested_nested_nested_owned_tree_id }}">
{%- for great_grand_child in great_grand_children_list -%}
{%- unless great_grand_child.nav_exclude -%}
<li role="none" class="nav-list-item {% if page.url == great_grand_child.url %} active{% endif %}">
<a
role="treeitem"
{%- if page.url == great_grand_child.url -%}aria-current="page"{%- endif -%}
href="{{ great_grand_child.url | absolute_url }}"
class="nav-list-link{% if page.url == great_grand_child.url %} active{% endif %}"
>{{ great_grand_child.title }}</a>
</li>
{%- endunless -%}
{%- endfor -%}
</ul>
{%- endif -%}
</li>
{%- endunless -%}
{%- endfor -%}
Expand Down
2 changes: 1 addition & 1 deletion _install-and-configure/configuring-opensearch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ title: Configuring OpenSearch
nav_order: 10
has_children: true
redirect_from:
- /install-and-configure/configuring-opensearch/
- /opensearch/configuration/
- /install-and-configure/configuring-opensearch/
---

# Configuring OpenSearch
Expand Down
4 changes: 0 additions & 4 deletions _install-and-configure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,4 @@ OpenSearch and OpenSearch Dashboards are available on any compatible host that s

After you've installed OpenSearch, learn about [configuring]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/) it for your deployment.

For more information about upgrading your OpenSearch cluster, see the [upgrade guide]({{site.url}}{{site.baseurl}}/install-and-configure/upgrade-opensearch/index/).

For information about upgrade tools, see [OpenSearch upgrade, migration, and comparison tools]({{site.url}}{{site.baseurl}}/tools/index/#opensearch-upgrade-migration-and-comparison-tools).

For plugin installation, see [Installing plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/).
21 changes: 0 additions & 21 deletions _install-and-configure/upgrade-opensearch/appendix/index.md

This file was deleted.

Loading
Loading