generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.yaml
79 lines (69 loc) · 2.22 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
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Terraform AZURE DNS
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-dns
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/terraform-azure-dns.svg"
url: "https://github.com/clouddrove/terraform-azure-dns/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-azure-dns/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-azure-dns/actions/workflows/tfsec.yml"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
# description of this project
description: |-
Terraform module to create dns resource on AZURE.
# extra content
include:
- "terraform.md"
# How to use this project
# yamllint disable rule:line-length
usage: |-
### Simple Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "dns_zone" {
depends_on = [module.resource_group, module.vnet]
source = "clouddrove/dns/azure"
label_order = ["name", "environment"]
name = "app"
environment = "test"
resource_group_name = module.resource_group.resource_group_name
enabled_dns = true
dns_zone_names = "example.com"
private_registration_enabled = false
private_dns = false
private_dns_zone_name = ""
virtual_network_id = module.vnet.vnet_id
a_records = [{
name = "test"
ttl = 3600
records = ["10.0.180.17","10.0.180.18"]
},
{
name = "test2"
ttl = 3600
records = ["10.0.180.17","10.0.180.18"]
}]
cname_records = [{
name = "test1"
ttl = 3600
record = "example.com"
}]
ns_records = [{
name = "test2"
ttl = 3600
records = ["ns1.example.com.","ns2.example.com."]
}]
}
```