Skip to content

Commit 1997ca9

Browse files
malhussanmalhussan
committed
Generate READMEs via terraform-docs
Includes modifications https://github.com/terraform-docs/terraform-docs
1 parent 7e01592 commit 1997ca9

File tree

5 files changed

+234
-5
lines changed

5 files changed

+234
-5
lines changed

‎README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ module "meshplatform" {
6666
}
6767
```
6868
69-
If UAMI blueprint user principal is required, you also need to pass a list of subscriptions this user will be assigned to.
69+
If UAMI blueprint user principal is needed, you also need to pass a list of subscriptions this user will be assigned to.
7070
7171
```hcl
7272
module "meshplatform" {
@@ -82,3 +82,57 @@ module "meshplatform" {
8282
]
8383
}
8484
```
85+
86+
## Requirements
87+
88+
| Name | Version |
89+
|------|---------|
90+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
91+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.12.0 |
92+
93+
## Providers
94+
95+
| Name | Version |
96+
|------|---------|
97+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.12.0 |
98+
99+
## Modules
100+
101+
| Name | Source | Version |
102+
|------|--------|---------|
103+
| <a name="module_idp_lookup_spp"></a> [idp\_lookup\_spp](#module\_idp\_lookup\_spp) | ./modules/meshcloud-idp-lookup-spp/ | n/a |
104+
| <a name="module_kraken_spp"></a> [kraken\_spp](#module\_kraken\_spp) | ./modules/meshcloud-kraken-spp/ | n/a |
105+
| <a name="module_replicator_spp"></a> [replicator\_spp](#module\_replicator\_spp) | ./modules/meshcloud-replicator-spp/ | n/a |
106+
| <a name="module_uami_blueprint_user_principal"></a> [uami\_blueprint\_user\_principal](#module\_uami\_blueprint\_user\_principal) | ./modules/uami-blueprint-user-principal/ | n/a |
107+
108+
## Resources
109+
110+
| Name | Type |
111+
|------|------|
112+
| [azurerm_management_group.root](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/data-sources/management_group) | data source |
113+
114+
## Inputs
115+
116+
| Name | Description | Type | Default | Required |
117+
|------|-------------|------|---------|:--------:|
118+
| <a name="input_additional_permissions"></a> [additional\_permissions](#input\_additional\_permissions) | Additional Subscription-Level Permissions that the SPP needs | `list(string)` | `[]` | no |
119+
| <a name="input_additional_required_resource_accesses"></a> [additional\_required\_resource\_accesses](#input\_additional\_required\_resource\_accesses) | Additional AAD-Level Resource Accesses the customer needs | `list(object({ resource_app_id = string, resource_accesses = list(object({ id = string, type = string })) }))` | `[]` | no |
120+
| <a name="input_idplookup_enabled"></a> [idplookup\_enabled](#input\_idplookup\_enabled) | Whether to create idplookup SPP or not. | `bool` | `true` | no |
121+
| <a name="input_kraken_enabled"></a> [kraken\_enabled](#input\_kraken\_enabled) | Whether to create kraken SPP or not. | `bool` | `true` | no |
122+
| <a name="input_mgmt_group_name"></a> [mgmt\_group\_name](#input\_mgmt\_group\_name) | The name or UUID of the Management Group. | `string` | n/a | yes |
123+
| <a name="input_replicator_enabled"></a> [replicator\_enabled](#input\_replicator\_enabled) | Whether to create replicator SPP or not. | `bool` | `true` | no |
124+
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
125+
| <a name="input_subscriptions"></a> [subscriptions](#input\_subscriptions) | The scope to which UAMI blueprint service principal role assignment is applied. | `list(any)` | `[]` | no |
126+
127+
## Outputs
128+
129+
| Name | Description |
130+
|------|-------------|
131+
| <a name="output_idp_lookup_spp"></a> [idp\_lookup\_spp](#output\_idp\_lookup\_spp) | IDP Lookup Service Principal. |
132+
| <a name="output_idp_lookup_spp_password"></a> [idp\_lookup\_spp\_password](#output\_idp\_lookup\_spp\_password) | Password for IDP Lookup Service Principal. |
133+
| <a name="output_kraken_spp"></a> [kraken\_spp](#output\_kraken\_spp) | Kraken Service Principal. |
134+
| <a name="output_kraken_spp_password"></a> [kraken\_spp\_password](#output\_kraken\_spp\_password) | Password for Kraken Service Principal. |
135+
| <a name="output_replicator_spp"></a> [replicator\_spp](#output\_replicator\_spp) | Replicator Service Principal. |
136+
| <a name="output_replicator_spp_password"></a> [replicator\_spp\_password](#output\_replicator\_spp\_password) | Password for Replicator Service Principal. |
137+
| <a name="output_uami_blueprint_user_principal"></a> [uami\_blueprint\_user\_principal](#output\_uami\_blueprint\_user\_principal) | UAMI Blueprint Assignment Service Principal. |
138+
| <a name="output_uami_blueprint_user_principal_password"></a> [uami\_blueprint\_user\_principal\_password](#output\_uami\_blueprint\_user\_principal\_password) | Password for UAMI Blueprint Assignment Service Principal. |

‎modules/meshcloud-idp-lookup-spp/README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
This module creates an Azure Service Principal (Azure SPP) that is used by meshStack for User lookups in AAD IDP.
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
6+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 0.9.0 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.12.0 |
8+
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 0.9.0 |
15+
| <a name="provider_random"></a> [random](#provider\_random) | 2.2.1 |
16+
17+
## Modules
18+
19+
No modules.
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [azuread_application.meshcloud_idp_lookup](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/application) | resource |
26+
| [azuread_service_principal.meshcloud_idp_lookup](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal) | resource |
27+
| [azuread_service_principal_password.spp_pw](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal_password) | resource |
28+
| [random_password.spp_pw](https://registry.terraform.io/providers/hashicorp/random/2.2.1/docs/resources/password) | resource |
29+
30+
## Inputs
31+
32+
| Name | Description | Type | Default | Required |
33+
|------|-------------|------|---------|:--------:|
34+
| <a name="input_scope"></a> [scope](#input\_scope) | The scope to which SPP permissions should be assigned to. Usually this is a management group that sits atop the subscriptions | `string` | n/a | yes |
35+
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
36+
37+
## Outputs
38+
39+
| Name | Description |
40+
|------|-------------|
41+
| <a name="output_service_principal"></a> [service\_principal](#output\_service\_principal) | n/a |
42+
| <a name="output_service_principal_password"></a> [service\_principal\_password](#output\_service\_principal\_password) | Password for the Service Principal. |

‎modules/meshcloud-kraken-spp/README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
This module creates an Azure Service Principal (Azure SPP) that is used by meshStack to import metering data from Azure.
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
6+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 0.9.0 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.12.0 |
8+
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 0.9.0 |
15+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.12.0 |
16+
| <a name="provider_random"></a> [random](#provider\_random) | 2.2.1 |
17+
18+
## Modules
19+
20+
No modules.
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [azuread_application.meshcloud_kraken](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/application) | resource |
27+
| [azuread_service_principal.meshcloud_kraken](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal) | resource |
28+
| [azuread_service_principal_password.spp_pw](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal_password) | resource |
29+
| [azurerm_role_assignment.meshcloud_kraken](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_assignment) | resource |
30+
| [azurerm_role_assignment.meshcloud_kraken_cloud_inventory](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_assignment) | resource |
31+
| [azurerm_role_definition.meshcloud_kraken_cloud_inventory_role](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_definition) | resource |
32+
| [random_password.spp_pw](https://registry.terraform.io/providers/hashicorp/random/2.2.1/docs/resources/password) | resource |
33+
34+
## Inputs
35+
36+
| Name | Description | Type | Default | Required |
37+
|------|-------------|------|---------|:--------:|
38+
| <a name="input_scope"></a> [scope](#input\_scope) | The scope to which SPP permissions should be assigned to. Usually this is a management group that sits atop the subscriptions | `string` | n/a | yes |
39+
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
40+
41+
## Outputs
42+
43+
| Name | Description |
44+
|------|-------------|
45+
| <a name="output_service_principal"></a> [service\_principal](#output\_service\_principal) | n/a |
46+
| <a name="output_service_principal_password"></a> [service\_principal\_password](#output\_service\_principal\_password) | Password for the Service Principal. |

‎modules/meshcloud-replicator-spp/README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
This module creates an Azure Service Principal (Azure SPP) that is used by meshStack for replication.
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
6+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 0.9.0 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.12.0 |
8+
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 0.9.0 |
15+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.12.0 |
16+
| <a name="provider_random"></a> [random](#provider\_random) | 2.2.1 |
17+
18+
## Modules
19+
20+
No modules.
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [azuread_application.meshcloud_replicator](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/application) | resource |
27+
| [azuread_service_principal.meshcloud_replicator](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal) | resource |
28+
| [azuread_service_principal_password.spp_pw](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal_password) | resource |
29+
| [azurerm_role_assignment.meshcloud_replicator](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_assignment) | resource |
30+
| [azurerm_role_definition.meshcloud_replicator](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_definition) | resource |
31+
| [random_password.spp_pw](https://registry.terraform.io/providers/hashicorp/random/2.2.1/docs/resources/password) | resource |
32+
33+
## Inputs
34+
35+
| Name | Description | Type | Default | Required |
36+
|------|-------------|------|---------|:--------:|
37+
| <a name="input_additional_permissions"></a> [additional\_permissions](#input\_additional\_permissions) | Additional Subscription-Level Permissions that the SPP needs | `list(string)` | `[]` | no |
38+
| <a name="input_additional_required_resource_accesses"></a> [additional\_required\_resource\_accesses](#input\_additional\_required\_resource\_accesses) | Additional AAD-Level Resource Accesses the customer needs | `list(object({ resource_app_id = string, resource_accesses = list(object({ id = string, type = string })) }))` | `[]` | no |
39+
| <a name="input_scope"></a> [scope](#input\_scope) | The scope to which SPP permissions should be assigned to. Usually this is a management group that sits atop the subscriptions | `string` | n/a | yes |
40+
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
41+
42+
## Outputs
43+
44+
| Name | Description |
45+
|------|-------------|
46+
| <a name="output_service_principal"></a> [service\_principal](#output\_service\_principal) | n/a |
47+
| <a name="output_service_principal_password"></a> [service\_principal\_password](#output\_service\_principal\_password) | Password for the Service Principal. |

‎modules/uami-blueprint-user-principal/README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
This module creates an Azure Service Principal (Azure SPP) that is used by meshStack for UAMI blueprint assignment.
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
6+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 0.9.0 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.12.0 |
8+
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 0.9.0 |
15+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.12.0 |
16+
| <a name="provider_random"></a> [random](#provider\_random) | 2.2.1 |
17+
18+
## Modules
19+
20+
No modules.
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [azuread_application.uami_blueprint_principal](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/application) | resource |
27+
| [azuread_service_principal.uami_blueprint_principal](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal) | resource |
28+
| [azuread_service_principal_password.spp_pw](https://registry.terraform.io/providers/hashicorp/azuread/0.9.0/docs/resources/service_principal_password) | resource |
29+
| [azurerm_role_assignment.spp_pw](https://registry.terraform.io/providers/hashicorp/azurerm/2.12.0/docs/resources/role_assignment) | resource |
30+
| [random_password.spp_pw](https://registry.terraform.io/providers/hashicorp/random/2.2.1/docs/resources/password) | resource |
31+
32+
## Inputs
33+
34+
| Name | Description | Type | Default | Required |
35+
|------|-------------|------|---------|:--------:|
36+
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
37+
| <a name="input_subscriptions"></a> [subscriptions](#input\_subscriptions) | The scope to which UAMI blueprint service principal role assignment is applied. | `list(any)` | n/a | yes |
38+
39+
## Outputs
40+
41+
| Name | Description |
42+
|------|-------------|
43+
| <a name="output_service_principal"></a> [service\_principal](#output\_service\_principal) | n/a |
44+
| <a name="output_service_principal_password"></a> [service\_principal\_password](#output\_service\_principal\_password) | n/a |

0 commit comments

Comments
 (0)