Ver código fonte

add readme information

Chris Mague 5 anos atrás
pai
commit
f1ec71ae9a
1 arquivos alterados com 43 adições e 0 exclusões
  1. 43 0
      README.md

+ 43 - 0
README.md

@@ -0,0 +1,43 @@
+# A module to build a 2 tier VPC
+
+## Prerequisites
+
+- aws-cli
+- tfenv
+
+## Generate Key Pair
+
+```
+aws ec2 create-key-pair --profile redislabs --key-name maguec1 --region us-west-1 \
+| jq .KeyMaterial |  awk '{gsub(/\\n/,"\n")}1' | \
+sed -e s/\"//g >> ~/.ssh/maguec1.pem
+
+chmod 0600 ~/.ssh/maguec1.pem
+```
+
+This keypair name should match the name of the VPC
+
+## Example usage
+
+```
+provider "aws" {
+  region  = var.region
+  profile = var.profile
+}
+
+module "vpc" {
+  source         = "git@github.com:shokunin/tfmodule-aws-2tier-vpc?ref=master"
+  region         = var.region
+  profile        = var.profile
+  vpc-name       = var.vpc-name
+  vpc-cidr       = var.vpc-cidr
+  vpc-azs        = var.vpc-azs
+  enable-private = false
+  common-tags = {
+    "Owner"   = "maguec"
+    "Project" = "example_terraform"
+  }
+}
+```
+
+