Ansible provider for terraform

This document describes how to build and use the ansible terraform provider. The provider lets you define ansible resources in terraform code, which generates an inventory to be consumed by ansible during provisioning.

Example usage

terraform {
  required_providers {
    ansible = "~> 1.0"
  }
}

provider "ansible" {
  path            = "/data/ansible/inventory"
  log_caller      = false
}

resource "ansible_inventory" "cluster" {
  group_vars = <<-EOT
      ---
    k3s_version: v1.19.5+k3s1
    ansible_user: ubuntu
    systemd_dir: /etc/systemd/system
    master_ip: "{{ hostvars[groups['master'][0]]['ansible_host'] | default(groups['master'][0]) }}"
    extra_server_args: ""
    extra_agent_args: ""
  EOT
}

resource "ansible_group" "master" {
  depends_on = [ansible_inventory.cluster]
  name = "master"
  inventory = ansible_inventory.cluster.id
}

resource "ansible_host" "k3s-master-1" {
  depends_on = [ansible_group.master]
  name = "k3s-master-1"
  inventory = ansible_inventory.cluster.id
  group = ansible_group.master.id
  variables = {
    name = "k3s-master-1"
    role = "master"
  }
}

Multiple Provider Configurations

You can optionally define multiple configurations for the same provider, and select which one to use on a per-resource or per-module basis. The primary reason for this is to support multiple regions for a cloud platform; other examples include targeting multiple Docker hosts, multiple Consul hosts, etc.

To create multiple configurations for a given provider, include multiple provider blocks with the same provider name. For each additional non-default configuration, use the alias meta-argument to provide an extra name segment

How to build

To build an test the plugin locally first create a ~/.terraformrc file

provider_installation {

  dev_overrides {
    "habakke/ansible" = "/Users/habakke/.terraform.d/plugins"
  }
  direct {}
}

Then build and install the plugin locally using

make install

Running tests

To run the internal unit tests run test test make target

make test

To run terraform acceptance tests, the TF_ACC env variable must be set to true before making the test make target, or the testacc make target can be used

make testacc

Release notes

2.0.0

• Breaking changes since previous version where the new version expects the provider path to be the root path where the inventory will be crated. To use multiple inventories, use provider aliases.

TODO

• Add support for Ansible group variables (https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#assigning-a-variable-to-many-machines-group-variables)
• Add proper docs as seen in other community providers (https://github.com/paultyng/terraform-provider-unifi/tree/main/docs)