Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
terraform-aws-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
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
Usage
IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.
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 = "rate(5 minutes)"
}Makefile Targets
Available targets:
build Build Lambda function zip
dependencies Install dependencies
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
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 | >= 0.12.0, < 0.14.0 |
| aws | ~> 2.0 |
| null | ~> 2.0 |
| template | ~> 2.0 |
Providers
| Name | Version |
|---|---|
| aws | ~> 2.0 |
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| artifact_url | URL template for the remote artifact | string |
"https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}" |
no |
| attributes | Additional attributes (e.g. 1) |
list(string) |
[] |
no |
| delete_after | Number of days to preserve | number |
15 |
no |
| delimiter | Delimiter to be used between namespace, stage, name and attributes |
string |
"-" |
no |
| enabled | This module will not create any resources unless enabled is set to "true" | bool |
true |
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 |
| index | Index/indices to process. Use a comma-separated list. Specify all to match every index except for .kibana or .kibana_1 |
string |
"all" |
no |
| index_format | Combined with 'index' variable and is used to evaluate the index age | string |
"%Y.%m.%d" |
no |
| index_regex | Determines regex that is used for matching index name and index date. By default it match two groups separated by hyphen. | string |
"([^-]+)-(.*)" |
no |
| name | Solution name, e.g. 'app' or 'cluster' | string |
"app" |
no |
| namespace | Namespace, which could be your organization name, e.g. 'eg' or 'cp' | string |
"" |
no |
| python_version | The Python version to use | string |
"2.7" |
no |
| schedule | CloudWatch Events rule schedule using cron or rate expression | string |
"cron(0 3 * * ? *)" |
no |
| sns_arn | SNS ARN to publish alerts | string |
"" |
no |
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string |
"" |
no |
| subnet_ids | Subnet IDs | list(string) |
n/a | yes |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ') |
map(string) |
{} |
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 |
Share the Love
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Related Projects
Check out these related projects.
- terraform-aws-vpc - Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways
- terraform-aws-dynamic-subnets - Terraform module for dynamic subnets provisioning.
- terraform-aws-elasticsearch - Terraform module for AWS Elasticsearch provisioning.
Help
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
DevOps Accelerator for Startups
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Slack Community
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
Discourse Forums
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Newsletter
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Office Hours
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Contributing
Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
Developing
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright
Copyright © 2017-2020 Cloud Posse, LLC
License
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
Trademarks
All other trademarks referenced herein are the property of their respective owners.
About
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Contributors
 Josh Myers |
 Erik Osterman |
 Andriy Knysh |
 Igor Rodionov |
 Marcin Brański |
|---|