aws-cdk-elasticsearch-index v1.0.0-alpha.1
Elasticsearch Index CDK Construct
This construct allows you to deploy an elasticsearch index and all its settings and mappings within a stack.
Table of Contents
Usage
Installation
Install the package in your CDK application.
npm install git+ssh://git@github.com/incompass/aws-cdk-elasticsearch-index.git#master
Create an Elasticsearch Domain (Optional)
This is currently in the experimental stage over at AWS; however, it is the easiest way to setup a basic Elasticsearch cluster.
// in your stack constructor
import {CfnDomain} from '@aws-cdk/aws-elasticsearch';
const elasticsearchDomain = new CfnDomain(
this,
'ElasticsearchDomain',
{
accessPolicies: {
Version: '2012-10-17',
Statement: [
{
Effect: 'Allow',
Principal: {
AWS: '*',
},
Action: 'es:*',
Resource: `arn:aws:es:${this.region}:${this.account}:domain/${this.stackName}/*`,
},
],
},
ebsOptions: {
ebsEnabled: true,
volumeSize: 20,
volumeType: 'standard',
},
elasticsearchClusterConfig: {
instanceCount: 1,
instanceType: 't2.medium.elasticsearch',
},
domainName: this.stackName,
encryptionAtRestOptions: {
enabled: false,
},
nodeToNodeEncryptionOptions: {
enabled: true,
},
vpcOptions: {
securityGroupIds: [securityGroupIdFromSomewhere],
subnetIds: [privateSubnetIdFromSomewhere],
},
elasticsearchVersion: '7.1',
}
);
Create an Index
The construct
import {ElasticsearchIndex} from 'aws-cdk-elasticsearch-index'
const es = new ElasticsearchIndex(this, 'ElasticsearchIndex', {
mappingJSONPath: PATH_TO_A_JSON_FILE_CONTAINING_FULL_INDEX_CONFIGURATION,
elasticSearchIndex: NAME_OF_THE_INDEX_TO_CREATE,
elasticSearchDomain: FULL_URL_TO_THE_ELASTICSEARCH_DOMAIN_INCLUDING_SCHEME,
vpc: VPC_OF_YOUR_ELASTIC_SEARCH_DOMAIN, // If you want to host the lambda functions responsible for resource creation in your vpc
policyArn: elasticsearchDomain.attrArn, // where elasticSearch domain is your elasticsearch CDK construct instance, only required if you are using AWS Elasticsearch
});
Contributing
Required Software
- git
- docker
- docker-compose
- nodejs
- aws-cdk
Obtaining the Source
git clone git@github.com:incompass/aws-cdk-elasticsearch-domain
Docker
To help contributing to this project, a docker-compose
configuration is provided that includes:
- lambci/docker-lambda for the
on-event
lambda function - elasticsearch
- kibana
- mockserver
Running the docker-compose Stack
docker-compose up
Testing
This package includes both jest and cucumber-js tests. Jest is used for unit testing the lambda functions and for testing the cdk stack using the AWS supplied helpers. Cucumber is used for e2e testing the lambda functions. All contributions must include relevant tests.
Running jest tests
npm run test
Running cucumber tests
You need to start the docker-compose
stack before running the end to end tests. In one terminal, run:
docker-compose up
In another window, set the appropriate environment variables and run cucumber:
AWS_ENDPOINT=http://localhost \
AWS_REGION=us-east-1 \
S3_ENDPOINT=http://localhost:1080 \
ON_EVENT_PORT=9001 \
ON_EVENT_S3_BUCKET_NAME=test-bucket \
ON_EVENT_S3_OBJECT_KEY=test-object-key \
ON_EVENT_INDEX=test-index \
ELASTICSEARCH_DOMAIN=http://localhost:9200 \
ELASTICSEARCH_INDEX=test-index \
npm run cucumber -- --tags "not @stack"
Commit Messages
This package uses the conventional commit message format. All PRs will be squashed and merged.
Useful commands
npm run build
compile typescript to jsnpm run watch
watch for changes and compilenpm run test
perform the jest unit testsnpm run cucumber
perform the cucumber e2e tests
4 years ago