Terraform provider for various utilities (deep merging, stack configuration management), and to add additional missing functionality to Terraform
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
Here is how to use this provider in your own Terraform code:
terraform {
required_providers {
utils = {
source = "cloudposse/utils"
version = ">= 0.3.0"
}
}
}See the Docs for additional information.
Here is an example of using this provider:
terraform {
required_providers {
utils = {
source = "cloudposse/utils"
}
}
}
locals {
yaml_data_1 = file("${path.module}/data1.yaml")
yaml_data_2 = file("${path.module}/data2.yaml")
}
data "utils_deep_merge_yaml" "example" {
input = [
local.yaml_data_1,
local.yaml_data_2
]
}
output "deep_merge_output" {
value = data.utils_deep_merge_yaml.example.output
}Here are some additional examples:
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 testaccYou 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/utils" = "/path/to/your/code/github.com/cloudposse/terraform-provider-utils/"
}
# 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 {
utils = {
source = "cloudposse/utils"
}
}Then run terraform init, terraform plan and terraform apply as normal.
$ terraform init
Initializing the backend...
Initializing provider plugins...
- Finding latest version of cloudposse/utils...
Warning: Provider development overrides are in effect
The following provider development overrides are set in the CLI configuration:
- cloudposse/utils in /path/to/your/code/github.com/cloudposse/terraform-provider-utils
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/utils in /Users/matt/code/src/github.com/cloudposse/terraform-provider-utils
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: 0 to add, 0 to change, 0 to destroy.
Changes to Outputs:
+ deep_merge_output = <<-EOT
Statement:
- Action:
- s3:*
Effect: Allow
Resource:
- '*'
Sid: FullAccess
- Action:
- s3:*
Complex:
ExtraComplex:
ExtraExtraComplex:
Foo: bazzz
SomeArray:
- one
- two
- three
Effect: Deny
Resource:
- arn:aws:s3:::customer
- arn:aws:s3:::customer/*
- foo
Sid: DenyCustomerBucket
Version: "2012-10-17"
EOTLike 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. =)
Check out these related projects.
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.
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
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.
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.
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.
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.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
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 © 2021-2021 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
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 ❤️ Open Source Software.
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.
 Matt Calhoun |
 Andriy Knysh |
 Erik Osterman |
|---|