Skip to content

Commit c95dee5

Browse files
committed
Update documentation
1 parent 37adee6 commit c95dee5

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

container-registry/README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 |
8+
## Usage
9+
Basic usage of this module is as follows:
10+
```hcl
11+
module "example" {
12+
source = "<module-path>"
13+
14+
# Required variables
15+
container_registry_config =
16+
17+
# Optional variables
18+
application_name = "devwithkrishna"
19+
azure_services_bypass = "AzureServices"
20+
container_registry_name = ""
21+
environment = "DEV"
22+
georeplications = []
23+
location = ""
24+
resource_group_name = ""
25+
sku_name = "Basic"
26+
temporary = "TRUE"
27+
}
28+
```
29+
30+
## Resources
31+
32+
| Name | Type |
33+
|------|------|
34+
| [azurerm_container_registry.acr](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/container_registry) | resource |
35+
| [azurerm_resource_group.acr_rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
36+
37+
## Inputs
38+
39+
| Name | Description | Type | Required |
40+
|------|-------------|------|:--------:|
41+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
42+
| <a name="input_azure_services_bypass"></a> [azure_services_bypass](#input_azure_services_bypass) | Whether to allow trusted Azure services to access a network restricted Container Registry? Possible values are None and AzureServices. Defaults to AzureServices | `string` | no |
43+
| <a name="input_container_registry_config"></a> [container_registry_config](#input_container_registry_config) | Manages an Azure Container Registry | ```object({ admin_enabled = optional(bool) quarantine_policy_enabled = optional(bool) zone_redundancy_enabled = optional(bool) public_network_access_enabled = optional(bool) retention_policy_in_days = optional(number) trust_policy_enabled = optional(bool) anonymous_pull_enabled = optional(bool) data_endpoint_enabled = optional(bool) })``` | yes |
44+
| <a name="input_container_registry_name"></a> [container_registry_name](#input_container_registry_name) | Azure container registry name | `string` | no |
45+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
46+
| <a name="input_georeplications"></a> [georeplications](#input_georeplications) | A list of Azure locations where the container registry should be geo-replicated | ```list(object({ location = string zone_redundancy_enabled = optional(bool) }))``` | no |
47+
| <a name="input_location"></a> [location](#input_location) | Azure container registry location | `string` | no |
48+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure container registry Rg | `string` | no |
49+
| <a name="input_sku_name"></a> [sku_name](#input_sku_name) | Container registry SKUs available in Azure. Valid options are Basic, Standard or Premium | `string` | no |
50+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
51+
52+
## Outputs
53+
54+
| Name | Description |
55+
|------|-------------|
56+
| <a name="output_acr_admin_enabled"></a> [acr_admin_enabled](#output_acr_admin_enabled) | Admin user is enabled for acr or not |
57+
| <a name="output_acr_admin_password"></a> [acr_admin_password](#output_acr_admin_password) | Password associated with the Container Registry Admin account - if the admin account is enabled |
58+
| <a name="output_acr_admin_username"></a> [acr_admin_username](#output_acr_admin_username) | Username associated with the Container Registry Admin account - if the admin account is enabled |
59+
| <a name="output_acr_anonymous_pull_enabled"></a> [acr_anonymous_pull_enabled](#output_acr_anonymous_pull_enabled) | Anonymous pull is enabled on ACR or not |
60+
| <a name="output_acr_login_server"></a> [acr_login_server](#output_acr_login_server) | The URL that can be used to log into the container registry |
61+
| <a name="output_acr_rg"></a> [acr_rg](#output_acr_rg) | Azure container registry RG |
62+
| <a name="output_container_registry_name"></a> [container_registry_name](#output_container_registry_name) | Azure container registry name |
63+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)