Add feature to support customized config files to the cluster #82
Conversation
Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Sayali Gaikawad <[email protected]>
gaiksaya
requested review from
peterzhuamazon,
bbarani,
rishabh6788,
zelinh,
jordarlu,
prudhvigodithi and
Divyaasm
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #82 +/- ##
==========================================
+ Coverage 78.57% 79.05% +0.48%
==========================================
Files 6 6
Lines 434 444 +10
Branches 130 131 +1
==========================================
+ Hits 341 351 +10
Misses 93 93 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Sayali Gaikawad <[email protected]>
README.md
Outdated
| @@ -68,6 +68,7 @@ In order to deploy both the stacks the user needs to provide a set of required a | |||
| | enableRemoteStore | Optional | boolean | Boolean flag to enable Remote Store feature e.g., `--context enableRemoteStore=true`. See [Enable Remote Store Feature](#enable-remote-store-feature) for more details. Defaults to false | | |||
| | storageVolumeType | Optional | string | EBS volume type for all the nodes (data, ml, cluster manager). Defaults to gp2. See `lib/opensearch-config/node-config.ts` for available options. E.g., `-c storageVolumeType=gp3`. For SSD based instance (i.e. i3 family), it is used for root volume configuration. | | |||
| | customRoleArn | Optional | string | User provided IAM role arn to be used as ec2 instance profile. `-c customRoleArn=arn:aws:iam::<AWS_ACCOUNT_ID>:role/<ROLE_NAME>` | | |||
| | customConfigFiles | Optional | string | You can provide an entire config file to be overwritten or added to OpenSearch and OpenSearch Dashboards. Pass string in the form of JSON with key as local path to the config file to read from and value as file on the server to overwrite/add. Note that the values in the JSON needs to have prefix of `opensearch` or `opensearch-dashboards`. Example: `-c customConfigFiles='{"opensearch-config/config.yml": "opensearch/config/opensearch-security/config.yml", "opensearch-config/role_mapping.yml":"opensearch/config/opensearch-security/roles_mapping.yml", "/roles.yml": "opensearch/config/opensearch-security/roles.yml"}'` | | |||
There was a problem hiding this comment.
Nit: Formatting change.
| const jsonObj = JSON.parse(props.customConfigFiles); | ||
| Object.keys(jsonObj).forEach((localFileName) => { | ||
| const getConfig = load(readFileSync(localFileName, 'utf-8')); | ||
| const remoteConfigLocation = jsonObj[localFileName]; |
There was a problem hiding this comment.
I am assuming this provides the value, i.e, the actual path of the file in opensearch or opensearch-dashboards directory on the ec2 host?
There was a problem hiding this comment.
Yes! root directory remains the same which is /home/ec2-user, the value of json needs to be opensearch/config/* etc.
There was a problem hiding this comment.
Also, for local file name, the user has to provide the absolute path or does the code reads using relative-path?
There was a problem hiding this comment.
Both works as per my testing. Relative as well as absolute path.
Signed-off-by: Sayali Gaikawad <[email protected]>
Description
The
customConfigFilesfeature allows the users to overwrite or add custom config files to OpenSearch and OpenSearch Dashboards. This will allow to provide any custom configurations including security making the cluster generic for any use cases.Issues Resolved
resolves #73
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.