Skip to content
This repository has been archived by the owner on Jul 20, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
int128 authored Jun 1, 2020
1 parent e717e30 commit 8983dc7
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Features:
- Saving cost using a spot instance (from $1/month)
- Fixed source IP address by reattaching ENI
- Supporting Systems Manager Session Manager
- Disable costly resources for compatibility with workspaces
- Compatible with workspaces

Terraform 0.12 is required.

Expand Down Expand Up @@ -65,8 +65,10 @@ Take a look at the diagram:

![diagram](diagram.svg)

By default an instance of the latest Amazon Linux 2 is launched.
The instance will run [init.sh](data/init.sh) to enable NAT as follows:
By default the latest Amazon Linux 2 image is used.
You can set `image_id` for a custom image.

The instance will execute [`runonce.sh`](runonce.sh) and [`snat.sh`](snat.sh) to enable NAT as follows:

1. Attach the ENI to `eth1`.
1. Set the kernel parameters for IP forwarding and masquerade.
Expand Down Expand Up @@ -94,7 +96,7 @@ module "nat" {
}
```

See also the [example](example/) for more.
See also [cloud-init modules](https://cloudinit.readthedocs.io/en/latest/topics/modules.html) and the [example](example/) for more.


### SSH access
Expand Down

0 comments on commit 8983dc7

Please sign in to comment.