Skip to content
This repository was archived by the owner on Mar 19, 2024. It is now read-only.

Commit 710aa1b

Browse files
committed
docs: More README updates
1 parent 2308f18 commit 710aa1b

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,6 @@
22

33
Terrafile is a binary written in Go to systematically manage external modules from Github for use in Terraform. See this [article](http://bensnape.com/2016/01/14/terraform-design-patterns-the-terrafile/) for more information on how it was introduced in a Ruby rake task.
44

5-
This is currently an experimental WIP.
6-
7-
An example Terrafile:
8-
```
9-
tf-aws-vpc:
10-
source: "[email protected]:terraform-aws-modules/terraform-aws-vpc"
11-
version: "v1.46.0"
12-
tf-aws-vpc-experimental:
13-
source: "[email protected]:terraform-aws-modules/terraform-aws-vpc"
14-
version: "master"
15-
```
16-
175
## How to install
186

197
### macOS
@@ -31,22 +19,33 @@ curl -L https://github.com/coretech/terrafile/releases/download/v0.3/terrafile_0
3119
```
3220

3321
## How to use
22+
Terrafile expects a file named `Terrafile` which will contain your terraform module dependencies in a yaml like format.
23+
24+
An example Terrafile:
25+
```
26+
tf-aws-vpc:
27+
source: "[email protected]:terraform-aws-modules/terraform-aws-vpc"
28+
version: "v1.46.0"
29+
tf-aws-vpc-experimental:
30+
source: "[email protected]:terraform-aws-modules/terraform-aws-vpc"
31+
version: "master"
32+
```
3433

35-
Terrafile config in current directory and modules exported to ./vendor/modules
34+
Terrafile config file in current directory and modules exported to ./vendor/modules
3635
```sh
3736
$ terrafile
3837
INFO[0000] [*] Checking out v1.46.0 of [email protected]:terraform-aws-modules/terraform-aws-vpc
3938
INFO[0000] [*] Checking out master of [email protected]:terraform-aws-modules/terraform-aws-vpc
4039
```
4140

42-
Terrafile config in custom location
41+
Terrafile config file in custom directory
4342
```sh
4443
$ terrafile -f config/
4544
INFO[0000] [*] Checking out v1.46.0 of [email protected]:terraform-aws-modules/terraform-aws-vpc
4645
INFO[0000] [*] Checking out master of [email protected]:terraform-aws-modules/terraform-aws-vpc
4746
```
4847

49-
Terraform modules exported to custom location
48+
Terraform modules exported to custom directory
5049
```sh
5150
$ terrafile -p custom_directory
5251
INFO[0000] [*] Checking out master of [email protected]:terraform-aws-modules/terraform-aws-vpc

0 commit comments

Comments
 (0)