generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.yaml
69 lines (61 loc) · 1.6 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
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name : Terraform DigitalOcean Domain
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: terraform-do-modules/terraform-digitalocean-domain
# Badges to display
badges:
- name: "Terraform"
image: "https://img.shields.io/badge/Terraform-v0.15-green"
url: "https://www.terraform.io"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
prerequesties:
- name: Terraform
url: https://learn.hashicorp.com/terraform/getting-started/install.html
version: ">= 1.4.6"
# description of this project
description: |-
Terraform module to create Digitalocean Domain service resource on Digitalocean.
# extra content
include:
- "terraform.md"
# How to use this project
usage : |-
### Simple Example
Here are some examples of how you can use this module in your inventory structure:
## basic example
```hcl
module "domain" {
source = "terraform-do-modules/domain/digitalocean"
version = "1.0.0"
name = "test.example.com"
}
```
## complete example
```hcl
module "domain" {
source = "terraform-do-modules/domain/digitalocean"
version = "1.0.0"
name = "demo.hello.com"
records = {
record1 = {
type = "A"
name = "test"
value = "192.168.0.12"
},
record2 = {
type = "A"
name = "demo2"
value = "192.168.0.13"
},
}
}
```