Feature to pass additional cluster settings from command line

Signed-off-by: Rishabh Singh <sngri@amazon.com>
opensearch-project · Mar 25, 2023 · 120f6cf · 120f6cf
1 parent cf335dc
commit 120f6cf
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -52,6 +52,7 @@ In order to deploy both the stacks the user needs to provide a set of required a
 | ingestNodeCount (Optional)        | integer | Number of dedicated ingest nodes, default is 0                                                                                                                           |
 | mlNodeCount (Optional)            | integer | Number of dedicated machine learning nodes, default is 0                                                                                                                 |
 | jvmSysProps (Optional)            | string  | A comma-separated list of key=value pairs that will be added to `jvm.options` as JVM system properties.                                                                  |
+| additionalConfig (Optional)       | string  | A comma-separated list of `key:value` pairs that will be added to `opensearch.yml` config. e.g., `--context additionalConfig=key1:value,key2:value`                      |
 | suffix (Optional)                 | string  | An optional string identifier to be concatenated with infra stack name.                                                                                                  |
 | region (Optional)                 | string  | User provided aws region                                                                                                                                                 |
 | account (Optional)                | string  | User provided aws account                                                                                                                                                |

diff --git a/lib/infra/infra-stack.ts b/lib/infra/infra-stack.ts
@@ -53,7 +53,8 @@ export interface infraProps extends StackProps{
     readonly mlNodeCount: number,
     readonly dataNodeStorage: number,
     readonly mlNodeStorage: number,
-    readonly jvmSysPropsString?: string
+    readonly jvmSysPropsString?: string,
+    readonly additionalConfig?: string,
 }
 
 export class InfraStack extends Stack {
@@ -467,6 +468,16 @@ export class InfraStack extends Stack {
       }));
     }
 
+    // @ts-ignore
+    if (props.additionalConfig.toString() !== 'undefined') {
+      // @ts-ignore
+      cfnInitConfig.push(InitCommand.shellCommand(`set -ex; cd opensearch; echo "${props.additionalConfig}">>config/opensearch.yml`,
+        {
+          cwd: '/home/ec2-user',
+          ignoreErrors: false,
+        }));
+    }
+
     // final run command based on whether the distribution type is min or bundle
     if (props.minDistribution) { // using (stackProps.minDistribution) condition is not working when false value is being sent
       cfnInitConfig.push(InitCommand.shellCommand('set -ex;cd opensearch; sudo -u ec2-user nohup ./bin/opensearch >> install.log 2>&1 &',

diff --git a/lib/opensearch-config/node-config.ts b/lib/opensearch-config/node-config.ts
@@ -8,26 +8,26 @@ compatible open source license. */
 export const nodeConfig = new Map<string, object>();
 
 nodeConfig.set('manager', {
-  'node.roles': [ 'cluster_manager' ]
+  'node.roles': ['cluster_manager'],
 });
 
 nodeConfig.set('data', {
-  'node.roles': [ 'data', 'ingest' ]
+  'node.roles': ['data', 'ingest'],
 });
 
 nodeConfig.set('seed-manager', {
   'node.name': 'seed',
-  'node.roles': [ 'cluster_manager' ]
+  'node.roles': ['cluster_manager'],
 });
 
 nodeConfig.set('seed-data', {
   'node.name': 'seed',
-  'node.roles': [ 'cluster_manager', 'data' ]
+  'node.roles': ['cluster_manager', 'data'],
 });
 
 nodeConfig.set('client', {
   'node.name': 'client-node',
-  'node.roles': []
+  'node.roles': [],
 });
 
 nodeConfig.set('ml', {

diff --git a/lib/os-cluster-entrypoint.ts b/lib/os-cluster-entrypoint.ts
@@ -10,6 +10,7 @@ import { Stack, StackProps } from 'aws-cdk-lib';
 import {
   AmazonLinuxCpuType, IVpc, SecurityGroup, Vpc,
 } from 'aws-cdk-lib/aws-ec2';
+import { dump } from 'js-yaml';
 import { NetworkStack } from './networking/vpc-stack';
 import { InfraStack } from './infra/infra-stack';
 
@@ -35,6 +36,7 @@ export class OsClusterEntrypoint {
       let infraStackName: string;
       let dataNodeStorage: number;
       let mlNodeStorage: number;
+      let ymlConfig: string = 'undefined';
 
       const vpcId: string = scope.node.tryGetContext('vpcId');
       const securityGroupId = scope.node.tryGetContext('securityGroupId');
@@ -134,6 +136,16 @@ export class OsClusterEntrypoint {
 
       const jvmSysProps = `${scope.node.tryGetContext('jvmSysProps')}`;
 
+      const osConfig = `${scope.node.tryGetContext('additionalConfig')}`;
+      if (osConfig.toString() !== 'undefined') {
+        try {
+          const jsonObj = JSON.parse(osConfig);
+          ymlConfig = dump(jsonObj);
+        } catch (e) {
+          throw new Error(`Encountered following error parsing json: ${e}`);
+        }
+      }
+
       const suffix = `${scope.node.tryGetContext('suffix')}`;
 
       const network = new NetworkStack(scope, 'opensearch-network-stack', {
@@ -179,6 +191,7 @@ export class OsClusterEntrypoint {
         dataNodeStorage,
         mlNodeStorage,
         jvmSysPropsString: jvmSysProps,
+        additionalConfig: ymlConfig,
         ...props,
       });