Skip to content

Commit

Permalink
Addressed a SonarQube violation in the TS code
Browse files Browse the repository at this point in the history 
Signed-off-by: Chris Helma <chelma+github@amazon.com>
  • Loading branch information
@chelma
chelma committed Sep 24, 2024
1 parent 2107ccb commit e23b9fd
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 4 deletions.
3 changes: 1 addition & 2 deletions deployment/cdk/opensearch-service-migration/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,7 @@ To give an example of this process, a user could decide to configure an addition
"openAccessPolicyEnabled": true,
"domainRemovalPolicy": "DESTROY",
"enableDemoAdmin": true,
"trafficReplayerServiceEnabled": true,
"trafficReplayerEnableClusterFGACAuth": true
"trafficReplayerServiceEnabled": true
}
```
And then deploy this additional infrastructure with the command:
Expand Down
1 change: 0 additions & 1 deletion deployment/cdk/opensearch-service-migration/lib/stack-composer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,6 @@ export class StackComposer {
const migrationAPIEnabled = this.getContextForType('migrationAPIEnabled', 'boolean', defaultValues, contextJSON)
const migrationAPIAllowedHosts = this.getContextForType('migrationAPIAllowedHosts', 'string', defaultValues, contextJSON)
const trafficReplayerServiceEnabled = this.getContextForType('trafficReplayerServiceEnabled', 'boolean', defaultValues, contextJSON)
const trafficReplayerEnableClusterFGACAuth = this.getContextForType('trafficReplayerEnableClusterFGACAuth', 'boolean', defaultValues, contextJSON)
const trafficReplayerMaxUptime = this.getContextForType('trafficReplayerMaxUptime', 'string', defaultValues, contextJSON);
const trafficReplayerGroupId = this.getContextForType('trafficReplayerGroupId', 'string', defaultValues, contextJSON)
const trafficReplayerUserAgentSuffix = this.getContextForType('trafficReplayerUserAgentSuffix', 'string', defaultValues, contextJSON)
Expand Down
1 change: 0 additions & 1 deletion deployment/cdk/opensearch-service-migration/options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ These tables list all CDK context configuration values a user can specify for th
| captureProxyExtraArgs | string | `"--suppressCaptureForHeaderMatch user-agent .*elastic-java/7.17.0.*"` | Extra arguments to provide to the Capture Proxy command. This includes available arguments specified by the [Capture Proxy](../../../TrafficCapture/trafficCaptureProxyServer/src/main/java/org/opensearch/migrations/trafficcapture/proxyserver/CaptureProxy.java). [^1] |
| kafkaBrokerServiceEnabled | boolean | false | Enable deploying the given service, via a new CloudFormation stack. **This stack is experimental and should only be used for development** |
| otelCollectorEnabled | boolean | true | Enable deploying an otel-collector within each service that uses it, in order to publish data to CloudWatch and X-Ray. |
| trafficReplayerEnableClusterFGACAuth | boolean | true | Use the configured FGAC manager user for the OpenSearch Domain for auth of replayed requests. **Note**: This is only applicable if this CDK has setup an OpenSearch Domain <br/> and a FGAC user was setup either by the `fineGrainedManagerUserSecretManagerKeyARN` or `enableDemoAdmin` option |
| trafficReplayerGroupId | string | "logging-group-default" | The Kafka consumer group ID the Replayer will use, if not specified a default ID will be used |
| trafficReplayerUserAgentSuffix | string | "AWS/test/v1.0.0" | A custom user agent that will be provided to the Replayer using the `--user-agent` flag. This will append the provided user agent to any existing user agents when requests are made to the target cluster. This setting could also be specified with the `trafficReplayerExtraArgs` option |
| trafficReplayerExtraArgs | string | "--sigv4-auth-header-service-region es,us-east-1 --speedup-factor 5" | Extra arguments to provide to the Replayer command. This includes auth header options and other parameters supported by the [Traffic Replayer](../../../TrafficCapture/trafficReplayer/src/main/java/org/opensearch/migrations/replay/TrafficReplayer.java). [^1] |
Expand Down

0 comments on commit e23b9fd

Please sign in to comment.