Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudposse/terraform-null-ansible

Terraform Module to run ansible playbooks
https://github.com/cloudposse/terraform-null-ansible

ansible ansible-playbook hcl2 playbook terraform terraform-modules

Last synced: 22 days ago
JSON representation

Terraform Module to run ansible playbooks

Awesome Lists containing this project

README 

        



Project Banner


    


Latest ReleaseLast UpdatedSlack Community



Terraform Module to run ansible playbooks.



> [!TIP]

> #### 👽 Use Atmos with Terraform

> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. 


> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).

>

> 

> Watch demo of using Atmos with Terraform

> 


> Example of running atmos to manage infrastructure from our Quick Start tutorial.

> 



## Usage



### Add special section to the playbook



You must add this section on the top of all playbooks that will be used for provisioning.



This will add a dynamic inventory to target the host that needs provisioning.



e.g. `../ansible/playbooks/playbook.yml`



* Create a runtime inventorty with an ip address of a host

* Wait for target host is ready for ssh connection



```yaml



---

- hosts: localhost

  gather_facts: True

  check_mode: no

  tasks:

  - name: Add public ip addresses to an dynamic inventory

    add_host:

      name: "{{ host }}"

      groups: all



  - local_action: wait_for port=22 host="{{ host }}" search_regex=OpenSSH delay=10



- hosts: all

  gather_facts: False

  check_mode: no

  become: True

  tasks:

  - name: Install python 2.7

    raw: >

      test -e /usr/bin/python ||

      (

        (test -e /usr/bin/apt-get && (apt-get -y update && apt-get install -y python)) ||

        (test -e /usr/bin/yum && (yum makecache fast && yum install -y python))

      )

    args:

      creates: /usr/bin/python

```



### Create an aws instance



```hcl

resource "aws_instance" "web" {

  ami           = "ami-408c7f28"

  instance_type = "t1.micro"

  tags {

    Name        = test1

  }

}

```



### Apply the provisioner module to this resource



```hcl

module "ansible_provisioner" {

  source    = "github.com/cloudposse/tf_ansible"



  arguments = ["--user=ubuntu"]

  envs      = ["host=${aws_instance.web.public_ip}"]

  playbook  = "../ansible/playbooks/test.yml"

  dry_run   = false



}

```



> [!IMPORTANT]

> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation

> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version

> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic

> approach for updating versions to avoid unexpected changes.



## Makefile Targets

```text

Available targets:



  help                                Help screen

  help/all                            Display help for all targets

  help/short                          This help short screen

  lint                                Lint terraform code



```



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 0.12 |

|  [archive](#requirement\_archive) | ~> 2.2.0 |

|  [null](#requirement\_null) | ~> 3.2.0 |

|  [random](#requirement\_random) | ~> 3.6.0 |



## Providers



| Name | Version |

|------|---------|

|  [archive](#provider\_archive) | ~> 2.2.0 |

|  [null](#provider\_null) | ~> 3.2.0 |

|  [random](#provider\_random) | ~> 3.6.0 |



## Modules



No modules.



## Resources



| Name | Type |

|------|------|

| [null_resource.cleanup](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |

| [null_resource.provisioner](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |

| [random_id.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |

| [archive_file.default](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [arguments](#input\_arguments) | Arguments | `list(string)` | `[]` | no |

|  [dry\_run](#input\_dry\_run) | Do dry run | `bool` | `true` | no |

|  [envs](#input\_envs) | Environment variables | `list(string)` | `[]` | no |

|  [playbook](#input\_playbook) | Playbook to run | `string` | `""` | no |



## Outputs



| Name | Description |

|------|-------------|

|  [arguments](#output\_arguments) | Arguments |

|  [envs](#output\_envs) | Environment variables |



## Related Projects



Check out these related projects.



- [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])



> [!TIP]

> #### Use Terraform Reference Architectures for AWS

>

> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.

>

> ✅ We build it together with your team.


> ✅ Your team owns everything.


> ✅ 100% Open Source and backed by fanatical support.


>

> Request Quote

> 📚 Learn More

>

> 


>

> 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.

>

> *Your team can operate like a pro today.*

>

> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

> #### Day-0:  Your Foundation for Success

> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.

> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

>

> Request Quote

>

> #### Day-2: Your Operational Mastery

> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

>

> Request Quote

> 



## ✨ Contributing



This project is under active development, and we encourage contributions from our community.



Many thanks to our outstanding contributors:





  




For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-null-ansible/issues).



In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

 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).

 2. **Fork** the repo on GitHub

 3. **Clone** the project to your own machine

 4. **Commit** changes to your own branch

 5. **Push** your work back up to your fork

 6. 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!



### 🌎 Slack Community



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.



### 📰 Newsletter



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.

Dropped straight into your Inbox every week — and usually a 5-minute read.



### 📆 Office Hours 



[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.

It's **FREE** for everyone!

## License



License



Preamble to the Apache License, Version 2.0








Complete license is available in the [`LICENSE`](LICENSE) file.



```text

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.



---

Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)



README footer



Beacon