Skip to content
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 Oct 8, 2025
961c1fa
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
694ac35
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
c0bfc16
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
8dd9cb3
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
cd1ce0b
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
0dc6e8c
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
7dce7d9
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
5f4005f
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
9c97581
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
a7567f6
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
386cca0
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
e24f8e5
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
e735f5b
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
d52f31a
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
4219bc5
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
37535e2
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
36ea552
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
0dfcb5e
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
3b6aa4c
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
5f0b989
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
0496e73
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
bf6fbca
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
d7c1330
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
0ddae7a
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
783c30b
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
47a0953
Apply suggestion from @kolchfa-aws
peternied Oct 9, 2025
5e99638
Manually clean up step 5
peternied Oct 9, 2025
880296b
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
9e725f3
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
f702056
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
c92f706
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
22691f0
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
5b2f0bb
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
9bc070d
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
461bfee
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 2025
892c6eb
Update _migration-assistant/security-patching-and-updating.md
peternied Oct 9, 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
94 changes: 94 additions & 0 deletions _migration-assistant/security-patching-and-updating.md
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

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation. Raw Output: {"message": "[OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.", "location": {"path": "_migration-assistant/security-patching-and-updating.md", "range": {"start": {"line": 9, "column": 19}}}, "severity": "WARNING"}

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.

> **Recommended cadence:** Perform these steps only when the Migration Assistant is not actively running.

---

## 1) Patch the OS on the bootstrap box

```shell
sudo dnf upgrade --refresh -y
```
{% include copy.html %}

> **Note:** If the kernel or core libraries are updated, a reboot is often required.

### Reboot if required

```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

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.OxfordComma] Add an Oxford comma in 'up, reconnect and continue.'. Raw Output: {"message": "[OpenSearch.OxfordComma] Add an Oxford comma in 'up, reconnect and continue.'.", "location": {"path": "_migration-assistant/security-patching-and-updating.md", "range": {"start": {"line": 33, "column": 26}}}, "severity": "WARNING"}

---

## 2) Clear Docker build and download caches

This removes **all** unused images, containers, networks, and volumes to free disk space and ensure clean rebuilds.

```shell
docker system prune -a --volumes
```
{% include copy.html %}

---

## 3) Clean prior Gradle outputs

From the repository root:

```shell
./gradlew clean
```
{% include copy.html %}

---

## 4) Rebuild Migration Assistant images

Rebuild the Docker images used by the Migration Assistant:

```shell
./gradlew :buildDockerImages -x test
```
{% include copy.html %}

---

## 5) Redeploy the Migration Assistant

Redeploy the Migration Assistant to replace existing container images with the freshly built versions.

> **Warning:** Redeployment will interrupt any running migration tasks (e.g., Capture Proxy, Replayer, or Reindex-from-Snapshot).
> Do **not** redeploy while actively migrating, as this can cause data loss or inconsistent state.

```shell
cd deployment/cdk/opensearch-service-migration
./deploy.sh <contextId>
```
{% include copy.html %}

---

## Troubleshooting

* **`toomanyrequests: Rate exceeded`**
Retry the last build command. Some downstream container images are rate-limited and may change over time.

* **Cannot pull base images**
Ensure the instance has internet egress (NAT/IGW) and access to Docker Hub/ECR as required.

* **Gradle cache corruption**
If problems persist after `./gradlew clean`, also remove `~/.gradle/caches` and retry.
Loading