forked from cloudposse/terraform-aws-vpc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.yaml
119 lines (100 loc) · 3.53 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-vpc
# Tags of this project
tags:
- aws
- terraform
- terraform-modules
- platform
- vpc
# Categories of this project
categories:
- terraform-modules/networking
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-vpc
# Badges to display
badges:
- name: "Codefresh Build Status"
image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-vpc?type=cf-1"
url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d04407b1fc622c0cf6d3df8"
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse/terraform-aws-vpc.svg"
url: "https://github.com/cloudposse/terraform-aws-vpc/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/badge.svg"
url: "https://slack.cloudposse.com"
related:
- name: "terraform-aws-vpc-peering"
description: "Terraform module to create a peering connection between two VPCs"
url: "https://github.com/cloudposse/terraform-aws-vpc-peering"
- name: "terraform-aws-kops-vpc-peering"
description: "Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops"
url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering"
- name: "terraform-aws-dynamic-subnets"
description: "Terraform module for public and private subnets provisioning in existing VPC"
url: "https://github.com/cloudposse/terraform-aws-dynamic-subnets"
- name: "terraform-aws-multi-az-subnets"
description: "Terraform module for multi-AZ public and private subnets provisioning"
url: "https://github.com/cloudposse/terraform-aws-multi-az-subnets"
- name: "terraform-aws-named-subnets"
description: "Terraform module for named subnets provisioning."
url: "https://github.com/cloudposse/terraform-aws-named-subnets"
# Short description of this project
description: |-
Terraform module to provision a VPC with Internet Gateway.
# How to use this project
examples: |-
```hcl
module "vpc" {
source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
namespace = "eg"
stage = "test"
name = "app"
cidr_block = "10.0.0.0/16"
}
```
Full example with [`terraform-aws-dynamic-subnets`](https://github.com/cloudposse/terraform-aws-dynamic-subnets.git):
```hcl
module "vpc" {
source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
namespace = "eg"
stage = "test"
name = "app"
cidr_block = "10.0.0.0/16"
}
module "dynamic_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=master"
namespace = "eg"
stage = "test"
name = "app"
region = "us-west-2"
availability_zones = ["us-west-2a","us-west-2b","us-west-2c"]
vpc_id = module.vpc.vpc_id
igw_id = module.vpc.igw_id
cidr_block = "10.0.0.0/16"
}
```
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors:
- name: "Erik Osterman"
github: "osterman"
- name: "Igor Rodionov"
github: "goruha"
- name: "Andriy Knysh"
github: "aknysh"
- name: "Valeriy"
github: "drama17"
- name: "Vladimir"
github: "SweetOps"