terraform-provider-ansible

README

Terraform Provider for Ansible

The Terraform Provider for Ansible provides a more straightforward and robust means of executing Ansible automation from Terraform than local-exec. Paired with the inventory plugin in the Ansible cloud.terraform collection, users can run Ansible playbooks and roles on infrastructure provisioned by Terraform. The provider also includes integrated ansible-vault support.

This provider can be found in the Terraform Registry here.

For more details on using Terraform and Ansible together see these blog posts:

• Terraforming clouds with Ansible
• Walking on Clouds with Ansible
• Providing Terraform with that Ansible Magic

Requirements

• install Go: official installation guide
• install Terraform: official installation guide
• install Ansible: official installation guide

Installation for Local Development

Run make. This will build a terraform-provider-ansible binary in the top level of the project. To get Terraform to use this binary, configure the development overrides for the provider installation. The easiest way to do this will be to create a config file with the following contents:

provider_installation {
  dev_overrides {
    "sovarto/ansible" = "/path/to/project/root"
  }

  direct {}
}

The /path/to/project/root should point to the location where you have cloned this repo, where the terraform-provider-ansible binary will be built. You can then set the TF_CLI_CONFIG_FILE environment variable to point to this config file, and Terraform will use the provider binary you just built.

Testing

Lint:

curl -L https://github.com/golangci/golangci-lint/releases/download/v1.50.1/golangci-lint-1.50.1-linux-amd64.tar.gz \
    | tar --wildcards -xzf - --strip-components 1 "**/golangci-lint"
curl -L https://github.com/nektos/act/releases/download/v0.2.34/act_Linux_x86_64.tar.gz \
    | tar -xzf - act

# linters
./golangci-lint run -v

# tests
make test

# GH actions locally
./act

Examples

The examples subdirectory contains a usage example for this provider.

Release notes

See the generated changelog.

Releasing

To release a new version of the provider:

1. Update the version number in https://github.com/ansible/terraform-provider-ansible/blob/main/examples/provider/provider.tf
2. Run go generate to regenerate docs
3. Run antsibull-changelog release --version <version> to release a new version of the project.
4. Commit changes
5. Push a new tag (this should trigger an automated release process to the Terraform Registry)
6. Verify the new version is published at https://registry.terraform.io/providers/ansible/ansible/latest

Licensing

GNU General Public License v3.0. See LICENSE for full text.