Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history 
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
  • Loading branch information
@Naarcha-AWS
Naarcha-AWS authored Nov 26, 2024
1 parent 1a0cefa commit 4c30f58
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions _migrations/deploying-migration-assistant/configuration-options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Each migration configuration shares the following options.

| Name | Example | Description |
| :--- | :--- | :--- |
| `sourceClusterEndpoint` | `"https://source-cluster.elb.us-east-1.endpoint.com"` | The endpoint for the source cluster. |
| `sourceClusterEndpoint` | `"https://source-cluster.elb.us-east-1.endpoint.com"` | The endpoint for the source cluster. |
| `targetClusterEndpoint` | `"https://vpc-demo-opensearch-cluster-cv6hggdb66ybpk4kxssqt6zdhu.us-west-2.es.amazonaws.com:443"` | The endpoint for the target cluster. Required if using an existing target cluster for the migration instead of creating a new one. |
| `vpcId` | `"vpc-123456789abcdefgh"` | The ID of the existing VPC where the migration resources will be placed. The VPC must have at least two private subnets that span two availability zones. |
| `vpcId` | `"vpc-123456789abcdefgh"` | The ID of the existing VPC where the migration resources will be placed. The VPC must have at least two private subnets that span two availability zones. |

Check failure on line 33 in _migrations/deploying-migration-assistant/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _migrations/deploying-migration-assistant/configuration-options.md#L33 

[OpenSearch.Spelling] Error: subnets. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output 
{"message": "[OpenSearch.Spelling] Error: subnets. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_migrations/deploying-migration-assistant/configuration-options.md", "range": {"start": {"line": 33, "column": 154}}}, "severity": "ERROR"}


## Backfill migration using RFS
Expand Down Expand Up @@ -65,8 +65,7 @@ The following CDK performs a backfill migrations using RFS:
Performing an RFS backfill migration requires an existing snapshot.


RFS configuration uses the following options. To view all available arguments for `reindexFromSnapshotExtraArgs`, see [Snapshot migrations README](https://github.com/opensearch-project/opensearch-migrations/blob/main/DocumentsFromSnapshotMigration/README.md#arguments). At a minimum, no extra arguments may be needed.

The RFS configuration uses the following options. All options are optional.

| Name | Example | Description |
| :--- | :--- | :--- |
Expand Down Expand Up @@ -108,9 +107,6 @@ The following sample CDK performs a live capture migration with C&R

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.

Check failure on line 108 in _migrations/deploying-migration-assistant/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _migrations/deploying-migration-assistant/configuration-options.md#L108 

[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output 
{"message": "[OpenSearch.Spelling] Error: Replayer. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_migrations/deploying-migration-assistant/configuration-options.md", "range": {"start": {"line": 108, "column": 161}}}, "severity": "ERROR"}

<details>
<summary><b>Capture and Replay specific configuration options table</b>
</summary>

| Name | Example | Description |
| :--- | :--- | :--- |
Expand All @@ -120,13 +116,12 @@ Performing a live capture migration requires that a Capture Proxy be configured
| `trafficReplayerExtraArgs` | `"--sigv4-auth-header-service-region es,us-east-1 --speedup-factor 5"` | Extra arguments for the Traffic Replayer command, including options for auth headers and other parameters specified by the [Traffic Replayer](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). |


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.

For arguments available in `captureProxyExtraArgs`, see the `@Parameter` fields [in the `CaptureProxy.java`](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). For `trafficReplayerExtraArgs`, see the `@Parameter` fields [in TrafficReplayer.java](https://github.com/opensearch-project/opensearch-migrations/blob/main/TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java).


## Cluster authentication pptions
## Cluster authentication options

Both the source and target cluster can use no authentication, such as authentication limited to VPC, basic authentication with a username and password, or AWS Signature Version 4 scoped to a user or role.
Both the source and target cluster can use no authentication, authentication limited to VPX, basic authentication with a username and password, or AWS Signature Version 4 scoped to a user or role.

### No authentication

Expand Down Expand Up @@ -168,7 +163,7 @@ Both the source and target cluster can use no authentication, such as authentica

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

All of these authentication mechanisms apply to both source and target clusters.
All of these authentication options apply to both source and target clusters.

## Network configuration

Expand Down

0 comments on commit 4c30f58

Please sign in to comment.