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

Commit 95ede46

Browse files
authored
Update README.md
1 parent 1d56d43 commit 95ede46

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can use this module with [terraform-aws-modules/vpc/aws](https://registry.te
2121
module "vpc" {
2222
source = "terraform-aws-modules/vpc/aws"
2323
24-
name = "hello-vpc"
24+
name = "main"
2525
cidr = "172.18.0.0/16"
2626
azs = ["us-west-2a", "us-west-2b", "us-west-2c"]
2727
private_subnets = ["172.18.64.0/20", "172.18.80.0/20", "172.18.96.0/20"]
@@ -32,7 +32,7 @@ module "vpc" {
3232
module "nat" {
3333
source = "int128/nat-instance/aws"
3434
35-
name = "hello-nat"
35+
name = "main"
3636
vpc_id = module.vpc.vpc_id
3737
public_subnet = module.vpc.public_subnets[0]
3838
private_subnets_cidr_blocks = module.vpc.private_subnets_cidr_blocks
@@ -43,7 +43,7 @@ module "nat" {
4343

4444
## How it works
4545

46-
This module will create the following resources:
46+
This module provisions the following resources:
4747

4848
- Launch Template for the NAT instance
4949
- Auto Scaling Group with mixed instances policy
@@ -57,16 +57,13 @@ Take a look at the diagram:
5757

5858
![diagram](diagram.svg)
5959

60-
The NAT instance will do the following tasks on startup:
60+
By default an instance of the latest Amazon Linux 2 is launched.
61+
The instance will run [init.sh](data/init.sh) to enable NAT as follows:
6162

6263
1. Attach the ENI to `eth1`.
63-
1. Enable IP forwarding.
64-
1. Set to ignore ICMP redirect packets.
65-
1. Enable IP masquerade.
64+
1. Set the kernel parameters for IP forwarding and masquerade.
6665
1. Switch the default route to `eth1`.
6766

68-
See [init.sh](data/init.sh) for details.
69-
7067

7168
## Configuration
7269

0 commit comments

Comments
 (0)