DEVELOPER_GUIDE.md

• OpenSearch Project Metrics Developer Guide
  • Build
  • Deploy
  • Forking and Cloning
  • Submitting Changes

OpenSearch Project Metrics Developer Guide

So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.

Build

• Generate the project jar by running ./gradlew clean build , this will also generate a zip with all dependency jars.

Deploy

• Now cd infrastructure/, update the enum lib/enums/account.ts file with the desired AWS account and run deploy to create all the required backend resources.
  • cdk deploy OpenSearchHealth-VPC: To deploy the VPC resources.
  • cdk deploy OpenSearchHealth-OpenSearch: To deploy the OpenSearch cluster.
  • cdk deploy OpenSearchMetrics-Workflow: To deploy the lambda and step function.
  • cdk deploy OpenSearchMetrics-HostedZone: To deploy the route53 and DNS setup.
  • cdk deploy OpenSearchMetricsNginxReadonly: To deploy the dashboard read only setup.
  • cdk deploy OpenSearchWAF: To deploy the AWS WAF for the project ALB's.
  • cdk deploy OpenSearchMetrics-Monitoring: To deploy the alerting stack which will monitor the step functions and URL of the project coming from METRICS_HOSTED_ZONE

Forking and Cloning

Fork this repository on GitHub, and clone locally with git clone.

Submitting Changes

See CONTRIBUTING.