Skip to content

Commit c4902b3

Browse files
committed
updated readme to reflect conversion of project into a terraform module
1 parent 4d3c2b2 commit c4902b3

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,43 @@
1-
# Self-extractable archive
1+
# Terraform Module for Self-Extractable Archive
22

3-
## Prerequisite
3+
This module creates a self-extractable archive from a directory using [makeself](https://makeself.io/). The archive can be used to bootstrap a new instance using cloud-init.
44

5-
For MacOS:
6-
```bash
7-
brew install gnu-tar
8-
export PATH="/opt/homebrew/opt/gnu-tar/libexec/gnubin:$PATH"
5+
## Usage
6+
7+
Quick start:
8+
9+
```terraform
10+
module "bootstrap" {
11+
source = "andreygubarev/self-extractable-archive/external"
12+
version = "1.1.0"
13+
archive_dir = "${path.module}/bootstrap"
14+
}
915
```
1016

11-
## Usage Example
17+
Advanced usage:
18+
1219
```terraform
1320
module "bootstrap" {
14-
...
21+
source = "andreygubarev/self-extractable-archive/external"
22+
version = "1.1.0"
1523
1624
archive_dir = "${path.module}/bootstrap"
1725
file_name = "bootstrap.run"
1826
startup_script = "./entrypoint.sh"
1927
}
2028
```
2129

30+
## Prerequisite
31+
32+
For MacOS:
33+
```bash
34+
brew install gnu-tar
35+
export PATH="/opt/homebrew/opt/gnu-tar/libexec/gnubin:$PATH"
36+
```
37+
38+
39+
2240
# Reference
2341

24-
https://makeself.io/
25-
https://registry.terraform.io/providers/hashicorp/external/latest
42+
- https://makeself.io/
43+
- https://registry.terraform.io/providers/hashicorp/external/latest

0 commit comments

Comments
 (0)