-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial implementation * Add outputs * test examples * move curl args to var * fix test for CI * output sha256 * Update docs
- Loading branch information
Showing
14 changed files
with
550 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
.build-harness | ||
build-harness | ||
.terraform | ||
*.tfstate | ||
*.tfstate.* | ||
.idea | ||
*.iml | ||
.viminfo | ||
.terraform.d |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
addons: | ||
apt: | ||
packages: | ||
- git | ||
- make | ||
- curl | ||
|
||
install: | ||
- make init | ||
|
||
script: | ||
- make terraform/install | ||
- make terraform/get-plugins | ||
- make terraform/get-modules | ||
- make terraform/lint | ||
- make test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
SHELL := /bin/bash | ||
|
||
# List of targets the `readme` target should call before generating the readme | ||
export README_DEPS ?= docs/targets.md docs/terraform.md | ||
|
||
-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness) | ||
|
||
## Lint terraform code | ||
lint: | ||
$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate | ||
|
||
test: | ||
$(MAKE) -C examples/ test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,288 @@ | ||
# terraform-data-external-module-artifact | ||
Terraform module to fetch any kind of artifacts using curl (binary and text okay) | ||
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
[![README Header][readme_header_img]][readme_header_link] | ||
|
||
[![Cloud Posse][logo]](https://cpco.io/homepage) | ||
|
||
# terraform-external-module-artifact [![Build Status](https://travis-ci.org/cloudposse/terraform-external-module-artifact.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-external-module-artifact) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-external-module-artifact.svg)](https://github.com/cloudposse/terraform-external-module-artifact/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) | ||
|
||
|
||
Terraform Module to fetch remote build artifacts via http(s) using `curl`. | ||
|
||
|
||
--- | ||
|
||
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps. | ||
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email] | ||
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus] | ||
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook] | ||
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit] | ||
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin] | ||
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter] | ||
|
||
|
||
[![Terraform Open Source Modules](https://docs.cloudposse.com/images/terraform-open-source-modules.svg)][terraform_modules] | ||
|
||
|
||
|
||
It's 100% Open Source and licensed under the [APACHE2](LICENSE). | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out! | ||
|
||
|
||
|
||
|
||
|
||
|
||
## Introduction | ||
|
||
This terraform module uses the [`external`](https://www.terraform.io/docs/providers/external/data_source.html) data provider to execute `curl`, which downloads the file locally to the modules cache folder. | ||
|
||
It's ideally suited for downloading public build artifacts (E.g. for use with Lambdas) associated with terraform modules. | ||
We recommend using this pattern to avoid adding binary artifacts like `.zip` files to Git repositories. | ||
|
||
**NOTE:** The term `external` refers to the primary Terraform [provider](https://www.terraform.io/docs/providers/external/data_source.html) used in this module. | ||
|
||
## Dependencies | ||
|
||
First make sure you have `curl` installed and that it exists in your `PATH` (E.g. `/usr/bin`). | ||
|
||
## Usage | ||
|
||
|
||
```hcl | ||
module "example" { | ||
source = "git::https://github.com/cloudposse/terraform-external-module-artifact.git?ref=master" | ||
filename = "test.zip" | ||
git_ref = "example" | ||
module_name = "terraform-external-module-artifact" | ||
module_path = "${path.module}" | ||
} | ||
``` | ||
|
||
__NOTE:__ Leave `git_ref` blank and it will be automatically computed from the `module_path` | ||
__NOTE:__ We've published [an artifact](https://artifacts.cloudposse.com/terraform-external-module-artifact/example/test.zip) for purpose of testing this module | ||
|
||
|
||
|
||
|
||
|
||
|
||
## Makefile Targets | ||
``` | ||
Available targets: | ||
help Help screen | ||
help/all Display help for all targets | ||
help/short This help short screen | ||
lint Lint terraform code | ||
``` | ||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|:----:|:-----:|:-----:| | ||
| curl_arguments | Arguments that should get passed to `curl` | string | `-sSL` | no | | ||
| filename | Artifact filename | string | `lambda.zip` | no | | ||
| git_ref | Git hash corresponding to the remote artifact. Leave blank and it will be computed from the `module_path` checkout | string | `` | no | | ||
| module_name | Name of the terraform module | string | - | yes | | ||
| module_path | Local path to the terraform module; e.g. `${path.module}` | string | - | yes | | ||
| url | URL template for the remote artifact | string | `https://artifacts.cloudposse.com/$${module_name}/$${git_ref}/$${filename}` | no | | ||
|
||
## Outputs | ||
|
||
| Name | Description | | ||
|------|-------------| | ||
| base64sha256 | Base64 encoded SHA256 hash of the local file | | ||
| file | Full path to the locally downloaded file | | ||
| git_ref | Git commit hash corresponding to the artifact | | ||
| url | URL corresponding to the artifact | | ||
|
||
|
||
|
||
|
||
## Share the Love | ||
|
||
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/terraform-external-module-artifact)! (it helps us **a lot**) | ||
|
||
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =) | ||
|
||
|
||
## Related Projects | ||
|
||
Check out these related projects. | ||
|
||
- [terraform-null-smtp-mail](https://github.com/cloudposse/terraform-null-smtp-mail) - Terraform module to send transactional emails via an SMTP server (e.g. mailgun) | ||
|
||
|
||
|
||
|
||
## References | ||
|
||
For additional context, refer to some of these links. | ||
|
||
- [curl](https://curl.haxx.se/) - command line tool and library for transferring data with URLs | ||
|
||
|
||
## Help | ||
|
||
**Got a question?** | ||
|
||
File a GitHub [issue](https://github.com/cloudposse/terraform-external-module-artifact/issues), send us an [email][email] or join our [Slack Community][slack]. | ||
|
||
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link] | ||
|
||
## Commercial Support | ||
|
||
Work directly with our team of DevOps experts via email, slack, and video conferencing. | ||
|
||
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer. | ||
|
||
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email] | ||
|
||
- **Questions.** We'll use a Shared Slack channel between your team and ours. | ||
- **Troubleshooting.** We'll help you triage why things aren't working. | ||
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback. | ||
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects. | ||
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure. | ||
- **Cloud Architecture.** We'll assist with your cloud strategy and design. | ||
- **Implementation.** We'll provide hands-on support to implement our reference architectures. | ||
|
||
|
||
|
||
## Terraform Module Development | ||
|
||
Are you interested in custom Terraform module development? Submit your inquiry using [our form][module_development] today and we'll get back to you ASAP. | ||
|
||
|
||
## Slack Community | ||
|
||
Join our [Open Source Community][slack] 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. | ||
|
||
## Newsletter | ||
|
||
Signup for [our newsletter][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. | ||
|
||
## Contributing | ||
|
||
### Bug Reports & Feature Requests | ||
|
||
Please use the [issue tracker](https://github.com/cloudposse/terraform-external-module-artifact/issues) 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](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email]. | ||
|
||
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. | ||
|
||
1. **Fork** the repo on GitHub | ||
2. **Clone** the project to your own machine | ||
3. **Commit** changes to your own branch | ||
4. **Push** your work back up to your fork | ||
5. 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-2018 [Cloud Posse, LLC](https://cpco.io/copyright) | ||
|
||
|
||
|
||
## License | ||
|
||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | ||
|
||
See [LICENSE](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][website]. Like it? Please let us know by [leaving a testimonial][testimonial]! | ||
|
||
[![Cloud Posse][logo]][website] | ||
|
||
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source]. | ||
|
||
We offer [paid support][commercial_support] on all of our projects. | ||
|
||
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. | ||
|
||
|
||
|
||
### Contributors | ||
|
||
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | | ||
|---| | ||
|
||
[osterman_homepage]: https://github.com/osterman | ||
[osterman_avatar]: https://github.com/osterman.png?size=150 | ||
|
||
|
||
|
||
[![README Footer][readme_footer_img]][readme_footer_link] | ||
[![Beacon][beacon]][website] | ||
|
||
[logo]: https://cloudposse.com/logo-300x69.svg | ||
[docs]: https://cpco.io/docs | ||
[website]: https://cpco.io/homepage | ||
[github]: https://cpco.io/github | ||
[jobs]: https://cpco.io/jobs | ||
[hire]: https://cpco.io/hire | ||
[slack]: https://cpco.io/slack | ||
[linkedin]: https://cpco.io/linkedin | ||
[twitter]: https://cpco.io/twitter | ||
[testimonial]: https://cpco.io/leave-testimonial | ||
[newsletter]: https://cpco.io/newsletter | ||
[email]: https://cpco.io/email | ||
[commercial_support]: https://cpco.io/commercial-support | ||
[we_love_open_source]: https://cpco.io/we-love-open-source | ||
[module_development]: https://cpco.io/module-development | ||
[terraform_modules]: https://cpco.io/terraform-modules | ||
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/terraform-external-module-artifact | ||
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/terraform-external-module-artifact | ||
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/terraform-external-module-artifact | ||
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/terraform-external-module-artifact | ||
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/terraform-external-module-artifact | ||
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/terraform-external-module-artifact | ||
[share_twitter]: https://twitter.com/intent/tweet/?text=terraform-external-module-artifact&url=https://github.com/cloudposse/terraform-external-module-artifact | ||
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=terraform-external-module-artifact&url=https://github.com/cloudposse/terraform-external-module-artifact | ||
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/terraform-external-module-artifact | ||
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/terraform-external-module-artifact | ||
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/terraform-external-module-artifact | ||
[share_email]: mailto:?subject=terraform-external-module-artifact&body=https://github.com/cloudposse/terraform-external-module-artifact | ||
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-external-module-artifact?pixel&cs=github&cm=readme&an=terraform-external-module-artifact |
Oops, something went wrong.