Terraform provider for performing various tasks that cannot be performed with the official AWS Terraform Provider from Hashicorp.
This provider is derived in large parts from the official HashiCorp AWS provider. We copied all the boilerplate functionality so that it follows the terraform-provider-aws
conventions, but then removed all the standard resources and added in our own. This module is intended to be used as an escape hatch to accomplish all the hard things that will never be supported by the official provider due to strong (and valid) opinions of how providers should manage the lifecycle of a resource. Unfortunately, in the real-world we have to make tradeoffs to get stuff done. That's this provider in a nutshell.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
Usage
Here is how to use this provider in your own Terraform code:
terraform {
required_providers {
awsutils = {
source = "cloudposse/awsutils"
version = ">= 0.1.0"
}
}
}
See the Docs for additional information.
Examples
Here is an example of using this provider:
terraform {
required_providers {
awsutils = {
source = "cloudposse/awsutils"
}
}
}
Here are some additional examples:
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).
To compile the provider, run go install
. This will build the provider and put the provider binary in the $GOPATH/bin
directory.
To generate or update documentation, run go generate
.
In order to run the full suite of Acceptance tests, run make testacc
.
Note: Acceptance tests create real resources, and often cost money to run.
$ make testacc
Testing Locally
You can test the provider locally by using the provider_installation functionality.
For testing this provider, you can edit your ~/.terraformrc
file with the following:
provider_installation {
dev_overrides {
"cloudposse/awsutils" = "/path/to/your/code/github.com/cloudposse/terraform-provider-awsutils/"
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
With that in place, you can build the provider (see above) and add a provider block:
required_providers {
awsutils = {
source = "cloudposse/awsutils"
}
}
Then run terraform init
, terraform plan
and terraform apply
as normal.
$ terraform init
Initializing the backend...
Initializing provider plugins...
- Finding latest version of cloudposse/awsutils...
Warning: Provider development overrides are in effect
The following provider development overrides are set in the CLI configuration:
- cloudposse/awsutils in /path/to/your/code/github.com/cloudposse/terraform-provider-awsutils
The behavior may therefore not match any released version of the provider and
applying changes may cause the state to become incompatible with published
releases.
terraform apply
Warning: Provider development overrides are in effect
The following provider development overrides are set in the CLI configuration:
- cloudposse/awsutils in /Users/matt/code/src/github.com/cloudposse/terraform-provider-awsutils
The behavior may therefore not match any released version of the provider and
applying changes may cause the state to become incompatible with published
releases.
An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
Terraform will perform the following actions:
Plan: 1 to add, 0 to change, 0 to destroy.
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.
- Cloud Posse Terraform Utils Provider - Terraform provider for various utilities (deep merging, stack configuration management), and to add additional missing functionality to Terraform
References
For additional context, refer to some of these links.
- Terraform Plugins - Terraform is logically split into two main parts: Terraform Core and Terraform Plugins. Each plugin exposes an implementation for a specific service, such as the AWS provider or the cloud-init provider.
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!
Copyrights
Copyright © 2021-2021 Cloud Posse, LLC
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
Matt Calhoun |
---|