terraform-aws-snowflake-streaming-loader-ec2

A Terraform module which deploys a Snowplow Snowflake Streaming Loader application on AWS running on top of EC2. If you want to use a custom AMI for this deployment you will need to ensure it is based on top of Amazon Linux 2.

Telemetry

This module by default collects and forwards telemetry information to Snowplow to understand how our applications are being used. No identifying information about your sub-account or account fingerprints are ever forwarded to us - it is very simple information about what modules and applications are deployed and active.

If you wish to subscribe to our mailing list for updates to these modules or security advisories please set the user_provided_id variable to include a valid email address which we can reach you at.

How do I disable it?

To disable telemetry simply set variable telemetry_enabled = false.

What are you collecting?

For details on what information is collected please see this module: https://github.com/snowplow-devops/terraform-snowplow-telemetry

Usage

The Snowflake Streaming Loader reads data from a Snowplow Enriched output stream and writes in realtime to an events table.

module "enriched_stream" {
  source  = "snowplow-devops/kinesis-stream/aws"
  version = "0.2.0"

  name = "enriched-stream"
}

module "bad_1_stream" {
  source  = "snowplow-devops/kinesis-stream/aws"
  version = "0.2.0"

  name = "bad-1-stream"
}

module "snowflake_streaming_loader" {
  source = "snowplow-devops/snowflake-streaming-loader-ec2/aws"

  accept_limited_use_license = true

  name                 = "sf-streaming-loader"
  vpc_id               = var.vpc_id
  subnet_ids           = var.subnet_ids
  in_stream_name       = module.enriched_stream.name
  bad_stream_name      = module.bad_1_stream.name

  snowflake_account_url = "<ACCOUNT_URL>"
  snowflake_database    = "<DATABASE>"
  snowflake_schema      = "<SCHEMA>"
  snowflake_loader_user = "<USER>"
  snowflake_loader_role = "<ROLE>"
  snowflake_private_key = "<PRIVATE_KEY>"

  ssh_key_name     = "your-key-name"
  ssh_ip_allowlist = ["0.0.0.0/0"]
}

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 3.72.0

Providers

Name	Version
aws	>= 3.72.0

Modules

Name	Source	Version
instance_type_metrics	snowplow-devops/ec2-instance-type-metrics/aws	0.1.2
kcl_autoscaling	snowplow-devops/dynamodb-autoscaling/aws	0.2.0
service	snowplow-devops/service-ec2/aws	0.2.1
telemetry	snowplow-devops/telemetry/snowplow	0.5.0

Resources

Name	Type
aws_cloudwatch_log_group.log_group	resource
aws_dynamodb_table.kcl	resource
aws_iam_instance_profile.instance_profile	resource
aws_iam_policy.iam_policy	resource
aws_iam_role.iam_role	resource
aws_iam_role_policy_attachment.policy_attachment	resource
aws_security_group.sg	resource
aws_security_group_rule.egress_tcp_443	resource
aws_security_group_rule.egress_tcp_80	resource
aws_security_group_rule.egress_udp_123	resource
aws_security_group_rule.ingress_tcp_22	resource
aws_caller_identity.current	data source
aws_region.current	data source

Inputs

Name	Description	Type	Default	Required
bad_stream_name	The name of the output kinesis stream that the loader will push bad data to	`string`	n/a	yes
in_stream_name	The name of the input kinesis stream that the loader will pull data from	`string`	n/a	yes
name	A name which will be pre-pended to the resources created	`string`	n/a	yes
snowflake_account_url	URL for the connection to your Snowflake account	`string`	n/a	yes
snowflake_database	Snowflake database name	`string`	n/a	yes
snowflake_loader_user	Snowflake username used by loader to perform loading	`string`	n/a	yes
snowflake_private_key	Private Key for snowflake_loader_user used by loader to perform loading	`string`	n/a	yes
snowflake_schema	Snowflake schema name	`string`	n/a	yes
ssh_key_name	The name of the SSH key-pair to attach to all EC2 nodes deployed	`string`	n/a	yes
subnet_ids	The list of subnets to deploy the loader across	`list(string)`	n/a	yes
vpc_id	The VPC to deploy the loader within	`string`	n/a	yes
accept_limited_use_license	Acceptance of the SLULA terms (https://docs.snowplow.io/limited-use-license-1.0/)	`bool`	`false`	no
amazon_linux_2_ami_id	The AMI ID to use which must be based of of Amazon Linux 2; by default the latest community version is used	`string`	`""`	no
app_version	App version to use. This variable facilitates dev flow, the modules may not work with anything other than the default value.	`string`	`"0.2.1"`	no
associate_public_ip_address	Whether to assign a public ip address to this instance	`bool`	`true`	no
cloudwatch_logs_enabled	Whether application logs should be reported to CloudWatch	`bool`	`true`	no
cloudwatch_logs_retention_days	The length of time in days to retain logs for	`number`	`7`	no
enable_auto_scaling	Whether to enable auto-scaling policies for the service (WARN: ensure you have sufficient db_connections available for the max number of nodes in the ASG)	`bool`	`true`	no
iam_permissions_boundary	The permissions boundary ARN to set on IAM roles created	`string`	`""`	no
initial_position	Where to start processing the input Kinesis Stream from (TRIM_HORIZON or LATEST)	`string`	`"TRIM_HORIZON"`	no
instance_type	The instance type to use	`string`	`"t3a.small"`	no
java_opts	Custom JAVA Options	`string`	`"-XX:InitialRAMPercentage=75 -XX:MaxRAMPercentage=75"`	no
kcl_read_max_capacity	The maximum READ capacity for the KCL DynamoDB table	`number`	`10`	no
kcl_read_min_capacity	The minimum READ capacity for the KCL DynamoDB table	`number`	`1`	no
kcl_write_max_capacity	The maximum WRITE capacity for the KCL DynamoDB table	`number`	`10`	no
kcl_write_min_capacity	The minimum WRITE capacity for the KCL DynamoDB table	`number`	`1`	no
max_size	The maximum number of servers in this server-group	`number`	`2`	no
min_size	The minimum number of servers in this server-group	`number`	`1`	no
private_ecr_registry	The URL of an ECR registry that the sub-account has access to (e.g. '000000000000.dkr.ecr.cn-north-1.amazonaws.com.cn/')	`string`	`""`	no
scale_down_cooldown_sec	Time (in seconds) until another scale-down action can occur	`number`	`600`	no
scale_down_cpu_threshold_percentage	The average CPU percentage that we must be below to scale-down	`number`	`20`	no
scale_down_eval_minutes	The number of consecutive minutes that we must be below the threshold to scale-down	`number`	`60`	no
scale_up_cooldown_sec	Time (in seconds) until another scale-up action can occur	`number`	`180`	no
scale_up_cpu_threshold_percentage	The average CPU percentage that must be exceeded to scale-up	`number`	`60`	no
scale_up_eval_minutes	The number of consecutive minutes that the threshold must be breached to scale-up	`number`	`5`	no
snowflake_loader_role	Snowflake role used by loader to perform loading	`string`	`""`	no
ssh_ip_allowlist	The list of CIDR ranges to allow SSH traffic from	`list(any)`	[ "0.0.0.0/0" ]	no
tags	The tags to append to this resource	`map(string)`	`{}`	no
telemetry_enabled	Whether or not to send telemetry information back to Snowplow Analytics Ltd	`bool`	`true`	no
user_provided_id	An optional unique identifier to identify the telemetry events emitted by this stack	`string`	`""`	no

Outputs

Name	Description
asg_id	ID of the ASG
asg_name	Name of the ASG
sg_id	ID of the security group attached to the servers

Copyright and license

Licensed under the Snowplow Limited Use License Agreement. (If you are uncertain how it applies to your use case, check our answers to frequently asked questions.)

snowplow-devops / terraform-aws-snowflake-streaming-loader-ec2 Goto Github PK