From 9d00aeae8aaa3c13f677283c843977afccfa505b Mon Sep 17 00:00:00 2001 From: Marek Kwasecki Date: Fri, 19 May 2017 22:06:47 +0200 Subject: [PATCH] Initial commit Please enjoy and contribute --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 83 ++++++++++++++++++++- main.tf | 106 +++++++++++++++++++++++++++ outputs.tf | 44 +++++++++++ variables.tf | 68 +++++++++++++++++ 5 files changed, 501 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 main.tf create mode 100644 outputs.tf create mode 100644 variables.tf diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed 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 + + http://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. diff --git a/README.md b/README.md index 904aa01..94a6137 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,83 @@ # tf_aws_cloudfront -Terraform module which creates AWS Cloudfront resources +A Terraform module containing typical AWS CloudFront distribution. + +## Assumptions +* HTTPS traffic (so CF will offload HTTPS to HTTP) +* You've uploaded an SSL certificate to AWS/IAM +* Logging is created by default to separate S3 bucket + +## Input Variables +* `name` - [mandatory] name you will see in i.e. in tags. +* `certificate_arn` - [mandatory] Existing certificate arn. +* `domains` - list of CNAME's to be associated with the CF (can be empty). +* `bucket_name` - S3 bucket name to be source for data served by CF. +* `compress` - Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. +* `ipv6_enabled` - Whether the IPv6 is enabled for the distribution. +* `comment` - Comment used in both `aws_cloudfront_origin_access_identity` and `aws_cloudfront_distribution`. +* `log_include_cookies` - Specifies whether you want CloudFront to include cookies in access logs. +* `log_bucket` - Name of the bucket to place CF access logs. +* `log_prefix` - An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, `cf_logs/.`. +* `price_class` - The price class for this distribution. One of PriceClass_All, PriceClass_200, PriceClass_100 (default). +* `viewer_protocol_policy` - Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. One of allow-all, https-only, or redirect-to-https (default). +* `allowed_methods` - Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. +* `cached_methods` - Controls whether CloudFront caches the response to requests using the specified HTTP methods. +* `min_ttl` - The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. +* `max_ttl` - The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of Cache-Control max-age, Cache-Control s-maxage, and Expires headers. +* `default_ttl` - The default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an Cache-Control max-age or Expires header. +* `tags` - A mapping of tags to assign to the resource. By default `Name` is set. + +## Outputs +* cf_id - The identifier for the distribution. For example: EDFDVBD632BHDS5. +* cf_arn - The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. +* cf_status - The current status of the distribution. Deployed if the distribution's information is fully propagated throughout the Amazon CloudFront system. +* active_trusted_signers - The key pair IDs that CloudFront is aware of for each trusted signer, if the distribution is set up to serve private content with signed URLs. +* cf_domain_name - The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net. +* cf_etag - The current version of the distribution's information. For example: E2QWRUHAPOMQZL. +* cf_hosted_zone_id - The CloudFront Route 53 zone ID that can be used to route an Alias Resource Record Set to. This attribute is simply an alias for the zone ID Z2FDTNDATAQYW2. +* s3_bucket_id - S3 bucket id +* s3_bucket_arn - S3 bucket arn + +## Usage example: +``` +module "cf_distro" { + source = "github.com/terraform-community-modules/tf_aws_cf" + name = "tf-${terraform.env}-my-cf" + domains = ["whatever-${terraform.env}.${var.domain}"] + certificate_arn = "arn:aws:acm:us-east-1:123456789123:certificate/11111111-2222-3333-4444-555555555555" + + bucket_name = "tf-${terraform.env}-my-cf-bucket" + comment = "Managed by Terraform" + + log_include_cookies = "false" + log_bucket = "tf-${terraform.env}-log-bucket-for-my-cf" + + allowed_methods = ["GET", "HEAD"] + + tags = { + "Terraform" = "true" + "Environment" = "${terraform.env}" + } +} +``` + +## Contributing +Report issues/questions/feature requests on in the [Issues](https://github.com/terraform-community-modules/tf_aws_cf/issues) section. + +Pull requests are welcome! Ideally create a feature branch and issue for every +individual change you make. These are the steps: + +1. Fork the repo. +2. Create your feature branch from master (`git checkout -b my-new-feature`). +4. Commit your awesome changes (`git commit -am 'Added some feature'`). +5. Push to the branch (`git push origin my-new-feature`). +6. Create a new Pull Request and tell us about your changes. + +## Change log +For description of changes please refer to commit descriptions + +## Authors +Created and maintained by [Marek Kwasecki](https://github.com/kwach) - marek.kwasecki@radpoint.pl. + +## License +Apache v2.0 Licensed. See [LICENSE](LICENSE) for full details. + diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..453d860 --- /dev/null +++ b/main.tf @@ -0,0 +1,106 @@ +# --- S3 bucket --- + +data "aws_iam_policy_document" "s3_policy_cf_bucket" { + statement { + actions = ["s3:GetObject"] + resources = ["arn:aws:s3:::${var.bucket_name}/*"] + + principals { + type = "AWS" + identifiers = ["${aws_cloudfront_origin_access_identity.origin_access_identity.iam_arn}"] + } + } + + statement { + actions = ["s3:ListBucket"] + resources = ["arn:aws:s3:::${var.bucket_name}"] + + principals { + type = "AWS" + identifiers = ["${aws_cloudfront_origin_access_identity.origin_access_identity.iam_arn}"] + } + } +} + +resource "aws_s3_bucket" "bucket" { + bucket = "${var.bucket_name}" + acl = "private" + policy = "${data.aws_iam_policy_document.s3_policy_cf_bucket.json}" + + tags = "${merge("${var.tags}", map("Name", format("%s-bucket", var.name)))}" +} + +# --- CloudFront --- + +resource "aws_cloudfront_origin_access_identity" "origin_access_identity" { + comment = "access-identity-${var.name}" +} + +resource "aws_s3_bucket" "log_bucket" { + bucket = "${var.log_bucket}" + #policy = "${data.aws_iam_policy_document.s3_policy_cf_logs.json}" + force_destroy = true + + tags = "${merge(var.tags, map("Name", format("%s", var.log_bucket)))}" +} + +resource "aws_cloudfront_distribution" "cf" { + enabled = "true" + is_ipv6_enabled = "${var.ipv6_enabled}" + comment = "${var.comment}" + default_root_object = "index.html" + price_class = "${var.price_class}" + + logging_config = { + include_cookies = "${var.log_include_cookies}" + bucket = "${var.log_bucket}.s3.amazonaws.com" + prefix = "${var.log_prefix}" + } + + aliases = ["${var.domains}"] + + origin { + domain_name = "${aws_s3_bucket.bucket.bucket_domain_name}" + origin_id = "${var.bucket_name}" + + s3_origin_config { + origin_access_identity = "${aws_cloudfront_origin_access_identity.origin_access_identity.cloudfront_access_identity_path}" + } + } + + viewer_certificate { + acm_certificate_arn = "${var.certificate_arn}" + ssl_support_method = "sni-only" + minimum_protocol_version = "TLSv1" + } + + default_cache_behavior { + allowed_methods = "${var.allowed_methods}" + cached_methods = "${var.cached_methods}" + target_origin_id = "${var.bucket_name}" + compress = "${var.compress}" + + forwarded_values { + query_string = false + + cookies { + forward = "none" + } + } + + viewer_protocol_policy = "${var.viewer_protocol_policy}" + min_ttl = "${var.min_ttl}" + default_ttl = "${var.default_ttl}" + max_ttl = "${var.max_ttl}" + } + + "restrictions" { + "geo_restriction" { + restriction_type = "none" + } + } + + tags = "${merge("${var.tags}", map("Name", format("%s", var.name)))}" + + depends_on = ["aws_s3_bucket.log_bucket"] +} diff --git a/outputs.tf b/outputs.tf new file mode 100644 index 0000000..293a8d9 --- /dev/null +++ b/outputs.tf @@ -0,0 +1,44 @@ +#The identifier for the distribution. For example: EDFDVBD632BHDS5. +output "cf_id" { + value = "${aws_cloudfront_distribution.cf.id}" +} + +#The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. +output "cf_arn" { + value = "${aws_cloudfront_distribution.cf.arn}" +} + +#The current status of the distribution. Deployed if the distribution's information is fully propagated throughout the Amazon CloudFront system. +output "cf_status" { + value = "${aws_cloudfront_distribution.cf.status}" +} + +#active_trusted_signers - The key pair IDs that CloudFront is aware of for each trusted signer, if the distribution is set up to serve private content with signed URLs. +output "cf_active_trusted_signers" { + value = "${aws_cloudfront_distribution.cf.active_trusted_signers}" +} + +#The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net. +output "cf_domain_name" { + value = "${aws_cloudfront_distribution.cf.domain_name}" +} + +#The current version of the distribution's information. For example: E2QWRUHAPOMQZL. +output "cf_etag" { + value = "${aws_cloudfront_distribution.cf.etag}" +} + +#The CloudFront Route 53 zone ID that can be used to route an Alias Resource Record Set to. This attribute is simply an alias for the zone ID Z2FDTNDATAQYW2. +output "cf_hosted_zone_id" { + value = "${aws_cloudfront_distribution.cf.hosted_zone_id}" +} + +#S3 bucket id +output "s3_bucket_id" { + value = "${aws_s3_bucket.bucket.id}" +} + +#S3 bucket arn +output "s3_bucket_arn" { + value = "${aws_s3_bucket.bucket.arn}" +} diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..7ddeebf --- /dev/null +++ b/variables.tf @@ -0,0 +1,68 @@ +variable "name" {} + +variable "certificate_arn" { + description = "Existing certificate arn." +} + +variable "domains" { + type = "list" + default = [] +} + +variable "bucket_name" { + default = "tf-cf-bucket" +} + +variable "compress" { + default = "false" +} + +variable "ipv6_enabled" { + default = "true" +} + +variable "comment" { + default = "Managed by Terraform" +} + +variable "log_include_cookies" { + default = "false" +} + +variable "log_bucket" { } + +variable "log_prefix" { + default = "cf_logs" +} + +variable "price_class" { + default = "PriceClass_100" +} + +variable "viewer_protocol_policy" { + #default = "allow-all" + default = "redirect-to-https" +} + +variable "allowed_methods" { + type = "list" + default = ["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"] +} +variable "cached_methods" { + type = "list" + default = ["GET", "HEAD"] +} + +variable "min_ttl" { + default = "0" +} +variable "max_ttl" { + default = "31536000" +} +variable "default_ttl" { + default = "60" +} + +variable "tags" { + default = {} +}