Make examples in READMEs runnable and testable
This commit is contained in:
@@ -13,34 +13,32 @@ Basic usage of this module is as follows:
|
||||
|
||||
```hcl
|
||||
module "peering" {
|
||||
source = "modules/net-vpc-peering"
|
||||
|
||||
source = "./modules/net-vpc-peering"
|
||||
prefix = "name-prefix"
|
||||
local_network = "<FIRST NETWORK SELF LINK>"
|
||||
peer_network = "<SECOND NETWORK SELF LINK>"
|
||||
local_network = "projects/project-1/global/networks/vpc-1"
|
||||
peer_network = "projects/project-1/global/networks/vpc-2"
|
||||
}
|
||||
# tftest:modules=1:resources=2
|
||||
```
|
||||
|
||||
If you need to create more than one peering for the same VPC Network `(A -> B, A -> C)` you use a `depends_on` for second one to keep order of peering creation (It is not currently possible to create more than one peering connection for a VPC Network at the same time).
|
||||
|
||||
```hcl
|
||||
module "peering-a-b" {
|
||||
source = "modules/net-vpc-peering"
|
||||
|
||||
source = "./modules/net-vpc-peering"
|
||||
prefix = "name-prefix"
|
||||
local_network = "<A NETWORK SELF LINK>"
|
||||
peer_network = "<B NETWORK SELF LINK>"
|
||||
local_network = "projects/project-a/global/networks/vpc-a"
|
||||
peer_network = "projects/project-b/global/networks/vpc-b"
|
||||
}
|
||||
|
||||
module "peering-a-c" {
|
||||
source = "modules/net-vpc-peering"
|
||||
|
||||
source = "./modules/net-vpc-peering"
|
||||
prefix = "name-prefix"
|
||||
local_network = "<A NETWORK SELF LINK>"
|
||||
peer_network = "<C NETWORK SELF LINK>"
|
||||
|
||||
depends_on = [ module.peering-a-b ]
|
||||
local_network = "projects/project-a/global/networks/vpc-a"
|
||||
peer_network = "projects/project-c/global/networks/vpc-c"
|
||||
depends_on = [module.peering-a-b]
|
||||
}
|
||||
# tftest:modules=2:resources=4
|
||||
```
|
||||
|
||||
<!-- BEGIN TFDOC -->
|
||||
|
||||
Reference in New Issue
Block a user