generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.yaml
69 lines (59 loc) · 2.23 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
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name : Terraform AZURE VNET-PEERING
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-vnet-peering
# Badges to display
badges:
- name: "Terraform"
image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
url: "https://www.terraform.io"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
# description of this project
description: |-
Terraform module to create vnet-peering resource on AZURE.
# extra content
include:
- "terraform.md"
# How to use this project
# How to use this project
usage: |-
Here are some examples of how you can use this module in your inventory structure:
### Default vnet-peering
```hcl
module "vnet_peering" {
source = "clouddrove/vnet-peering/azure"
version = "1.0.0"
enabled_peering = true
resource_group_1_name = module.resource_group_1.resource_group_name
resource_group_2_name = module.resource_group_2.resource_group_name
different_rg = true
vnet_1_name = module.vnet.vnet_name[0]
vnet_1_id = module.vnet.vnet_id[0]
vnet_2_name = module.vnet_remote.vnet_name[0]
vnet_2_id = module.vnet_remote.vnet_id[0]
}
```
### vnet-peering in different subscription
```hcl
module "vnet_peering" {
source = "clouddrove/vnet-peering/azure"
version = "1.0.0"
enabled_diff_subs_peering = true
resource_group_1_name = module.resource_group_1.resource_group_name
diff_subs_resource_group_name = data.azurerm_resource_group.mgmt-rg.name
alias_subs_id = "82XXXXXXXXXXXXXXXXXXXXa80"
vnet_1_name = module.vnet.vnet_name[0]
vnet_1_id = module.vnet.vnet_id[0]
vnet_diff_subs_name = data.azurerm_virtual_network.mgmt-staging-vnet.name
vnet_diff_subs_id = data.azurerm_virtual_network.mgmt-staging-vnet.id
}
```