Skip to content

Commit 289cc3a

Browse files
committed
Add usage instructions to README
1 parent 3ed2c72 commit 289cc3a

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
# Terraformed Inventory
22

3-
This is a little Go app which generates an [Ansible] [ansible] inventory file
4-
from a [Terraform] [tf] state file.
3+
This is a little Go app which generates an dynamic [Ansible] [ansible] inventory
4+
from a [Terraform] [tf] state file. It allows one to spawn a bunch of VMs with
5+
Terraform, then (re-)provision them with Ansible. It's pretty neat.
6+
7+
8+
## Usage
9+
10+
Just download the OSX binary and run it.
11+
12+
curl https://github.com/adammck/terraformedinventory/releases/download/v0.1/terraformedinventory
13+
./terraformedinventory --list whatever.tfstate
14+
15+
Ansible doesn't (seem to) support calling the inventory script with parameters,
16+
so I like to wrap this tool up in a little shell script, and call that.
17+
Something like:
18+
19+
#!/bin/bash
20+
terraformedinventory $@ $(dirname $0)/deploy/terraform.tfstate
21+
22+
Configuration via environment variables, like most other dynamic inventory
23+
scripts, is coming soon.
524

625

726
## Development
827

9-
[Install Terraform] [tfdev], then:
28+
[Install Terraform] [tfdev] from source, then:
1029

1130
git clone https://github.com/adammck/terraformedinventory.git
1231
cd terraformedinventory

0 commit comments

Comments
 (0)