make OSD optional and other minor improvements (opensearch-project#19)

Signed-off-by: Rishabh Singh <[email protected]>
okhasawn · Mar 15, 2023 · e99fe23 · e99fe23
1 parent baa0037
commit e99fe23
Show file tree

Hide file tree

Showing 8 changed files with 222 additions and 92 deletions.
diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
@@ -0,0 +1,40 @@
+---
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    name: Backport
+    runs-on: ubuntu-latest
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/[email protected]
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          installation_id: 22958780
+
+      - name: Backport
+        uses: VachaShah/[email protected]
+        with:
+          github_token: ${{ steps.github_app_token.outputs.token }}
+          head_template: backport/backport-<%= number %>-to-<%= base %>
diff --git a/.github/workflows/delete-backport-branch.yml b/.github/workflows/delete-backport-branch.yml
@@ -0,0 +1,16 @@
+---
+name: Delete merged branch of the backport PRs
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  delete-branch:
+    runs-on: ubuntu-latest
+    if: startsWith(github.event.pull_request.head.ref,'backport/')
+    steps:
+      - name: Delete merged branch
+        uses: SvanBoxel/delete-merged-branch@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -38,11 +38,11 @@ In order to deploy both the stacks the user needs to provide a set of required a
 | securityDisabled (required)       | boolean | Enable or disable security plugin                                                                                                                                        |
 | minDistribution (required)        | boolean | Is it the minimal OpenSearch distribution with no security and plugins                                                                                                   |
 | distributionUrl (required)        | string  | OpenSearch tar distribution url                                                                                                                                          |
-| dashboardsUrl (required)          | string  | OpenSearch Dashboards tar distribution url                                                                                                                               |
 | cpuArch (required)                | string  | CPU platform for EC2, could be either `x64` or `arm64`                                                                                                                   |
 | singleNodeCluster (required)      | boolean | Set `true` for single-node cluster else `false` for multi-node                                                                                                           |
 | serverAccessType (required)       | string  | Restrict server access based on ip address (ipv4/ipv6), prefix list and/or security group. See [Restricting Server Access](#restricting-server-access) for more details. |
 | restrictServerAccessTo (required) | string  | The value for `serverAccessType`, e.g., 10.10.10.10/32, pl-12345, sg-12345. See [Restricting Server Access](#restricting-server-access) for more details.                |
+| dashboardsUrl (Optional)          | string  | OpenSearch Dashboards tar distribution url                                                                                                                               |
 | vpcId (Optional)                  | string  | Re-use existing vpc, provide vpc id                                                                                                                                      |
 | securityGroupId (Optional)        | boolean | Re-use existing security group, provide security group id                                                                                                                |
 | cidr (Optional)                   | string  | User provided CIDR block for new Vpc, default is `10.0.0.0/16`                                                                                                           |
@@ -52,6 +52,12 @@ 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.                                                                  |
+| 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                                                                                                                                                |
+| dataNodeStorage (Optional)        | string  | User provided ebs block storage size, defaults to 100Gb                                                                                                                  |
+| mlNodeStorage (Optional)          | string  | User provided ebs block storage size, defaults to 100Gb                                                                                                                  |
+
 
 * Before starting this step, ensure that your AWS CLI is correctly configured with access credentials.
 * Also ensure that you're running these commands in the current directory

diff --git a/bin/app.ts b/bin/app.ts
@@ -11,7 +11,9 @@ import { App } from 'aws-cdk-lib';
 import { OsClusterEntrypoint } from '../lib/os-cluster-entrypoint';
 
 const app = new App();
+const region = app.node.tryGetContext('region') ?? process.env.CDK_DEFAULT_REGION;
+const account = app.node.tryGetContext('account') ?? process.env.CDK_DEFAULT_ACCOUNT;
 
 new OsClusterEntrypoint(app, {
-  env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },
+  env: { account, region },
 });
diff --git a/lib/cloudwatch/cloudwatch-agent.ts b/lib/cloudwatch/cloudwatch-agent.ts
@@ -8,7 +8,7 @@ compatible open source license. */
 import { InitFile, InitFileOptions } from 'aws-cdk-lib/aws-ec2';
 import { CloudwatchAgentSection } from './agent-section';
 import { CloudwatchLogsSection } from './logs-section';
-import { CloudwatchMetricsSection } from "./metrics-section";
+import { CloudwatchMetricsSection } from './metrics-section';
 
 export interface CloudwatchAgentConfig {
     agent: CloudwatchAgentSection,