Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nbering/terraform-provider-ansible

"Logical" provider for integrating with an Ansible Dynamic Inventory script.
https://github.com/nbering/terraform-provider-ansible

ansible-inventory terraform terraform-provider

Last synced: 17 days ago
JSON representation

"Logical" provider for integrating with an Ansible Dynamic Inventory script.

Awesome Lists containing this project

README 

        
# Ansible Terraform Provider

A Terraform provider serving as an interop layer for an Ansible [dynamic

inventory script][1].



Read the [introductory blog post][3] for an explanation of the design

motivations behind this provider.



## Installation



Installation can be accomplished in two different ways:



1. For Terraform 0.13+ Use terraform required_providers block

2. Installing a pre-compiled release (recommended)

3. Compiling from source



### For Terraform 0.13+ Use terraform required_providers block

providers.tf

```

terraform {

  required_providers {

    ansible = {

      source = "nbering/ansible"

      version = "1.0.4"

    }

  }

}

provider "ansible" {}

```

then perform another init to download the provider.

```

$ terraform init

Initializing modules...

Initializing the backend...

Initializing provider plugins...

- Finding nbering/ansible versions matching "1.0.4"

...

- Installing nbering/ansible v1.0.4...

- Installed nbering/ansible v1.0.4 (self-signed, key ID xxxxxxxxxxxxxx)

...

Terraform has been successfully initialized!



You may now begin working with Terraform. Try running "terraform plan" to see

any changes that are required for your infrastructure. All Terraform commands

should now work.

```



### Installing a Pre-Compiled Release



Downloading and installing a pre-compiled `terraform-provider-ansible` release

is the recommended method of installation since it requires no additional tools

or libraries to be installed on your workstation.



1. Visit the [releases][4] page and download the latest release for your target

   architecture.



2. Unzip the downloaded file and copy the `terraform-provider-ansible` binary

   to a designated directory as described in Terraform's [plugin installation

   instructions][2].



### Compiling From Source



> Note: Terraform requires Go 1.11 or later to successfully compile.



> Note: Dependencies are no longer included in this repository. You may need the

[bazaar][10] version control utility to download some of Terraform's Go-lang

module dependencies.



If you'd like to take advantage of features not yet available in a pre-compiled

release, you can compile `terraform-provider-ansible` from source.



In order to compile, you will need to have Go installed on your workstation.

Official instructions on how to install Go can be found [here][5].



Alternatively, you can use [gimme][6] as a quick and easy way to install Go:



```shell

$ sudo wget -O /usr/local/bin/gimme https://raw.githubusercontent.com/travis-ci/gimme/master/gimme

$ sudo chmod +x /usr/local/bin/gimme

$ gimme 1.10

# copy the output to your `.bashrc` and source `.bashrc`.

```



Once you have a working Go installation, you can compile

`terraform-provider-ansible` by doing the following:



```shell

$ go get github.com/nbering/terraform-provider-ansible

$ cd $GOPATH/src/github.com/nbering/terraform-provider-ansible

$ make

```



You should now have a `terraform-provider-ansible` binary located at

`$GOPATH/bin/terraform-provider-ansible`. Copy this binary to a designated

directory as described in Terraform's [plugin installation instructions][2]



## Terraform Configuration Example



```hcl

resource "ansible_host" "example" {

    inventory_hostname = "example.com"

    groups = ["web"]

    vars = {

        ansible_user = "admin"

    }

}



resource "ansible_group" "web" {

  inventory_group_name = "web"

  children = ["foo", "bar", "baz"]

  vars = {

    foo = "bar"

    bar = 2

  }

}

```



## Compatibility



Version [1.0.0][7] of this project is compatible with Terraform version

[0.12-beta2][8]. You will also need [2.0.0][11]+ of the terraform-inventory

script, as the internal structure of Terraform state files has changed. 



If you need a version compatible with an earlier version of

Terraform, use version [0.0.4][9].



When upgrading to Terraform 0.12.x, you may need to change your configuration

files to reflect changes to the new version of the Hashicorp Configuration

Lanaguage (HCL). The only known incompatibility is that `vars` attributes now

require an equals operator (`=`).



**0.11.x**

```hcl

resource "ansible_host" "example" {

    inventory_hostname = "example.com"

    vars {

        ansible_user = "admin"

    }

}

```



**0.12.x**

```hcl

resource "ansible_host" "example" {

    inventory_hostname = "example.com"

    vars = {

        ansible_user = "admin"

    }

}

```



## Alternatives and Similar Projects

### [jonmorehouse/terraform-provisioner-ansible](https://github.com/jonmorehouse/terraform-provisioner-ansible)

A Terraform Provisioner that runs Ansible-Local on a target machine at creation-time.



### [adammck/terraform-inventory](https://github.com/adammck/terraform-inventory)

A very similar solution to this one, without the Logical provider. Depends on

specific Terraform resource types, and relies heavily on cloud-providers' tag

implementations.



### [Ansible Collection: Terraform](https://docs.ansible.com/ansible/latest/collections/community/general/terraform_module.html)

An Ansible collection that runs Terraform plans and deployments.



## License



Contributions specific to this project are made available under the

[Mozilla Public License](./LICENSE).



Code under the `vendor/` directory is copyright of the various package owners,

and made available under their own license considerations.



[1]: https://github.com/nbering/terraform-inventory/

[2]: https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin

[3]: http://nicholasbering.ca/tools/2018/01/08/introducing-terraform-provider-ansible/

[4]: https://github.com/nbering/terraform-provider-ansible/releases

[5]: https://golang.org/doc/install

[6]: https://github.com/travis-ci/gimme

[7]: https://github.com/nbering/terraform-provider-ansible/releases/tag/v1.0.0

[8]: https://github.com/hashicorp/terraform/releases/tag/v0.12.0-beta2

[9]: https://github.com/nbering/terraform-provider-ansible/releases/tag/v0.0.4

[10]: https://bazaar.canonical.com/en/

[11]: https://github.com/nbering/terraform-inventory/releases/tag/v2.0.0