Module: lambda-elasticsearch-cleanup
Terraform module to provision a scheduled Lambda function which will delete old Elasticsearch indexes using SigV4Auth authentication. The lambda function can optionally send output to an SNS topic if the topic ARN is given. This module was largely inspired by aws-lambda-es-cleanup
Usage
For a complete example, see examples/complete.
For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.
module "elasticsearch_cleanup" {
source = "https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.git?ref=master"
es_endpoint = module.elasticsearch.domain_endpoint
es_domain_arn = module.elasticsearch.domain_arn
es_security_group_id = module.elasticsearch.security_group_id
vpc_id = module.vpc.vpc_id
namespace = "eg"
stage = "dev"
schedule = "cron(0 3 * * ? *)"
}
Indexes are expected to be in the format name-date
where date
is in the format specified by var.index_format
.
By default, all indexes except for the ones added by Kibana will be deleted based on the date part of the full
index name. The actual creation date of the index is not used.
Index matching is done with unanchored regular expresssion, so "bar" matches index "foobarbaz".
- If the full index name, including the date part, matches
skip_index_re
, then the index will be skipped (never deleted). Kibana indexes are skipped by the defaultskip_index_re
of^\.kibana*
so if you specify a value forskip_index_re
you must include the Kibana exception in your regex if you want it excepted. (Since Kibana indexes do not have a date part, this module should not delete them, but will complain about them having malformed dates if they are not excluded.) - If the index name without the trailing
-date
part matchesindex_re
, then it will be cleaned up according to the date part.
Keep in mind that, fundamentally, this module expects indexes to be in the format of name-date
so it will not work
properly if the regexes end up selecting an index that does not end with -date
. To avoid edge cases, it is wise not
to include dashes in your index name or date format.
Migration
Prior to version 0.10.0, this moudle had inputs index
, which was a comma-separated list of index names or the
special name "all" to indicate all but Kibana indexes, and index_regex
, which was a regular expression for parsing
index name and date parts. There was no mechanism for specifying a list of indexes to exclude.
Starting with version 0.10.0 this module drops those inputs and instead takes index_re
and skip_index_re
,
both of which are regular expressions. (You probably want to anchor your regexes to the beginning of the index name
by starting with ^
).
If you previously had | Now use |
---|---|
index = "all" | Default values for index_re and skip_index_re |
index = "a,xb,c0" | index_re = "^(a\|xb\|c0)" and skip_index_re = "^$" |
index_regex = "(ipat)-(dpat)" | index_re = "ipat" and be sure index_format is correct for your date format |
Module: cloudposse/terraform-aws-lambda-elasticsearch-cleanup
This module creates a scheduled Lambda function which will delete old Elasticsearch indexes using SigV4Auth authentication. The lambda function can optionally send output to an SNS topic if the topic ARN is given
Requirements
Name | Version |
---|---|
terraform | >= 1.0.0 |
aws | >= 3.0 |
null | >= 3.0 |
Providers
Name | Version |
---|---|
aws | >= 3.0 |
Modules
Name | Source | Version |
---|---|---|
artifact | cloudposse/module-artifact/external | 0.8.0 |
label | cloudposse/label/null | 0.25.0 |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_cloudwatch_event_rule.default | resource |
aws_cloudwatch_event_target.default | resource |
aws_iam_role.default | resource |
aws_iam_role_policy.default | resource |
aws_iam_role_policy_attachment.default | resource |
aws_lambda_function.default | resource |
aws_lambda_permission.default | resource |
aws_security_group.default | resource |
aws_security_group_rule.egress_from_lambda_to_es_cluster | resource |
aws_security_group_rule.ingress_to_es_cluster_from_lambda | resource |
aws_security_group_rule.tcp_dns_egress_from_lambda | resource |
aws_security_group_rule.udp_dns_egress_from_lambda | resource |
aws_iam_policy_document.assume_role | data source |
aws_iam_policy_document.default | data source |
aws_iam_policy_document.es_logs | data source |
aws_iam_policy_document.sns | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
artifact_git_ref | Git ref of the lambda artifact to use. Use latest version if null. | string | "" | no |
artifact_url | URL template for the remote artifact | string | "https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}" | no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. | list(string) | [] | no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any |
| no |
delete_after | Number of days to preserve | number | 15 | no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
es_domain_arn | The Elasticsearch domain ARN | string | n/a | yes |
es_endpoint | The Elasticsearch endpoint for the Lambda function to connect to | string | n/a | yes |
es_security_group_id | The Elasticsearch cluster security group ID | string | n/a | yes |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . | number | null | no |
index_format | Combined with 'index' variable and is used to evaluate the index age | string | "%Y.%m.%d" | no |
index_re | Regular Expression that matches the index names to clean up (not including trailing dash and date) | string | ".*" | no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . | string | null | no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
python_version | The Python version to use | string | "3.7" | no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
schedule | CloudWatch Events rule schedule using cron or rate expression | string | "cron(0 3 * * ? *)" | no |
skip_index_re | Regular Expression that matches the index names to ignore (not clean up). Takes precedence over index_re .BY DEFAULT (when value is null ), a pattern is used to exclude Kibana indexes.Use "^$" if you do not want to skip any indexes. Include an exclusion for kibana if youwant to use a custom value and also exclude the kibana indexes. | string | null | no |
sns_arn | SNS ARN to publish alerts | string | "" | no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
subnet_ids | Subnet IDs | list(string) | n/a | yes |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
timeout | Timeout for Lambda function in seconds | number | 300 | no |
vpc_id | The VPC ID for the Lambda function | string | n/a | yes |
Outputs
Name | Description |
---|---|
lambda_function_arn | ARN of the Lambda Function |
lambda_function_source_code_size | The size in bytes of the function .zip file |
security_group_id | Security Group ID of the Lambda Function |