-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.yaml
139 lines (127 loc) · 6.43 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Terraform AZURE CONTAINER REGISTRY (ACR)
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-acr
# Badges to display
badges:
- name: "Terraform"
image: "https://img.shields.io/badge/Terraform-v1.0.0-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 acr resource on AZURE.
# extra content
include:
- "terraform.md"
# How to use this project
# yamllint disable rule:line-length
usage: |-
### Basic Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "container-registry" {
source = "../../"
name = local.name # Name used for specifying tags and other resources naming.(like private endpoint, vnet-link etc)
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
container_registry_config = {
name = "cdacr1234" # Name of Container Registry
sku = "Premium"
}
##-----------------------------------------------------------------------------
## To be mentioned for private endpoint, because private endpoint is enabled by default.
## To disable private endpoint set 'enable_private_endpoint' variable = false and than no need to specify following variable
##-----------------------------------------------------------------------------
virtual_network_id = "vnet_id"
enable_diagnostic = false
}
```
### Complete Example
Here is an example of how you can use this module in your inventory structure:
```hcl
module "container-registry" {
source = "../../"
name = local.name # Name used for specifying tags and other resources naming.(like private endpoint, vnet-link etc)
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
container_registry_config = {
name = "cdacr1234" # Name of Container Registry
sku = "Premium"
}
log_analytics_workspace_id = module.log-analytics.workspace_id
##-----------------------------------------------------------------------------
## To be mentioned for private endpoint, because private endpoint is enabled by default.
## To disable private endpoint set 'enable_private_endpoint' variable = false and than no need to specify following variable
##-----------------------------------------------------------------------------
virtual_network_id = module.vnet.vnet_id
subnet_id = module.subnet.default_subnet_id[0]
}
```
### with_existing_dns_zone_in_diff_rg
Here is an example of how you can use this module in your inventory structure:
```hcl
module "container-registry" {
source = "../../"
name = local.name # Name used for specifying tags and other resources naming.(like private endpoint, vnet-link etc)
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
container_registry_config = {
name = "cdacr1234" # Name of Container Registry
sku = "Premium"
}
log_analytics_workspace_id = module.log-analytics.workspace_id
##-----------------------------------------------------------------------------
## To be mentioned for private endpoint, because private endpoint is enabled by default.
## To disable private endpoint set 'enable_private_endpoint' variable = false and than no need to specify following variable
##-----------------------------------------------------------------------------
virtual_network_id = module.vnet.vnet_id
subnet_id = module.subnet.default_subnet_id[0]
##-----------------------------------------------------------------------------
## Specify following variales when private dns zone is in same subscription but in different resource group
##-----------------------------------------------------------------------------
existing_private_dns_zone = "privatelink.azurecr.io" # Name of private dns zone remain same for acr.
existing_private_dns_zone_resource_group_name = "example_test_rg"
}
```
### with_existing_dns_zone_in_diff_subs
Here is an example of how you can use this module in your inventory structure:
```hcl
module "container-registry" {
ource = "../../"
name = local.name # Name used for specifying tags and other resources naming.(like private endpoint, vnet-link etc)
environment = local.environment
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
container_registry_config = {
name = "cdacr1234" # Name of Container Registry
sku = "Premium"
}
log_analytics_workspace_id = module.log-analytics.workspace_id
##-----------------------------------------------------------------------------
## To be mentioned for private endpoint, because private endpoint is enabled by default.
## To disable private endpoint set 'enable_private_endpoint' variable = false and than no need to specify following variable
##-----------------------------------------------------------------------------
virtual_network_id = module.vnet.vnet_id
subnet_id = module.subnet.default_subnet_id[0]
##-----------------------------------------------------------------------------
## Specify following variales when private dns zone is in different subscription.
##-----------------------------------------------------------------------------
diff_sub = true
alias_sub = "35XXXXXXXXXXXX67" # Subcription id in which dns zone is present.
existing_private_dns_zone = "privatelink.azurecr.io" # Name of private dns zone remain same for acr.
existing_private_dns_zone_resource_group_name = "example_test_rg"
}
```