├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── main.tf ├── outputs.tf └── variables.tf /.gitignore: -------------------------------------------------------------------------------- 1 | # Local .terraform directories 2 | **/.terraform/* 3 | 4 | # .tfstate files 5 | *.tfstate 6 | *.tfstate.* 7 | 8 | # .tfvars files 9 | *.tfvars 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: bash 2 | 3 | sudo: required 4 | 5 | services: 6 | - docker 7 | 8 | before_install: 9 | - docker pull hashicorp/terraform:0.10.7 10 | - docker pull wata727/tflint:0.5.1 11 | 12 | script: 13 | - docker run --rm -v $(pwd):/data --workdir=/data -t hashicorp/terraform:0.10.7 validate -check-variables=false 14 | - docker run --rm -v $(pwd):/data --workdir=/data -t hashicorp/terraform:0.10.7 fmt -write=false -diff=true -check=true 15 | - docker run --rm -v $(pwd):/data --workdir=/data -t hashicorp/terraform:0.10.7 get 16 | # tflint chokes when trying to check our syntax because of this issue: https://github.com/wata727/tflint/issues/204 17 | # specifically, it's currently unable to parse the construct we have at https://github.com/blinkist/terraform-aws-airship-ecs-service/blob/85dc02a8b0a1def86186d46167ace55d7375f13b/main.tf#L204 18 | # fixing it is pretty involved and the author plans to rip out the parsing in favour of terraform's anyway. so for now, just disable it. 19 | # - docker run --rm -v $(pwd):/data --workdir=/data -t wata727/tflint:0.5.1 --error-with-issues 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AWS ECR Module [![Build Status](https://travis-ci.org/doingcloudright/terraform-aws-ecr-lifecycle-policy-rule.svg?branch=master)](https://travis-ci.org/doingcloudright/terraform-aws-ecr-lifecycle-policy-rule) 2 | 3 | This module simplifies the creation of an ECR life cycle rule. And can be used in combination with doingcloudright/ecr-cross-account/aws. NB: Badly created ECR Lifecycle rules can cause great harm, it's important to review the created lifecycle rules. 4 | 5 | Rules can be made for all available tag statuses [ tagged, untagged, any ], in combination with all count types [ imageCountMoreThan, sinceImagePushed ]. The default output 6 | has a rule_priority $${rule_priority} which can be interpreted by a data "template_file" in a different module. If needed the rule_priority can be overridden. 7 | 8 | ## Examples 9 | 10 | ### Rotate after 30 images exist for ["test","uat","prod"] 11 | 12 | ``` 13 | module "ecr_lifecycle_rule_tagged_image_count_30" { 14 | source = "doingcloudright/ecr-lifecycle-policy-rule/aws" 15 | 16 | tag_status = "tagged" 17 | count_type = "imageCountMoreThan" 18 | prefixes = ["test","uat","prod"] 19 | count_number = 30 20 | } 21 | 22 | output "ecr_lifecycle_rule_tagged_image_count_30" { 23 | value = "${module.ecr_lifecycle_rule_tagged_image_count_30.policy_rule}" 24 | } 25 | ``` 26 | 27 | ### Rotate images after 40 days since image pushed for ["test","uat","prod"] 28 | ``` 29 | module "ecr_lifecycle_rule_tagged_40_days_since_image_pushed" { 30 | source = "doingcloudright/ecr-lifecycle-policy-rule/aws" 31 | 32 | tag_status = "tagged" 33 | count_type = "sinceImagePushed" 34 | count_number = 40 35 | prefixes = ["test","uat","prod"] 36 | } 37 | 38 | output "ecr_lifecycle_rule_tagged_40_days_since_image_pushed" { 39 | value = "${module.ecr_lifecycle_rule_tagged_40_days_since_image_pushed.policy_rule}" 40 | } 41 | ``` 42 | 43 | ### Rotate images after 7 images exist for any 44 | ``` 45 | module "ecr_lifecycle_rule_any_7_images" { 46 | source = "doingcloudright/ecr-lifecycle-policy-rule/aws" 47 | 48 | tag_status = "any" 49 | count_type = "imageCountMoreThan" 50 | count_number = "7" 51 | } 52 | 53 | output "ecr_lifecycle_rule_any_7_images" { 54 | value = "${module.ecr_lifecycle_rule_any_7_images.policy_rule}" 55 | } 56 | ``` 57 | 58 | ### Rotate images after 100 days since image pushed for untagged images 59 | ``` 60 | module "ecr_lifecycle_rule_untagged_100_days_since_image_pushed" { 61 | source = "doingcloudright/ecr-lifecycle-policy-rule/aws" 62 | 63 | tag_status = "untagged" 64 | count_type = "sinceImagePushed" 65 | count_number = "100" 66 | } 67 | 68 | output "ecr_lifecycle_rule_untagged_100_days_since_image_pushed" { 69 | value = "${module.ecr_lifecycle_rule_untagged_100_days_since_image_pushed.policy_rule}" 70 | } 71 | ``` 72 | -------------------------------------------------------------------------------- /main.tf: -------------------------------------------------------------------------------- 1 | locals { 2 | # Validate that the tagstatus is either [ tagged , untagged , any ] 3 | validate_tag_status = "${lookup(var.allowed_tag_status,var.tag_status)}" 4 | 5 | # Validate that the count_type is either [ imageCountMoreThan , sinceImagePushed ] 6 | validate_count_type = "${lookup(var.allowed_count_types,var.count_type)}" 7 | 8 | # We cannot on/and off tagPrefixList and countUnit hence we need to create 4 different data structures with 9 | # 4 different template files. 10 | 11 | # policy rule template for 12 | # countType imageCountMoreThan 13 | # tag_status tagged 14 | policy_based_on_imageCountMoreThan_for_tag_status_tagged = { 15 | rulePriority = "$${rule_priority}" 16 | description = "Rotate images after amount of: $${count_number} is reached for prefix $${prefix_flat}" 17 | 18 | selection = { 19 | tagStatus = "tagged" 20 | tagPrefixList = ["$${prefix}"] 21 | countType = "imageCountMoreThan" 22 | countNumber = "$${count_number}" 23 | } 24 | 25 | action = { 26 | type = "expire" 27 | } 28 | } 29 | # policy rule template for 30 | # countType imageCountMoreThan 31 | # tag_status untagged or any 32 | policy_based_on_imageCountMoreThan_for_tag_status_untagged_or_any = { 33 | rulePriority = "$${rule_priority}" 34 | description = "Rotate images after amount of: $${count_number} is reached for $${tag_status} images" 35 | 36 | selection = { 37 | tagStatus = "$${tag_status}" 38 | countType = "imageCountMoreThan" 39 | countNumber = "$${count_number}" 40 | } 41 | 42 | action = { 43 | type = "expire" 44 | } 45 | } 46 | # policy rule template for 47 | # countType sinceImagePushed 48 | # tag_status tagged 49 | policy_based_on_sinceImagePushed_for_tag_status_tagged = { 50 | rulePriority = "$${rule_priority}" 51 | description = "Rotate images after amount of: $${count_number} days since image pushed, is reached for prefix $${prefix_flat}" 52 | 53 | selection = { 54 | tagStatus = "tagged" 55 | tagPrefixList = ["$${prefix}"] 56 | countType = "sinceImagePushed" 57 | countUnit = "days" 58 | countNumber = "$${count_number}" 59 | } 60 | 61 | action = { 62 | type = "expire" 63 | } 64 | } 65 | # policy rule template for 66 | # countType sinceImagePushed 67 | # tag_status untagged or any 68 | policy_based_on_sinceImagePushed_for_tag_status_untagged_or_any = { 69 | rulePriority = "$${rule_priority}" 70 | description = "Rotate images after amount of: $${count_number} days since image pushed, is reached for $${tag_status} images" 71 | 72 | selection = { 73 | tagStatus = "$${tag_status}" 74 | countNumber = "$${count_number}" 75 | countType = "sinceImagePushed" 76 | countUnit = "days" 77 | } 78 | 79 | action = { 80 | type = "expire" 81 | } 82 | } 83 | } 84 | 85 | # template_file for 86 | # countType imageCountMoreThan 87 | # tag_status tagged 88 | data "template_file" "lifecycle_policy_imageCountMoreThan_tagged" { 89 | count = "${var.create && var.count_type == "imageCountMoreThan" && var.tag_status == "tagged" ? 1 : 0 }" 90 | 91 | template = "${jsonencode(local.policy_based_on_imageCountMoreThan_for_tag_status_tagged)}" 92 | 93 | vars = { 94 | rule_priority = "${var.rule_priority}" 95 | prefix = "${join("\",\"",var.prefixes)}" 96 | prefix_flat = "${join(",",var.prefixes)}" 97 | 98 | count_number = "${var.count_number}" 99 | } 100 | } 101 | 102 | # template_file for 103 | # countType imageCountMoreThan 104 | # tag_status untagged or any 105 | data "template_file" "lifecycle_policy_imageCountMoreThan_untagged_or_any" { 106 | count = "${var.create && var.count_type == "imageCountMoreThan" && var.tag_status != "tagged" ? 1 : 0 }" 107 | 108 | template = "${jsonencode(local.policy_based_on_imageCountMoreThan_for_tag_status_untagged_or_any)}" 109 | 110 | vars = { 111 | rule_priority = "${var.rule_priority}" 112 | tag_status = "${var.tag_status}" 113 | 114 | count_number = "${var.count_number}" 115 | } 116 | } 117 | 118 | # template_file for 119 | # countType sinceImagePushed 120 | # tag_status tagged 121 | data "template_file" "lifecycle_policy_sinceImagePushed_tagged" { 122 | count = "${var.create && var.count_type == "sinceImagePushed" && var.tag_status == "tagged" ? 1 : 0}" 123 | 124 | template = "${jsonencode(local.policy_based_on_sinceImagePushed_for_tag_status_tagged)}" 125 | 126 | vars = { 127 | rule_priority = "${var.rule_priority}" 128 | prefix = "${join("\",\"",var.prefixes)}" 129 | prefix_flat = "${join(",",var.prefixes)}" 130 | 131 | # If there is no count defined in the map var.prefixes_pecific_max_count, we take the var.count_number 132 | count_number = "${var.count_number}" 133 | } 134 | } 135 | 136 | # template_file for 137 | # countType sinceImagePushed 138 | # tag_status untagged or any 139 | data "template_file" "lifecycle_policy_sinceImagePushed_untagged_or_any" { 140 | count = "${var.create && var.count_type == "sinceImagePushed" && var.tag_status != "tagged" ? 1 : 0 }" 141 | 142 | template = "${jsonencode(local.policy_based_on_sinceImagePushed_for_tag_status_untagged_or_any)}" 143 | 144 | vars = { 145 | rule_priority = "${var.rule_priority}" 146 | tag_status = "${var.tag_status}" 147 | 148 | # If there is no count defined in the map var.prefixes_pecific_max_count, we take the var.count_number 149 | count_number = "${var.count_number}" 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /outputs.tf: -------------------------------------------------------------------------------- 1 | # If no priority is set, the default value for priority priority:replace:this will be replaced with $${rule_priority} for later 2 | # template interpolation 3 | output "policy_rule" { 4 | description = "ECR Policy Rule" 5 | 6 | value = "${replace( 7 | replace(element(concat( 8 | data.template_file.lifecycle_policy_imageCountMoreThan_tagged.*.rendered, 9 | data.template_file.lifecycle_policy_imageCountMoreThan_untagged_or_any.*.rendered, 10 | data.template_file.lifecycle_policy_sinceImagePushed_tagged.*.rendered, 11 | data.template_file.lifecycle_policy_sinceImagePushed_untagged_or_any.*.rendered, 12 | [""] 13 | ),0), 14 | "/\"(true|false|[[:digit:]]+)\"/", "$1" 15 | ), "string:", "" 16 | )}" 17 | } 18 | -------------------------------------------------------------------------------- /variables.tf: -------------------------------------------------------------------------------- 1 | variable "create" { 2 | description = "create defines if resources need to be created true/false" 3 | default = true 4 | } 5 | 6 | variable "rule_priority" { 7 | description = "The Priority of the rule, when not given the default priority:replace:this is set for later interpretation/replacement" 8 | default = "priority:replace:this" 9 | } 10 | 11 | variable "count_type" { 12 | description = "The ECR lifecycle image count, [ imageCountMoreThan , sinceImagePushed ]" 13 | } 14 | 15 | variable "allowed_count_types" { 16 | description = "Lookup map to validate the count_type" 17 | 18 | default = { 19 | imageCountMoreThan = "imageCountMoreThan" 20 | sinceImagePushed = "sinceImagePushed" 21 | } 22 | } 23 | 24 | variable "tag_status" { 25 | description = "The tag status of the image for which we create the lifecycle [ tagged, untagged, any ]" 26 | } 27 | 28 | variable "allowed_tag_status" { 29 | description = "Lookup map to validate the count_type" 30 | 31 | default = { 32 | tagged = "tagged" 33 | untagged = "untagged" 34 | any = "any" 35 | } 36 | } 37 | 38 | variable "prefixes" { 39 | description = "prefixes define which prefixes need to have lifecycle rules applied" 40 | default = [] 41 | } 42 | 43 | variable "count_number" { 44 | # count_number sets the default rotation in either imageCountMoreThan or days sinceImagePushed 45 | default = 90 46 | } 47 | --------------------------------------------------------------------------------