Skip to content

Commit d646a4d

Browse files
author
Deutsche Telekom MMS
committed
update due to new release
1 parent 8ca99d5 commit d646a4d

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,82 @@ This module manages the azurerm base resources.
55
## Usage
66

77
![See .terraform-docs.yml to generate docs]
8+
9+
<!-- BEGIN_TF_DOCS -->
10+
# base
11+
12+
This module manages the azurerm base resources, see https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs.
13+
14+
For more information about the module structure see https://telekom-mms.github.io/terraform-template.
15+
16+
_<-- This file is autogenerated, please do not change. -->_
17+
18+
## Requirements
19+
20+
| Name | Version |
21+
|------|---------|
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5 |
23+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >= 4.0, < 5.0 |
24+
25+
## Providers
26+
27+
| Name | Version |
28+
|------|---------|
29+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | >= 4.0, < 5.0 |
30+
31+
## Resources
32+
33+
| Name | Type |
34+
|------|------|
35+
| [azurerm_resource_group.resource_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
36+
37+
## Inputs
38+
39+
| Name | Description | Type | Default | Required |
40+
|------|-------------|------|---------|:--------:|
41+
| <a name="input_resource_group"></a> [resource\_group](#input\_resource\_group) | Resource definition, default settings are defined within locals and merged with var settings. For more information look at [Outputs](#Outputs). | `any` | `{}` | no |
42+
43+
## Outputs
44+
45+
| Name | Description |
46+
|------|-------------|
47+
| <a name="output_resource_group"></a> [resource\_group](#output\_resource\_group) | Outputs all attributes of azurerm\_resource\_group. |
48+
| <a name="output_variables"></a> [variables](#output\_variables) | Displays all configurable variables passed by the module. __default\_\_ = predefined values per module. \_\_merged__ = result of merging the default values and custom values passed to the module |
49+
50+
## Examples
51+
52+
Minimal configuration to install the desired resources with the module
53+
54+
```hcl
55+
module "base" {
56+
source = "registry.terraform.io/telekom-mms/base/azurerm"
57+
58+
resource_group = {
59+
rg-mms-github = {
60+
location = "westeurope"
61+
}
62+
}
63+
}
64+
```
65+
66+
Advanced configuration to install the desired resources with the module
67+
68+
```hcl
69+
module "base" {
70+
source = "registry.terraform.io/telekom-mms/base/azurerm"
71+
72+
resource_group = {
73+
github = {
74+
name = "rg-mms-github"
75+
location = "westeurope"
76+
managed_by = "opentofu"
77+
tags = {
78+
project = "mms-github"
79+
environment = terraform.workspace
80+
managed-by = "opentofu"
81+
}
82+
}
83+
}
84+
}
85+
```
86+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)