├── .github ├── CODEOWNERS ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ ├── config.yml │ ├── feature_request.yml │ └── question.md ├── PULL_REQUEST_TEMPLATE.md ├── banner.png ├── mergify.yml ├── renovate.json ├── settings.yml └── workflows │ ├── branch.yml │ ├── chatops.yml │ ├── release.yml │ └── scheduled.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── README.yaml ├── docs ├── targets.md └── terraform.md ├── main.tf ├── outputs.tf ├── variables.tf └── versions.tf /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # Use this file to define individuals or teams that are responsible for code in a repository. 2 | # Read more: 3 | # 4 | # Order is important: the last matching pattern has the highest precedence 5 | 6 | # These owners will be the default owners for everything 7 | * @cloudposse/engineering @cloudposse/contributors 8 | 9 | # Cloud Posse must review any changes to Makefiles 10 | **/Makefile @cloudposse/engineering 11 | **/Makefile.* @cloudposse/engineering 12 | 13 | # Cloud Posse must review any changes to GitHub actions 14 | .github/* @cloudposse/engineering 15 | 16 | # Cloud Posse must review any changes to standard context definition, 17 | # but some changes can be rubber-stamped. 18 | **/*.tf @cloudposse/engineering @cloudposse/contributors @cloudposse/approvers 19 | README.yaml @cloudposse/engineering @cloudposse/contributors @cloudposse/approvers 20 | README.md @cloudposse/engineering @cloudposse/contributors @cloudposse/approvers 21 | docs/*.md @cloudposse/engineering @cloudposse/contributors @cloudposse/approvers 22 | 23 | # Cloud Posse Admins must review all changes to CODEOWNERS or the mergify configuration 24 | .github/mergify.yml @cloudposse/admins 25 | .github/CODEOWNERS @cloudposse/admins 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | description: Create a report to help us improve 4 | labels: ["bug"] 5 | assignees: [""] 6 | body: 7 | - type: markdown 8 | attributes: 9 | value: | 10 | Found a bug? 11 | 12 | Please checkout our [Slack Community](https://slack.cloudposse.com) 13 | or visit our [Slack Archive](https://archive.sweetops.com/). 14 | 15 | [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) 16 | 17 | - type: textarea 18 | id: concise-description 19 | attributes: 20 | label: Describe the Bug 21 | description: A clear and concise description of what the bug is. 22 | placeholder: What is the bug about? 23 | validations: 24 | required: true 25 | 26 | - type: textarea 27 | id: expected 28 | attributes: 29 | label: Expected Behavior 30 | description: A clear and concise description of what you expected. 31 | placeholder: What happened? 32 | validations: 33 | required: true 34 | 35 | - type: textarea 36 | id: reproduction-steps 37 | attributes: 38 | label: Steps to Reproduce 39 | description: Steps to reproduce the behavior. 40 | placeholder: How do we reproduce it? 41 | validations: 42 | required: true 43 | 44 | - type: textarea 45 | id: screenshots 46 | attributes: 47 | label: Screenshots 48 | description: If applicable, add screenshots or logs to help explain. 49 | validations: 50 | required: false 51 | 52 | - type: textarea 53 | id: environment 54 | attributes: 55 | label: Environment 56 | description: Anything that will help us triage the bug. 57 | placeholder: | 58 | - OS: [e.g. Linux, OSX, WSL, etc] 59 | - Version [e.g. 10.15] 60 | - Module version 61 | - Terraform version 62 | validations: 63 | required: false 64 | 65 | - type: textarea 66 | id: additional 67 | attributes: 68 | label: Additional Context 69 | description: | 70 | Add any other context about the problem here. 71 | validations: 72 | required: false 73 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | 3 | contact_links: 4 | 5 | - name: Community Slack Team 6 | url: https://cloudposse.com/slack/ 7 | about: |- 8 | Please ask and answer questions here. 9 | 10 | - name: Office Hours 11 | url: https://cloudposse.com/office-hours/ 12 | about: |- 13 | Join us every Wednesday for FREE Office Hours (lunch & learn). 14 | 15 | - name: DevOps Accelerator Program 16 | url: https://cloudposse.com/accelerate/ 17 | about: |- 18 | Own your infrastructure in record time. We build it. You drive it. 19 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | description: Suggest an idea for this project 4 | labels: ["feature request"] 5 | assignees: [""] 6 | body: 7 | - type: markdown 8 | attributes: 9 | value: | 10 | Have a question? 11 | 12 | Please checkout our [Slack Community](https://slack.cloudposse.com) 13 | or visit our [Slack Archive](https://archive.sweetops.com/). 14 | 15 | [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) 16 | 17 | - type: textarea 18 | id: concise-description 19 | attributes: 20 | label: Describe the Feature 21 | description: A clear and concise description of what the feature is. 22 | placeholder: What is the feature about? 23 | validations: 24 | required: true 25 | 26 | - type: textarea 27 | id: expected 28 | attributes: 29 | label: Expected Behavior 30 | description: A clear and concise description of what you expected. 31 | placeholder: What happened? 32 | validations: 33 | required: true 34 | 35 | - type: textarea 36 | id: use-case 37 | attributes: 38 | label: Use Case 39 | description: | 40 | Is your feature request related to a problem/challenge you are trying 41 | to solve? 42 | 43 | Please provide some additional context of why this feature or 44 | capability will be valuable. 45 | validations: 46 | required: true 47 | 48 | - type: textarea 49 | id: ideal-solution 50 | attributes: 51 | label: Describe Ideal Solution 52 | description: A clear and concise description of what you want to happen. 53 | validations: 54 | required: true 55 | 56 | - type: textarea 57 | id: alternatives-considered 58 | attributes: 59 | label: Alternatives Considered 60 | description: Explain alternative solutions or features considered. 61 | validations: 62 | required: false 63 | 64 | - type: textarea 65 | id: additional 66 | attributes: 67 | label: Additional Context 68 | description: | 69 | Add any other context about the problem here. 70 | validations: 71 | required: false 72 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudposse-archives/terraform-null-ansible/653dea1ded3eda794b58785cb7ad6db4c9fa4416/.github/ISSUE_TEMPLATE/question.md -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## what 2 | 3 | 7 | 8 | ## why 9 | 10 | 15 | 16 | ## references 17 | 18 | 22 | -------------------------------------------------------------------------------- /.github/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cloudposse-archives/terraform-null-ansible/653dea1ded3eda794b58785cb7ad6db4c9fa4416/.github/banner.png -------------------------------------------------------------------------------- /.github/mergify.yml: -------------------------------------------------------------------------------- 1 | extends: .github 2 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "config:base", 4 | ":preserveSemverRanges" 5 | ], 6 | "baseBranches": ["main", "master", "/^release\\/v\\d{1,2}$/"], 7 | "labels": ["auto-update"], 8 | "dependencyDashboardAutoclose": true, 9 | "enabledManagers": ["terraform"], 10 | "terraform": { 11 | "ignorePaths": ["**/context.tf", "examples/**"] 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /.github/settings.yml: -------------------------------------------------------------------------------- 1 | # Upstream changes from _extends are only recognized when modifications are made to this file in the default branch. 2 | _extends: .github 3 | repository: 4 | name: terraform-null-ansible 5 | description: Terraform Module to run ansible playbooks 6 | homepage: https://cloudposse.com/accelerate 7 | topics: terraform, terraform-modules, ansible, playbook, ansible-playbook, hcl2 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /.github/workflows/branch.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Branch 3 | on: 4 | pull_request: 5 | branches: 6 | - main 7 | - release/** 8 | types: [opened, synchronize, reopened, labeled, unlabeled] 9 | push: 10 | branches: 11 | - main 12 | - release/v* 13 | paths-ignore: 14 | - '.github/**' 15 | - 'docs/**' 16 | - 'examples/**' 17 | - 'test/**' 18 | - 'README.md' 19 | 20 | permissions: {} 21 | 22 | jobs: 23 | terraform-module: 24 | uses: cloudposse/.github/.github/workflows/shared-terraform-module.yml@main 25 | secrets: inherit 26 | -------------------------------------------------------------------------------- /.github/workflows/chatops.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: chatops 3 | on: 4 | issue_comment: 5 | types: [created] 6 | 7 | permissions: 8 | pull-requests: write 9 | id-token: write 10 | contents: write 11 | statuses: write 12 | 13 | jobs: 14 | test: 15 | uses: cloudposse/.github/.github/workflows/shared-terraform-chatops.yml@main 16 | if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '/terratest') }} 17 | secrets: inherit 18 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: release 3 | on: 4 | release: 5 | types: 6 | - published 7 | 8 | permissions: 9 | id-token: write 10 | contents: write 11 | pull-requests: write 12 | 13 | jobs: 14 | terraform-module: 15 | uses: cloudposse/.github/.github/workflows/shared-release-branches.yml@main 16 | secrets: inherit 17 | -------------------------------------------------------------------------------- /.github/workflows/scheduled.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: scheduled 3 | on: 4 | workflow_dispatch: { } # Allows manually trigger this workflow 5 | schedule: 6 | - cron: "0 3 * * *" 7 | 8 | permissions: 9 | pull-requests: write 10 | id-token: write 11 | contents: write 12 | 13 | jobs: 14 | scheduled: 15 | uses: cloudposse/.github/.github/workflows/shared-terraform-scheduled.yml@main 16 | secrets: inherit 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled files 2 | *.tfstate 3 | *.tfstate.backup 4 | 5 | # Module directory 6 | .terraform/ 7 | 8 | # Local values for vars 9 | terraform.tfvars 10 | 11 | *.zip 12 | 13 | .build-harness 14 | build-harness -------------------------------------------------------------------------------- /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 2017 Cloud Posse, LLC 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL := /bin/bash 2 | 3 | # List of targets the `readme` target should call before generating the readme 4 | export README_DEPS ?= docs/targets.md docs/terraform.md 5 | 6 | -include $(shell curl -sSL -o .build-harness "https://cloudposse.tools/build-harness"; echo .build-harness) 7 | 8 | ## Lint terraform code 9 | lint: 10 | $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Project Banner
5 |

6 | Latest ReleaseLast UpdatedSlack Community

7 | 8 | 9 | 29 | 30 | Terraform Module to run ansible playbooks. 31 | 32 | 33 | > [!TIP] 34 | > #### 👽 Use Atmos with Terraform 35 | > Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform.
36 | > Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift). 37 | > 38 | >
39 | > Watch demo of using Atmos with Terraform 40 | >
41 | > Example of running atmos to manage infrastructure from our Quick Start tutorial. 42 | > 43 | 44 | 45 | 46 | 47 | 48 | ## Usage 49 | 50 | ### Add special section to the playbook 51 | 52 | You must add this section on the top of all playbooks that will be used for provisioning. 53 | 54 | This will add a dynamic inventory to target the host that needs provisioning. 55 | 56 | e.g. `../ansible/playbooks/playbook.yml` 57 | 58 | * Create a runtime inventorty with an ip address of a host 59 | * Wait for target host is ready for ssh connection 60 | 61 | ```yaml 62 | 63 | --- 64 | - hosts: localhost 65 | gather_facts: True 66 | check_mode: no 67 | tasks: 68 | - name: Add public ip addresses to an dynamic inventory 69 | add_host: 70 | name: "{{ host }}" 71 | groups: all 72 | 73 | - local_action: wait_for port=22 host="{{ host }}" search_regex=OpenSSH delay=10 74 | 75 | - hosts: all 76 | gather_facts: False 77 | check_mode: no 78 | become: True 79 | tasks: 80 | - name: Install python 2.7 81 | raw: > 82 | test -e /usr/bin/python || 83 | ( 84 | (test -e /usr/bin/apt-get && (apt-get -y update && apt-get install -y python)) || 85 | (test -e /usr/bin/yum && (yum makecache fast && yum install -y python)) 86 | ) 87 | args: 88 | creates: /usr/bin/python 89 | ``` 90 | 91 | ### Create an aws instance 92 | 93 | ```hcl 94 | resource "aws_instance" "web" { 95 | ami = "ami-408c7f28" 96 | instance_type = "t1.micro" 97 | tags { 98 | Name = test1 99 | } 100 | } 101 | ``` 102 | 103 | ### Apply the provisioner module to this resource 104 | 105 | ```hcl 106 | module "ansible_provisioner" { 107 | source = "github.com/cloudposse/tf_ansible" 108 | 109 | arguments = ["--user=ubuntu"] 110 | envs = ["host=${aws_instance.web.public_ip}"] 111 | playbook = "../ansible/playbooks/test.yml" 112 | dry_run = false 113 | 114 | } 115 | ``` 116 | 117 | > [!IMPORTANT] 118 | > In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation 119 | > and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version 120 | > you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic 121 | > approach for updating versions to avoid unexpected changes. 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | ## Makefile Targets 132 | ```text 133 | Available targets: 134 | 135 | help Help screen 136 | help/all Display help for all targets 137 | help/short This help short screen 138 | lint Lint terraform code 139 | 140 | ``` 141 | 142 | 143 | ## Requirements 144 | 145 | | Name | Version | 146 | |------|---------| 147 | | [terraform](#requirement\_terraform) | >= 0.12 | 148 | | [archive](#requirement\_archive) | ~> 2.2.0 | 149 | | [null](#requirement\_null) | ~> 3.2.0 | 150 | | [random](#requirement\_random) | ~> 3.6.0 | 151 | 152 | ## Providers 153 | 154 | | Name | Version | 155 | |------|---------| 156 | | [archive](#provider\_archive) | ~> 2.2.0 | 157 | | [null](#provider\_null) | ~> 3.2.0 | 158 | | [random](#provider\_random) | ~> 3.6.0 | 159 | 160 | ## Modules 161 | 162 | No modules. 163 | 164 | ## Resources 165 | 166 | | Name | Type | 167 | |------|------| 168 | | [null_resource.cleanup](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | 169 | | [null_resource.provisioner](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | 170 | | [random_id.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource | 171 | | [archive_file.default](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | 172 | 173 | ## Inputs 174 | 175 | | Name | Description | Type | Default | Required | 176 | |------|-------------|------|---------|:--------:| 177 | | [arguments](#input\_arguments) | Arguments | `list(string)` | `[]` | no | 178 | | [dry\_run](#input\_dry\_run) | Do dry run | `bool` | `true` | no | 179 | | [envs](#input\_envs) | Environment variables | `list(string)` | `[]` | no | 180 | | [playbook](#input\_playbook) | Playbook to run | `string` | `""` | no | 181 | 182 | ## Outputs 183 | 184 | | Name | Description | 185 | |------|-------------| 186 | | [arguments](#output\_arguments) | Arguments | 187 | | [envs](#output\_envs) | Environment variables | 188 | 189 | 190 | 191 | ## Related Projects 192 | 193 | Check out these related projects. 194 | 195 | - [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes]) 196 | 197 | 198 | > [!TIP] 199 | > #### Use Terraform Reference Architectures for AWS 200 | > 201 | > Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly. 202 | > 203 | > ✅ We build it together with your team.
204 | > ✅ Your team owns everything.
205 | > ✅ 100% Open Source and backed by fanatical support.
206 | > 207 | > Request Quote 208 | >
📚 Learn More 209 | > 210 | >
211 | > 212 | > Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-ansible&utm_content=commercial_support) for funded startups and enterprises. 213 | > 214 | > *Your team can operate like a pro today.* 215 | > 216 | > Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed. 217 | > #### Day-0: Your Foundation for Success 218 | > - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code. 219 | > - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases. 220 | > - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance. 221 | > - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations. 222 | > - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions. 223 | > 224 | > Request Quote 225 | > 226 | > #### Day-2: Your Operational Mastery 227 | > - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency. 228 | > - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it. 229 | > - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity. 230 | > - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration. 231 | > - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly. 232 | > - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value. 233 | > - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate. 234 | > 235 | > Request Quote 236 | >
237 | 238 | ## ✨ Contributing 239 | 240 | This project is under active development, and we encourage contributions from our community. 241 | 242 | 243 | 244 | Many thanks to our outstanding contributors: 245 | 246 | 247 | 248 | 249 | 250 | For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-null-ansible/issues). 251 | 252 | In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 253 | 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-null-ansible/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md). 254 | 2. **Fork** the repo on GitHub 255 | 3. **Clone** the project to your own machine 256 | 4. **Commit** changes to your own branch 257 | 5. **Push** your work back up to your fork 258 | 6. Submit a **Pull Request** so that we can review your changes 259 | 260 | **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! 261 | 262 | ### 🌎 Slack Community 263 | 264 | Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-ansible&utm_content=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. 265 | 266 | ### 📰 Newsletter 267 | 268 | Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-ansible&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. 269 | Dropped straight into your Inbox every week — and usually a 5-minute read. 270 | 271 | ### 📆 Office Hours 272 | 273 | [Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-null-ansible&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else. 274 | It's **FREE** for everyone! 275 | ## License 276 | 277 | License 278 | 279 |
280 | Preamble to the Apache License, Version 2.0 281 |
282 |
283 | 284 | Complete license is available in the [`LICENSE`](LICENSE) file. 285 | 286 | ```text 287 | Licensed to the Apache Software Foundation (ASF) under one 288 | or more contributor license agreements. See the NOTICE file 289 | distributed with this work for additional information 290 | regarding copyright ownership. The ASF licenses this file 291 | to you under the Apache License, Version 2.0 (the 292 | "License"); you may not use this file except in compliance 293 | with the License. You may obtain a copy of the License at 294 | 295 | https://www.apache.org/licenses/LICENSE-2.0 296 | 297 | Unless required by applicable law or agreed to in writing, 298 | software distributed under the License is distributed on an 299 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 300 | KIND, either express or implied. See the License for the 301 | specific language governing permissions and limitations 302 | under the License. 303 | ``` 304 |
305 | 306 | ## Trademarks 307 | 308 | All other trademarks referenced herein are the property of their respective owners. 309 | 310 | 311 | --- 312 | Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright) 313 | 314 | 315 | README footer 316 | 317 | Beacon 318 | -------------------------------------------------------------------------------- /README.yaml: -------------------------------------------------------------------------------- 1 | # 2 | # This is the canonical configuration for the `README.md` 3 | # Run `make readme` to rebuild the `README.md` 4 | # 5 | 6 | # Name of this project 7 | name: terraform-null-ansible 8 | 9 | # Logo for this project 10 | #logo: docs/logo.png 11 | 12 | # License of this project 13 | license: "APACHE2" 14 | 15 | # Canonical GitHub repo 16 | github_repo: cloudposse/terraform-null-ansible 17 | 18 | # Badges to display 19 | badges: 20 | - name: Latest Release 21 | image: https://img.shields.io/github/release/cloudposse/terraform-null-ansible.svg?style=for-the-badge 22 | url: https://github.com/cloudposse/terraform-null-ansible/releases/latest 23 | - name: Last Updated 24 | image: https://img.shields.io/github/last-commit/cloudposse/terraform-null-ansible.svg?style=for-the-badge 25 | url: https://github.com/cloudposse/terraform-null-ansible/commits 26 | - name: Slack Community 27 | image: https://slack.cloudposse.com/for-the-badge.svg 28 | url: https://slack.cloudposse.com 29 | 30 | # List any related terraform modules that this module may be used with or that this module depends on. 31 | related: 32 | - name: "terraform-null-label" 33 | description: "Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])" 34 | url: "https://github.com/cloudposse/terraform-null-label" 35 | 36 | # Short description of this project 37 | description: |- 38 | Terraform Module to run ansible playbooks. 39 | 40 | # How to use this project 41 | usage: |- 42 | ### Add special section to the playbook 43 | 44 | You must add this section on the top of all playbooks that will be used for provisioning. 45 | 46 | This will add a dynamic inventory to target the host that needs provisioning. 47 | 48 | e.g. `../ansible/playbooks/playbook.yml` 49 | 50 | * Create a runtime inventorty with an ip address of a host 51 | * Wait for target host is ready for ssh connection 52 | 53 | ```yaml 54 | 55 | --- 56 | - hosts: localhost 57 | gather_facts: True 58 | check_mode: no 59 | tasks: 60 | - name: Add public ip addresses to an dynamic inventory 61 | add_host: 62 | name: "{{ host }}" 63 | groups: all 64 | 65 | - local_action: wait_for port=22 host="{{ host }}" search_regex=OpenSSH delay=10 66 | 67 | - hosts: all 68 | gather_facts: False 69 | check_mode: no 70 | become: True 71 | tasks: 72 | - name: Install python 2.7 73 | raw: > 74 | test -e /usr/bin/python || 75 | ( 76 | (test -e /usr/bin/apt-get && (apt-get -y update && apt-get install -y python)) || 77 | (test -e /usr/bin/yum && (yum makecache fast && yum install -y python)) 78 | ) 79 | args: 80 | creates: /usr/bin/python 81 | ``` 82 | 83 | ### Create an aws instance 84 | 85 | ```hcl 86 | resource "aws_instance" "web" { 87 | ami = "ami-408c7f28" 88 | instance_type = "t1.micro" 89 | tags { 90 | Name = test1 91 | } 92 | } 93 | ``` 94 | 95 | ### Apply the provisioner module to this resource 96 | 97 | ```hcl 98 | module "ansible_provisioner" { 99 | source = "github.com/cloudposse/tf_ansible" 100 | 101 | arguments = ["--user=ubuntu"] 102 | envs = ["host=${aws_instance.web.public_ip}"] 103 | playbook = "../ansible/playbooks/test.yml" 104 | dry_run = false 105 | 106 | } 107 | ``` 108 | 109 | include: 110 | - "docs/targets.md" 111 | - "docs/terraform.md" 112 | 113 | # Contributors to this project 114 | contributors: [] 115 | -------------------------------------------------------------------------------- /docs/targets.md: -------------------------------------------------------------------------------- 1 | 2 | ## Makefile Targets 3 | ```text 4 | Available targets: 5 | 6 | help Help screen 7 | help/all Display help for all targets 8 | help/short This help short screen 9 | lint Lint terraform code 10 | 11 | ``` 12 | 13 | -------------------------------------------------------------------------------- /docs/terraform.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | | Name | Version | 5 | |------|---------| 6 | | [terraform](#requirement\_terraform) | >= 0.12 | 7 | | [archive](#requirement\_archive) | ~> 2.2.0 | 8 | | [null](#requirement\_null) | ~> 3.2.0 | 9 | | [random](#requirement\_random) | ~> 3.6.0 | 10 | 11 | ## Providers 12 | 13 | | Name | Version | 14 | |------|---------| 15 | | [archive](#provider\_archive) | ~> 2.2.0 | 16 | | [null](#provider\_null) | ~> 3.2.0 | 17 | | [random](#provider\_random) | ~> 3.6.0 | 18 | 19 | ## Modules 20 | 21 | No modules. 22 | 23 | ## Resources 24 | 25 | | Name | Type | 26 | |------|------| 27 | | [null_resource.cleanup](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | 28 | | [null_resource.provisioner](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | 29 | | [random_id.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource | 30 | | [archive_file.default](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | 31 | 32 | ## Inputs 33 | 34 | | Name | Description | Type | Default | Required | 35 | |------|-------------|------|---------|:--------:| 36 | | [arguments](#input\_arguments) | Arguments | `list(string)` | `[]` | no | 37 | | [dry\_run](#input\_dry\_run) | Do dry run | `bool` | `true` | no | 38 | | [envs](#input\_envs) | Environment variables | `list(string)` | `[]` | no | 39 | | [playbook](#input\_playbook) | Playbook to run | `string` | `""` | no | 40 | 41 | ## Outputs 42 | 43 | | Name | Description | 44 | |------|-------------| 45 | | [arguments](#output\_arguments) | Arguments | 46 | | [envs](#output\_envs) | Environment variables | 47 | 48 | -------------------------------------------------------------------------------- /main.tf: -------------------------------------------------------------------------------- 1 | resource "random_id" "default" { 2 | byte_length = 8 3 | } 4 | 5 | data "archive_file" "default" { 6 | type = "zip" 7 | source_dir = dirname(var.playbook) 8 | output_path = "${path.module}/${random_id.default.hex}.zip" 9 | } 10 | 11 | resource "null_resource" "provisioner" { 12 | count = signum(length(var.playbook)) == 1 ? 1 : 0 13 | 14 | depends_on = [data.archive_file.default] 15 | 16 | triggers = { 17 | signature = data.archive_file.default.output_md5 18 | command = "ansible-playbook ${var.dry_run ? "--check --diff" : ""} ${join(" ", compact(var.arguments))} ${length(compact(var.envs)) > 0 ? "-e" : ""} ${join(" -e ", compact(var.envs))} ${var.playbook}" 19 | } 20 | 21 | provisioner "local-exec" { 22 | command = "ansible-playbook ${var.dry_run ? "--check --diff" : ""} ${join(" ", compact(var.arguments))} ${length(compact(var.envs)) > 0 ? "-e" : ""} ${join(" -e ", compact(var.envs))} ${var.playbook}" 23 | } 24 | 25 | lifecycle { 26 | create_before_destroy = true 27 | } 28 | } 29 | 30 | resource "null_resource" "cleanup" { 31 | triggers = { 32 | default = random_id.default.hex 33 | } 34 | 35 | provisioner "local-exec" { 36 | command = "rm -f ${data.archive_file.default.output_path}" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /outputs.tf: -------------------------------------------------------------------------------- 1 | output "arguments" { 2 | value = var.arguments 3 | description = "Arguments" 4 | } 5 | 6 | output "envs" { 7 | value = var.envs 8 | description = "Environment variables" 9 | } 10 | -------------------------------------------------------------------------------- /variables.tf: -------------------------------------------------------------------------------- 1 | variable "arguments" { 2 | default = [] 3 | type = list(string) 4 | description = "Arguments" 5 | } 6 | 7 | variable "envs" { 8 | default = [] 9 | type = list(string) 10 | description = "Environment variables" 11 | } 12 | 13 | variable "playbook" { 14 | default = "" 15 | description = "Playbook to run" 16 | } 17 | 18 | variable "dry_run" { 19 | default = true 20 | description = "Do dry run" 21 | } 22 | -------------------------------------------------------------------------------- /versions.tf: -------------------------------------------------------------------------------- 1 | terraform { 2 | required_providers { 3 | archive = { 4 | version = "~> 2.2.0" 5 | } 6 | null = { 7 | version = "~> 3.2.0" 8 | } 9 | random = { 10 | version = "~> 3.6.0" 11 | } 12 | } 13 | required_version = ">= 0.12" 14 | } 15 | --------------------------------------------------------------------------------