generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 617
Add a patch and upgrade guide for MA #11191
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
natebower
merged 37 commits into
opensearch-project:main
from
peternied:ma-patch-upgrade
Oct 9, 2025
Merged
Changes from 1 commit
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
33e54cb
Add a patch and upgrade guide for MA
peternied 961c1fa
Update _migration-assistant/security-patching-and-updating.md
peternied 694ac35
Apply suggestion from @kolchfa-aws
peternied c0bfc16
Apply suggestion from @kolchfa-aws
peternied 8dd9cb3
Apply suggestion from @kolchfa-aws
peternied cd1ce0b
Apply suggestion from @kolchfa-aws
peternied 0dc6e8c
Apply suggestion from @kolchfa-aws
peternied 7dce7d9
Apply suggestion from @kolchfa-aws
peternied 5f4005f
Apply suggestion from @kolchfa-aws
peternied 9c97581
Apply suggestion from @kolchfa-aws
peternied a7567f6
Apply suggestion from @kolchfa-aws
peternied 386cca0
Apply suggestion from @kolchfa-aws
peternied e24f8e5
Apply suggestion from @kolchfa-aws
peternied e735f5b
Apply suggestion from @kolchfa-aws
peternied d52f31a
Apply suggestion from @kolchfa-aws
peternied 4219bc5
Apply suggestion from @kolchfa-aws
peternied 37535e2
Apply suggestion from @kolchfa-aws
peternied 36ea552
Apply suggestion from @kolchfa-aws
peternied 0dfcb5e
Apply suggestion from @kolchfa-aws
peternied 3b6aa4c
Apply suggestion from @kolchfa-aws
peternied 5f0b989
Apply suggestion from @kolchfa-aws
peternied 0496e73
Apply suggestion from @kolchfa-aws
peternied bf6fbca
Apply suggestion from @kolchfa-aws
peternied d7c1330
Apply suggestion from @kolchfa-aws
peternied 0ddae7a
Apply suggestion from @kolchfa-aws
peternied 783c30b
Apply suggestion from @kolchfa-aws
peternied 47a0953
Apply suggestion from @kolchfa-aws
peternied 5e99638
Manually clean up step 5
peternied 880296b
Update _migration-assistant/security-patching-and-updating.md
peternied 9e725f3
Update _migration-assistant/security-patching-and-updating.md
peternied f702056
Update _migration-assistant/security-patching-and-updating.md
peternied c92f706
Update _migration-assistant/security-patching-and-updating.md
peternied 22691f0
Update _migration-assistant/security-patching-and-updating.md
peternied 5b2f0bb
Update _migration-assistant/security-patching-and-updating.md
peternied 9bc070d
Update _migration-assistant/security-patching-and-updating.md
peternied 461bfee
Update _migration-assistant/security-patching-and-updating.md
peternied 892c6eb
Update _migration-assistant/security-patching-and-updating.md
peternied File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
--- | ||
layout: default | ||
title: Security patching & updating | ||
nav_order: 30 | ||
parent: Migration Assistant for OpenSearch | ||
permalink: /migration-assistant/security-patching-and-updating/ | ||
--- | ||
|
||
# Security patching & updating | ||
Check warning on line 9 in _migration-assistant/security-patching-and-updating.md
|
||
|
||
This page describes how to safely update the **bootstrap box** (the EC2 instance you use to build and run Migration Assistant components), clean Docker caches, and rebuild the Migration Assistant container images. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> **Recommended cadence:** Perform these steps only when the Migration Assistant is not actively running. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
--- | ||
|
||
## 1) Patch the OS on the bootstrap box | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
sudo dnf upgrade --refresh -y | ||
``` | ||
{% include copy.html %} | ||
|
||
> **Note:** If the kernel or core libraries are updated, a reboot is often required. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
### Reboot if required | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
sudo reboot | ||
``` | ||
{% include copy.html %} | ||
|
||
After the box comes back up, reconnect and continue. | ||
Check warning on line 33 in _migration-assistant/security-patching-and-updating.md
|
||
|
||
--- | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 2) Clear Docker build and download caches | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
This removes **all** unused images, containers, networks, and volumes to free disk space and ensure clean rebuilds. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
docker system prune -a --volumes | ||
``` | ||
{% include copy.html %} | ||
|
||
--- | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 3) Clean prior Gradle outputs | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
From the repository root: | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
./gradlew clean | ||
``` | ||
{% include copy.html %} | ||
|
||
--- | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 4) Rebuild Migration Assistant images | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Rebuild the Docker images used by the Migration Assistant: | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
./gradlew :buildDockerImages -x test | ||
``` | ||
{% include copy.html %} | ||
|
||
--- | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 5) Redeploy the Migration Assistant | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Redeploy the Migration Assistant to replace existing container images with the freshly built versions. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
> **Warning:** Redeployment will interrupt any running migration tasks (e.g., Capture Proxy, Replayer, or Reindex-from-Snapshot). | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
> Do **not** redeploy while actively migrating, as this can cause data loss or inconsistent state. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```shell | ||
peternied marked this conversation as resolved.
Show resolved
Hide resolved
|
||
cd deployment/cdk/opensearch-service-migration | ||
peternied marked this conversation as resolved.
Show resolved
Hide resolved
|
||
./deploy.sh <contextId> | ||
peternied marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
peternied marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{% include copy.html %} | ||
peternied marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
--- | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Troubleshooting | ||
|
||
* **`toomanyrequests: Rate exceeded`** | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Retry the last build command. Some downstream container images are rate-limited and may change over time. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
* **Cannot pull base images** | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Ensure the instance has internet egress (NAT/IGW) and access to Docker Hub/ECR as required. | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
* **Gradle cache corruption** | ||
peternied marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
If problems persist after `./gradlew clean`, also remove `~/.gradle/caches` and retry. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.