AWS solutions documentation change
Summary
Updated Solr migration documentation with new workflow-managed backup creation option, clarified configuration parameters, added endpoint details, and updated Serverless references to NextGen
Security assessment
The changes primarily enhance operational functionality by adding workflow-managed backup creation and improving configuration clarity. No security vulnerabilities, patches, or security-specific features are mentioned. Placeholder updates and endpoint additions are operational improvements without security implications.
Diff
diff --git a/solutions/latest/migration-assistant-for-amazon-opensearch-service/solr-run-workflow.md b/solutions/latest/migration-assistant-for-amazon-opensearch-service/solr-run-workflow.md index 56a2cdff7..b1fad44cb 100644 --- a//solutions/latest/migration-assistant-for-amazon-opensearch-service/solr-run-workflow.md +++ b//solutions/latest/migration-assistant-for-amazon-opensearch-service/solr-run-workflow.md @@ -9 +9 @@ -After your Solr backup is staged in Amazon S3, configure and run the migration from the Migration Console pod (`migration-console-0`) in the `ma` namespace, the same way you would for any other source. +After your Solr S3 repository is ready, configure and run the migration from the Migration Console pod (`migration-console-0`) in the `ma` namespace, the same way you would for any other source. @@ -15 +15 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f - 2. **Edit the configuration.** Set the source version to your Solr version, point `snapshotInfo` at the backup you staged in Amazon S3, and set the target authentication. The following example shows the Solr-specific fields: + 2. **Edit the configuration.** Set the source version to your Solr version, point `snapshotInfo` at the Amazon S3 backup location, and set the target authentication. The following example lets the workflow create the Solr backup: @@ -19,0 +20 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f + "endpoint": "http://SOLR_ENDPOINT:8983", @@ -24,2 +25,2 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f - "awsRegion": "<REGION>", - "s3RepoPathUri": "s3://<BUCKET>/<SUBPATH>" + "awsRegion": "REGION", + "s3RepoPathUri": "s3://BUCKET/SUBPATH" @@ -29,0 +31,5 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f + "config": { + "createSnapshotConfig": { + "snapshotPrefix": "solr" + } + }, @@ -38 +44 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f - "endpoint": "https://<TARGET_ENDPOINT>", + "endpoint": "https://TARGET_ENDPOINT", @@ -41 +47 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f - "region": "<REGION>", + "region": "REGION", @@ -53,0 +60 @@ After your Solr backup is staged in Amazon S3, configure and run the migration f + "metadataMigrationConfig": {}, @@ -67 +74,11 @@ Use the following Solr-specific settings: - * `version` — the source version string in `SOLR <major>.<minor>.<patch>` format (for example, `SOLR 8.11.4`). + * `version` — the source version string in `SOLR major.minor.patch` format (for example, `SOLR 8.11.4`). + + * `endpoint` — the live Solr endpoint. The workflow uses it for workflow-managed backup creation and Solr detection. + + * `sourceClusters.source.snapshotInfo.repos.s3.awsRegion` — the AWS Region of the bucket where the Solr backup is written. + + * `sourceClusters.source.snapshotInfo.repos.s3.s3RepoPathUri` — the `s3://BUCKET/SUBPATH` base location for the Solr backup. For workflow-managed Solr backups, the generated snapshot name is appended under this path. The generated name has the form `sourceLabel_snapshotPrefix_uniqueId`; if `snapshotPrefix` is omitted, the snapshot entry key such as `snap1` is used as the middle component. + + * `sourceClusters.source.snapshotInfo.repos.s3.endpoint` — optional custom S3 endpoint for LocalStack or S3-compatible storage. Use this only when your Solr S3 repository is also configured for that endpoint. + + * `sourceClusters.source.snapshotInfo.snapshots.snap1.config.createSnapshotConfig` — tells the workflow to create a Solr backup. The workflow auto-discovers all collections or cores; use exact-name metadata and document backfill allowlists if you want to migrate only a subset from that backup. @@ -69 +86 @@ Use the following Solr-specific settings: - * `sourceClusters.source.snapshotInfo.repos.s3.awsRegion` — the AWS Region of the bucket holding the Solr backup. + * `sourceClusters.source.snapshotInfo.snapshots.snap1.repoName` — must match a repository key under `snapshotInfo.repos`, which in turn corresponds to the `repository name="…"` value in your `solr.xml` (`s3` in the examples above). The bucket configured in `solr.xml` must match the bucket in `s3RepoPathUri`. @@ -71 +88 @@ Use the following Solr-specific settings: - * `sourceClusters.source.snapshotInfo.repos.s3.s3RepoPathUri` — the `s3://<BUCKET>/<SUBPATH>` location you recorded when you staged the backup. + * `sourceClusters.source.snapshotInfo.serializeSnapshotCreation` — optional control for multiple workflow-created snapshot entries on the same Solr source. When omitted, Solr sources use the parallel snapshot-creation default. Set this to `true` if the Solr deployment or backup repository should run only one backup operation at a time. @@ -73 +90 @@ Use the following Solr-specific settings: - * `sourceClusters.source.snapshotInfo.snapshots.snap1.repoName` — must match a repository key under `snapshotInfo.repos`, which in turn corresponds to the `<repository name="…">` value in your `solr.xml` (`s3` in the examples above). + * `snapshotMigrationConfigs[].perSnapshotConfig.snap1[].metadataMigrationConfig` — runs schema translation before document backfill so target indexes and mappings are created from the Solr backup. @@ -75 +92 @@ Use the following Solr-specific settings: - * `snapshotMigrationConfigs[].perSnapshotConfig.snap1[].documentBackfillConfig.podReplicas` — number of RFS backfill pods running in parallel (one shard per pod). + * `snapshotMigrationConfigs[].perSnapshotConfig.snap1[].documentBackfillConfig.podReplicas` — number of RFS backfill worker pods running in parallel. @@ -79 +96,10 @@ Use the following Solr-specific settings: -For an Amazon OpenSearch Serverless collection, set `authConfig.sigv4.service` to `aoss` instead of `es`, and add the migration IAM role (`<eks-cluster-name>-migrations-role`) as a principal in the collection’s data access policy. See [Getting started with the Workflow CLI](./use-the-solution.html#getting-started) for the full target configuration. +If you created and staged the Solr backup yourself, use an externally managed snapshot instead of `createSnapshotConfig`: + + "snap1": { + "config": { + "externallyManagedSnapshotName": "BACKUP_NAME" + }, + "repoName": "s3" + } + +For an Amazon OpenSearch Serverless NextGen collection, set `authConfig.sigv4.service` to `aoss` instead of `es`, and add the migration IAM role (`eks-cluster-name-migrations-role`) as a principal in the collection’s data access policy. See [Getting started with the Workflow CLI](./use-the-solution.html#getting-started) for the full target configuration. @@ -92 +118 @@ Use `workflow manage` to watch the run and approve any gated steps. -Compare the document counts on the source and the Amazon OpenSearch Service domain or Amazon OpenSearch Serverless collection to confirm completeness. +Compare the document counts on the source and the Amazon OpenSearch Service domain or Amazon OpenSearch Serverless NextGen collection to confirm completeness. @@ -105 +131 @@ S3 repository prerequisites -Troubleshooting +Capture and replay live traffic from Solr