Skip to content

Commit 8da0747

Browse files
committed
fix: bump terraform-plugin-docs and fix docs
There seems to have been a bug in the previous versions which caused our docs to be messed up. BD-1939 [BD-1939](https://meshcloud.bolddesk.com/agent/tickets/1939)
1 parent d8759c9 commit 8da0747

17 files changed

+139
-74
lines changed

docs/data-sources/landingzone.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,16 @@ Optional:
111111
- `aws_lambda_arn` (String) If provided, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.
112112

113113
<a id="nestedatt--spec--platform_properties--aws--aws_role_mappings"></a>
114-
### Nested Schema for `spec.platform_properties.aws.aws_lambda_arn`
114+
### Nested Schema for `spec.platform_properties.aws.aws_role_mappings`
115115

116116
Required:
117117

118118
- `platform_role` (String) The AWS platform role
119119
- `policies` (List of String) List of policies associated with this role mapping
120-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--aws--aws_lambda_arn--project_role_ref))
120+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--aws--aws_role_mappings--project_role_ref))
121121

122-
<a id="nestedatt--spec--platform_properties--aws--aws_lambda_arn--project_role_ref"></a>
123-
### Nested Schema for `spec.platform_properties.aws.aws_lambda_arn.project_role_ref`
122+
<a id="nestedatt--spec--platform_properties--aws--aws_role_mappings--project_role_ref"></a>
123+
### Nested Schema for `spec.platform_properties.aws.aws_role_mappings.project_role_ref`
124124

125125
Required:
126126

@@ -189,16 +189,16 @@ Optional:
189189
- `azure_function` (Attributes) Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud. (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_function))
190190

191191
<a id="nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings"></a>
192-
### Nested Schema for `spec.platform_properties.azurerg.azure_function`
192+
### Nested Schema for `spec.platform_properties.azurerg.azure_rg_role_mappings`
193193

194194
Required:
195195

196196
- `azure_group_suffix` (String) The given role name will be injected into the group name via the group naming pattern configured on the platform instance.
197197
- `azure_role_definition_ids` (List of String) Role Definitions with the given IDs will be attached to this Azure Role.
198-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_function--project_role_ref))
198+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings--project_role_ref))
199199

200-
<a id="nestedatt--spec--platform_properties--azurerg--azure_function--project_role_ref"></a>
201-
### Nested Schema for `spec.platform_properties.azurerg.azure_function.project_role_ref`
200+
<a id="nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings--project_role_ref"></a>
201+
### Nested Schema for `spec.platform_properties.azurerg.azure_rg_role_mappings.project_role_ref`
202202

203203
Required:
204204

@@ -233,15 +233,15 @@ Optional:
233233
- `gcp_folder_id` (String) Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone.
234234

235235
<a id="nestedatt--spec--platform_properties--gcp--gcp_role_mappings"></a>
236-
### Nested Schema for `spec.platform_properties.gcp.gcp_folder_id`
236+
### Nested Schema for `spec.platform_properties.gcp.gcp_role_mappings`
237237

238238
Required:
239239

240240
- `platform_roles` (List of String) Can be empty. List of GCP IAM roles to assign to the meshProject role.
241-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--gcp--gcp_folder_id--project_role_ref))
241+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--gcp--gcp_role_mappings--project_role_ref))
242242

243-
<a id="nestedatt--spec--platform_properties--gcp--gcp_folder_id--project_role_ref"></a>
244-
### Nested Schema for `spec.platform_properties.gcp.gcp_folder_id.project_role_ref`
243+
<a id="nestedatt--spec--platform_properties--gcp--gcp_role_mappings--project_role_ref"></a>
244+
### Nested Schema for `spec.platform_properties.gcp.gcp_role_mappings.project_role_ref`
245245

246246
Required:
247247

docs/data-sources/platform.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Read-Only:
166166
- `workload_identity_config` (Attributes) Workload identity configuration (alternative to `service_user_config`) (see [below for nested schema](#nestedatt--spec--config--aws--replication--access_config--workload_identity_config))
167167

168168
<a id="nestedatt--spec--config--aws--replication--access_config--service_user_config"></a>
169-
### Nested Schema for `spec.config.aws.replication.access_config.workload_identity_config`
169+
### Nested Schema for `spec.config.aws.replication.access_config.service_user_config`
170170

171171
Read-Only:
172172

@@ -196,11 +196,11 @@ Read-Only:
196196
- `sso_access_token` (String) The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center.
197197

198198
<a id="nestedatt--spec--config--aws--replication--aws_sso--aws_role_mappings"></a>
199-
### Nested Schema for `spec.config.aws.replication.aws_sso.sso_access_token`
199+
### Nested Schema for `spec.config.aws.replication.aws_sso.aws_role_mappings`
200200

201201
Required:
202202

203-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--config--aws--replication--aws_sso--sso_access_token--project_role_ref))
203+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--config--aws--replication--aws_sso--aws_role_mappings--project_role_ref))
204204

205205
Optional:
206206

@@ -210,8 +210,8 @@ Read-Only:
210210

211211
- `aws_role` (String) The AWS role name
212212

213-
<a id="nestedatt--spec--config--aws--replication--aws_sso--sso_access_token--project_role_ref"></a>
214-
### Nested Schema for `spec.config.aws.replication.aws_sso.sso_access_token.aws_role`
213+
<a id="nestedatt--spec--config--aws--replication--aws_sso--aws_role_mappings--project_role_ref"></a>
214+
### Nested Schema for `spec.config.aws.replication.aws_sso.aws_role_mappings.project_role_ref`
215215

216216
Required:
217217

@@ -292,7 +292,7 @@ Read-Only:
292292
- `azure_role` (Attributes) The Azure role definition. (see [below for nested schema](#nestedatt--spec--config--azure--replication--azure_role_mappings--azure_role))
293293

294294
<a id="nestedatt--spec--config--azure--replication--azure_role_mappings--project_role_ref"></a>
295-
### Nested Schema for `spec.config.azure.replication.azure_role_mappings.azure_role`
295+
### Nested Schema for `spec.config.azure.replication.azure_role_mappings.project_role_ref`
296296

297297
Required:
298298

@@ -333,18 +333,18 @@ Read-Only:
333333
- `subscription_owner_object_ids` (List of String) One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID. You can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.
334334

335335
<a id="nestedatt--spec--config--azure--replication--provisioning--customer_agreement"></a>
336-
### Nested Schema for `spec.config.azure.replication.provisioning.subscription_owner_object_ids`
336+
### Nested Schema for `spec.config.azure.replication.provisioning.customer_agreement`
337337

338338
Read-Only:
339339

340340
- `billing_scope` (String) ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`.
341341
- `destination_entra_id` (String) Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones.
342342
- `source_entra_tenant` (String) Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID.
343-
- `source_service_principal` (Attributes) Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the [Azure docs](https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants). (see [below for nested schema](#nestedatt--spec--config--azure--replication--provisioning--subscription_owner_object_ids--source_service_principal))
343+
- `source_service_principal` (Attributes) Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the [Azure docs](https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants). (see [below for nested schema](#nestedatt--spec--config--azure--replication--provisioning--customer_agreement--source_service_principal))
344344
- `subscription_creation_error_cooldown_sec` (Number) This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.
345345

346-
<a id="nestedatt--spec--config--azure--replication--provisioning--subscription_owner_object_ids--source_service_principal"></a>
347-
### Nested Schema for `spec.config.azure.replication.provisioning.subscription_owner_object_ids.subscription_creation_error_cooldown_sec`
346+
<a id="nestedatt--spec--config--azure--replication--provisioning--customer_agreement--source_service_principal"></a>
347+
### Nested Schema for `spec.config.azure.replication.provisioning.customer_agreement.source_service_principal`
348348

349349
Read-Only:
350350

@@ -355,7 +355,7 @@ Read-Only:
355355

356356

357357
<a id="nestedatt--spec--config--azure--replication--provisioning--enterprise_enrollment"></a>
358-
### Nested Schema for `spec.config.azure.replication.provisioning.subscription_owner_object_ids`
358+
### Nested Schema for `spec.config.azure.replication.provisioning.enterprise_enrollment`
359359

360360
Read-Only:
361361

@@ -366,7 +366,7 @@ Read-Only:
366366

367367

368368
<a id="nestedatt--spec--config--azure--replication--provisioning--pre_provisioned"></a>
369-
### Nested Schema for `spec.config.azure.replication.provisioning.subscription_owner_object_ids`
369+
### Nested Schema for `spec.config.azure.replication.provisioning.pre_provisioned`
370370

371371
Read-Only:
372372

@@ -506,7 +506,7 @@ Read-Only:
506506
- `gcp_role` (String) The GCP IAM role
507507

508508
<a id="nestedatt--spec--config--gcp--replication--gcp_role_mappings--project_role_ref"></a>
509-
### Nested Schema for `spec.config.gcp.replication.gcp_role_mappings.gcp_role`
509+
### Nested Schema for `spec.config.gcp.replication.gcp_role_mappings.project_role_ref`
510510

511511
Required:
512512

@@ -527,7 +527,7 @@ Read-Only:
527527
- `service_account_workload_identity_config` (Attributes) Service account workload identity configuration (alternative to serviceAccountCredentialsConfig) (see [below for nested schema](#nestedatt--spec--config--gcp--replication--service_account_config--service_account_workload_identity_config))
528528

529529
<a id="nestedatt--spec--config--gcp--replication--service_account_config--service_account_credentials_config"></a>
530-
### Nested Schema for `spec.config.gcp.replication.service_account_config.service_account_workload_identity_config`
530+
### Nested Schema for `spec.config.gcp.replication.service_account_config.service_account_credentials_config`
531531

532532
Read-Only:
533533

@@ -633,7 +633,7 @@ Read-Only:
633633
- `openshift_role` (String) The OpenShift role name
634634

635635
<a id="nestedatt--spec--config--openshift--replication--openshift_role_mappings--project_role_ref"></a>
636-
### Nested Schema for `spec.config.openshift.replication.openshift_role_mappings.openshift_role`
636+
### Nested Schema for `spec.config.openshift.replication.openshift_role_mappings.project_role_ref`
637637

638638
Required:
639639

docs/data-sources/tag_definition.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Read-Only:
7575
- `string` (Attributes) string, represented as JSON string (see [below for nested schema](#nestedatt--tag_definition--spec--value_type--string))
7676

7777
<a id="nestedatt--tag_definition--spec--value_type--email"></a>
78-
### Nested Schema for `tag_definition.spec.value_type.string`
78+
### Nested Schema for `tag_definition.spec.value_type.email`
7979

8080
Read-Only:
8181

@@ -84,15 +84,15 @@ Read-Only:
8484

8585

8686
<a id="nestedatt--tag_definition--spec--value_type--integer"></a>
87-
### Nested Schema for `tag_definition.spec.value_type.string`
87+
### Nested Schema for `tag_definition.spec.value_type.integer`
8888

8989
Read-Only:
9090

9191
- `default_value` (Number) The default value of the tag.
9292

9393

9494
<a id="nestedatt--tag_definition--spec--value_type--multi_select"></a>
95-
### Nested Schema for `tag_definition.spec.value_type.string`
95+
### Nested Schema for `tag_definition.spec.value_type.multi_select`
9696

9797
Read-Only:
9898

@@ -101,15 +101,15 @@ Read-Only:
101101

102102

103103
<a id="nestedatt--tag_definition--spec--value_type--number"></a>
104-
### Nested Schema for `tag_definition.spec.value_type.string`
104+
### Nested Schema for `tag_definition.spec.value_type.number`
105105

106106
Read-Only:
107107

108108
- `default_value` (Number) The default value of the tag.
109109

110110

111111
<a id="nestedatt--tag_definition--spec--value_type--single_select"></a>
112-
### Nested Schema for `tag_definition.spec.value_type.string`
112+
### Nested Schema for `tag_definition.spec.value_type.single_select`
113113

114114
Read-Only:
115115

docs/data-sources/tag_definitions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Read-Only:
7171
- `string` (Attributes) string, represented as JSON string (see [below for nested schema](#nestedatt--tag_definitions--spec--value_type--string))
7272

7373
<a id="nestedatt--tag_definitions--spec--value_type--email"></a>
74-
### Nested Schema for `tag_definitions.spec.value_type.string`
74+
### Nested Schema for `tag_definitions.spec.value_type.email`
7575

7676
Read-Only:
7777

@@ -80,15 +80,15 @@ Read-Only:
8080

8181

8282
<a id="nestedatt--tag_definitions--spec--value_type--integer"></a>
83-
### Nested Schema for `tag_definitions.spec.value_type.string`
83+
### Nested Schema for `tag_definitions.spec.value_type.integer`
8484

8585
Read-Only:
8686

8787
- `default_value` (Number) The default value of the tag.
8888

8989

9090
<a id="nestedatt--tag_definitions--spec--value_type--multi_select"></a>
91-
### Nested Schema for `tag_definitions.spec.value_type.string`
91+
### Nested Schema for `tag_definitions.spec.value_type.multi_select`
9292

9393
Read-Only:
9494

@@ -97,15 +97,15 @@ Read-Only:
9797

9898

9999
<a id="nestedatt--tag_definitions--spec--value_type--number"></a>
100-
### Nested Schema for `tag_definitions.spec.value_type.string`
100+
### Nested Schema for `tag_definitions.spec.value_type.number`
101101

102102
Read-Only:
103103

104104
- `default_value` (Number) The default value of the tag.
105105

106106

107107
<a id="nestedatt--tag_definitions--spec--value_type--single_select"></a>
108-
### Nested Schema for `tag_definitions.spec.value_type.string`
108+
### Nested Schema for `tag_definitions.spec.value_type.single_select`
109109

110110
Read-Only:
111111

docs/resources/landingzone.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -114,16 +114,16 @@ Optional:
114114
- `aws_lambda_arn` (String) If provided, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.
115115

116116
<a id="nestedatt--spec--platform_properties--aws--aws_role_mappings"></a>
117-
### Nested Schema for `spec.platform_properties.aws.aws_lambda_arn`
117+
### Nested Schema for `spec.platform_properties.aws.aws_role_mappings`
118118

119119
Required:
120120

121121
- `platform_role` (String) The AWS platform role
122122
- `policies` (List of String) List of policies associated with this role mapping
123-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--aws--aws_lambda_arn--project_role_ref))
123+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--aws--aws_role_mappings--project_role_ref))
124124

125-
<a id="nestedatt--spec--platform_properties--aws--aws_lambda_arn--project_role_ref"></a>
126-
### Nested Schema for `spec.platform_properties.aws.aws_lambda_arn.project_role_ref`
125+
<a id="nestedatt--spec--platform_properties--aws--aws_role_mappings--project_role_ref"></a>
126+
### Nested Schema for `spec.platform_properties.aws.aws_role_mappings.project_role_ref`
127127

128128
Required:
129129

@@ -192,16 +192,16 @@ Optional:
192192
- `azure_function` (Attributes) Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud. (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_function))
193193

194194
<a id="nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings"></a>
195-
### Nested Schema for `spec.platform_properties.azurerg.azure_function`
195+
### Nested Schema for `spec.platform_properties.azurerg.azure_rg_role_mappings`
196196

197197
Required:
198198

199199
- `azure_group_suffix` (String) The given role name will be injected into the group name via the group naming pattern configured on the platform instance.
200200
- `azure_role_definition_ids` (List of String) Role Definitions with the given IDs will be attached to this Azure Role.
201-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_function--project_role_ref))
201+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings--project_role_ref))
202202

203-
<a id="nestedatt--spec--platform_properties--azurerg--azure_function--project_role_ref"></a>
204-
### Nested Schema for `spec.platform_properties.azurerg.azure_function.project_role_ref`
203+
<a id="nestedatt--spec--platform_properties--azurerg--azure_rg_role_mappings--project_role_ref"></a>
204+
### Nested Schema for `spec.platform_properties.azurerg.azure_rg_role_mappings.project_role_ref`
205205

206206
Required:
207207

@@ -236,15 +236,15 @@ Optional:
236236
- `gcp_folder_id` (String) Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone.
237237

238238
<a id="nestedatt--spec--platform_properties--gcp--gcp_role_mappings"></a>
239-
### Nested Schema for `spec.platform_properties.gcp.gcp_folder_id`
239+
### Nested Schema for `spec.platform_properties.gcp.gcp_role_mappings`
240240

241241
Required:
242242

243243
- `platform_roles` (List of String) Can be empty. List of GCP IAM roles to assign to the meshProject role.
244-
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--gcp--gcp_folder_id--project_role_ref))
244+
- `project_role_ref` (Attributes) the meshProject role (see [below for nested schema](#nestedatt--spec--platform_properties--gcp--gcp_role_mappings--project_role_ref))
245245

246-
<a id="nestedatt--spec--platform_properties--gcp--gcp_folder_id--project_role_ref"></a>
247-
### Nested Schema for `spec.platform_properties.gcp.gcp_folder_id.project_role_ref`
246+
<a id="nestedatt--spec--platform_properties--gcp--gcp_role_mappings--project_role_ref"></a>
247+
### Nested Schema for `spec.platform_properties.gcp.gcp_role_mappings.project_role_ref`
248248

249249
Required:
250250

0 commit comments

Comments
 (0)