Skip to content

Commit 3899684

Browse files
malhussanmeshkodiak[bot]
malhussan
authored and
meshkodiak[bot]
committed
refactor: use full name instead of SPP abbreviation
More clarity
1 parent 0054ee1 commit 3899684

File tree

31 files changed

+143
-142
lines changed

31 files changed

+143
-142
lines changed

‎TERRAFORM_DOCS.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010

1111
| Name | Version |
1212
|------|---------|
13-
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 2.18.0 |
14-
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.97.0 |
13+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | 0.9.0 |
14+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 2.12.0 |
1515

1616
## Modules
1717

1818
| Name | Source | Version |
1919
|------|--------|---------|
20-
| <a name="module_idp_lookup_spp"></a> [idp\_lookup\_spp](#module\_idp\_lookup\_spp) | ./modules/meshcloud-idp-lookup-spp/ | n/a |
21-
| <a name="module_kraken_spp"></a> [kraken\_spp](#module\_kraken\_spp) | ./modules/meshcloud-kraken-spp/ | n/a |
22-
| <a name="module_replicator_spp"></a> [replicator\_spp](#module\_replicator\_spp) | ./modules/meshcloud-replicator-spp/ | n/a |
20+
| <a name="module_idp_lookup_service_principal"></a> [idp\_lookup\_service\_principal](#module\_idp\_lookup\_service\_principal) | ./modules/meshcloud-idp-lookup-service_principal/ | n/a |
21+
| <a name="module_kraken_service_principal"></a> [kraken\_service\_principal](#module\_kraken\_service\_principal) | ./modules/meshcloud-kraken-service_principal/ | n/a |
22+
| <a name="module_replicator_service_principal"></a> [replicator\_service\_principal](#module\_replicator\_service\_principal) | ./modules/meshcloud-replicator-service_principal/ | n/a |
2323
| <a name="module_uami_blueprint_user_principal"></a> [uami\_blueprint\_user\_principal](#module\_uami\_blueprint\_user\_principal) | ./modules/uami-blueprint-user-principal/ | n/a |
2424

2525
## Resources
@@ -33,25 +33,25 @@
3333

3434
| Name | Description | Type | Default | Required |
3535
|------|-------------|------|---------|:--------:|
36-
| <a name="input_additional_permissions"></a> [additional\_permissions](#input\_additional\_permissions) | Additional Subscription-Level Permissions the SPP needs. | `list(string)` | `[]` | no |
37-
| <a name="input_additional_required_resource_accesses"></a> [additional\_required\_resource\_accesses](#input\_additional\_required\_resource\_accesses) | Additional AAD-Level Resource Accesses the replicator SPP needs. | `list(object({ resource_app_id = string, resource_accesses = list(object({ id = string, type = string })) }))` | `[]` | no |
38-
| <a name="input_idplookup_enabled"></a> [idplookup\_enabled](#input\_idplookup\_enabled) | Whether to create idplookup SPP or not. | `bool` | `true` | no |
39-
| <a name="input_kraken_enabled"></a> [kraken\_enabled](#input\_kraken\_enabled) | Whether to create kraken SPP or not. | `bool` | `true` | no |
36+
| <a name="input_additional_permissions"></a> [additional\_permissions](#input\_additional\_permissions) | Additional Subscription-Level Permissions the Service Principal needs. | `list(string)` | `[]` | no |
37+
| <a name="input_additional_required_resource_accesses"></a> [additional\_required\_resource\_accesses](#input\_additional\_required\_resource\_accesses) | Additional AAD-Level Resource Accesses the replicator Service Principal needs. | `list(object({ resource_app_id = string, resource_accesses = list(object({ id = string, type = string })) }))` | `[]` | no |
38+
| <a name="input_idplookup_enabled"></a> [idplookup\_enabled](#input\_idplookup\_enabled) | Whether to create idplookup Service Principal or not. | `bool` | `true` | no |
39+
| <a name="input_kraken_enabled"></a> [kraken\_enabled](#input\_kraken\_enabled) | Whether to create kraken Service Principal or not. | `bool` | `true` | no |
4040
| <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 |
41-
| <a name="input_replicator_enabled"></a> [replicator\_enabled](#input\_replicator\_enabled) | Whether to create replicator SPP or not. | `bool` | `true` | no |
42-
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. Make sure this is unique. | `string` | n/a | yes |
41+
| <a name="input_replicator_enabled"></a> [replicator\_enabled](#input\_replicator\_enabled) | Whether to create replicator Service Principal or not. | `bool` | `true` | no |
42+
| <a name="input_service_principal_name_suffix"></a> [service\_principal\_name\_suffix](#input\_service\_principal\_name\_suffix) | Service principal name suffix. Make sure this is unique. | `string` | n/a | yes |
4343
| <a name="input_subscriptions"></a> [subscriptions](#input\_subscriptions) | The scope to which UAMI blueprint service principal role assignment is applied. | `list(any)` | `[]` | no |
4444

4545
## Outputs
4646

4747
| Name | Description |
4848
|------|-------------|
4949
| <a name="output_azure_ad_tenant_id"></a> [azure\_ad\_tenant\_id](#output\_azure\_ad\_tenant\_id) | The Azure AD tenant id. |
50-
| <a name="output_idp_lookup_spp"></a> [idp\_lookup\_spp](#output\_idp\_lookup\_spp) | IDP Lookup Service Principal. |
51-
| <a name="output_idp_lookup_spp_password"></a> [idp\_lookup\_spp\_password](#output\_idp\_lookup\_spp\_password) | Password for IDP Lookup Service Principal. |
52-
| <a name="output_kraken_spp"></a> [kraken\_spp](#output\_kraken\_spp) | Kraken Service Principal. |
53-
| <a name="output_kraken_spp_password"></a> [kraken\_spp\_password](#output\_kraken\_spp\_password) | Password for Kraken Service Principal. |
54-
| <a name="output_replicator_spp"></a> [replicator\_spp](#output\_replicator\_spp) | Replicator Service Principal. |
55-
| <a name="output_replicator_spp_password"></a> [replicator\_spp\_password](#output\_replicator\_spp\_password) | Password for Replicator Service Principal. |
50+
| <a name="output_idp_lookup_service_principal"></a> [idp\_lookup\_service\_principal](#output\_idp\_lookup\_service\_principal) | IDP Lookup Service Principal. |
51+
| <a name="output_idp_lookup_service_principal_password"></a> [idp\_lookup\_service\_principal\_password](#output\_idp\_lookup\_service\_principal\_password) | Password for IDP Lookup Service Principal. |
52+
| <a name="output_kraken_service_principal"></a> [kraken\_service\_principal](#output\_kraken\_service\_principal) | Kraken Service Principal. |
53+
| <a name="output_kraken_service_principal_password"></a> [kraken\_service\_principal\_password](#output\_kraken\_service\_principal\_password) | Password for Kraken Service Principal. |
54+
| <a name="output_replicator_service_principal"></a> [replicator\_service\_principal](#output\_replicator\_service\_principal) | Replicator Service Principal. |
55+
| <a name="output_replicator_service_principal_password"></a> [replicator\_service\_principal\_password](#output\_replicator\_service\_principal\_password) | Password for Replicator Service Principal. |
5656
| <a name="output_uami_blueprint_user_principal"></a> [uami\_blueprint\_user\_principal](#output\_uami\_blueprint\_user\_principal) | UAMI Blueprint Assignment Service Principal. |
5757
| <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. |

‎examples/azure-integration-with-additional-resource-access/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ terraform {
1111
module "meshplatform" {
1212
source = "git::https://github.com/meshcloud/terraform-azure-meshplatform.git"
1313

14-
spp_name_suffix = "<UNIQUE_NAME>"
15-
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
14+
service_principal_name_suffix = "<UNIQUE_NAME>"
15+
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
1616

1717
additional_required_resource_accesses = [
1818
# The block below configures replicator access

‎examples/azure-integration-with-additional-resource-access/outputs.tf

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11

2-
output "replicator_spp" {
2+
output "replicator_service_principal" {
33
description = "Replicator Service Principal."
4-
value = module.meshplatform.replicator_spp
4+
value = module.meshplatform.replicator_service_principal
55
}
66

7-
output "replicator_spp_password" {
7+
output "replicator_service_principal_password" {
88
description = "Password for Replicator Service Principal."
9-
value = module.meshplatform.replicator_spp_password
9+
value = module.meshplatform.replicator_service_principal_password
1010
sensitive = true
1111
}
1212

13-
output "kraken_spp" {
13+
output "kraken_service_principal" {
1414
description = "Kraken Service Principal."
15-
value = module.meshplatform.kraken_spp
15+
value = module.meshplatform.kraken_service_principal
1616
}
1717

18-
output "kraken_spp_password" {
18+
output "kraken_service_principal_password" {
1919
description = "Password for Kraken Service Principal."
20-
value = module.meshplatform.kraken_spp_password
20+
value = module.meshplatform.kraken_service_principal_password
2121
sensitive = true
2222
}
2323

‎examples/azure-integration-with-uami-blueprint-user-principal/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ terraform {
1111
module "meshplatform" {
1212
source = "git::https://github.com/meshcloud/terraform-azure-meshplatform.git"
1313

14-
spp_name_suffix = "<UNIQUE_NAME>"
15-
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
14+
service_principal_name_suffix = "<UNIQUE_NAME>"
15+
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
1616

1717
subscriptions = ["<SUBSCRIPTION_ID>"]
1818
}

‎examples/azure-integration-with-uami-blueprint-user-principal/outputs.tf

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
output "replicator_spp" {
1+
output "replicator_service_principal" {
22
description = "Replicator Service Principal."
3-
value = module.meshplatform.replicator_spp
3+
value = module.meshplatform.replicator_service_principal
44
}
55

6-
output "replicator_spp_password" {
6+
output "replicator_service_principal_password" {
77
description = "Password for Replicator Service Principal."
8-
value = module.meshplatform.replicator_spp_password
8+
value = module.meshplatform.replicator_service_principal_password
99
sensitive = true
1010
}
1111

12-
output "kraken_spp" {
12+
output "kraken_service_principal" {
1313
description = "Kraken Service Principal."
14-
value = module.meshplatform.kraken_spp
14+
value = module.meshplatform.kraken_service_principal
1515
}
1616

17-
output "kraken_spp_password" {
17+
output "kraken_service_principal_password" {
1818
description = "Password for Kraken Service Principal."
19-
value = module.meshplatform.kraken_spp_password
19+
value = module.meshplatform.kraken_service_principal_password
2020
sensitive = true
2121
}
2222

‎examples/basic-azure-integration/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ terraform {
1414
module "meshplatform" {
1515
source = "git::https://github.com/meshcloud/terraform-azure-meshplatform.git"
1616

17-
spp_name_suffix = "<UNIQUE_NAME>"
18-
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
17+
service_principal_name_suffix = "<UNIQUE_NAME>"
18+
mgmt_group_name = "<MANAGEMENT_GROUP_NAME>|<MANAGEMENT_GROUP_UUID>"
1919

2020
}

‎examples/basic-azure-integration/outputs.tf

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
output "replicator_spp" {
1+
output "replicator_service_principal" {
22
description = "Replicator Service Principal."
3-
value = module.meshplatform.replicator_spp
3+
value = module.meshplatform.replicator_service_principal
44
}
55

6-
output "replicator_spp_password" {
6+
output "replicator_service_principal_password" {
77
description = "Password for Replicator Service Principal."
8-
value = module.meshplatform.replicator_spp_password
8+
value = module.meshplatform.replicator_service_principal_password
99
sensitive = true
1010
}
1111

12-
output "kraken_spp" {
12+
output "kraken_service_principal" {
1313
description = "Kraken Service Principal."
14-
value = module.meshplatform.kraken_spp
14+
value = module.meshplatform.kraken_service_principal
1515
}
1616

17-
output "kraken_spp_password" {
17+
output "kraken_service_principal_password" {
1818
description = "Password for Kraken Service Principal."
19-
value = module.meshplatform.kraken_spp_password
19+
value = module.meshplatform.kraken_service_principal_password
2020
sensitive = true
2121
}
2222

23-
output "idp_lookup_spp" {
23+
output "idp_lookup_service_principal" {
2424
description = "IDP Lookup Service Principal."
25-
value = module.meshplatform.idp_lookup_spp
25+
value = module.meshplatform.idp_lookup_service_principal
2626
}
2727

28-
output "idp_lookup_spp_password" {
28+
output "idp_lookup_service_principal_password" {
2929
description = "Password for IDP Lookup Service Principal."
30-
value = module.meshplatform.idp_lookup_spp_password
30+
value = module.meshplatform.idp_lookup_service_principal_password
3131
}
3232

3333
output "uami_blueprint_user_principal" {

‎main.tf

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,39 +20,39 @@ data "azurerm_management_group" "root" {
2020
name = var.mgmt_group_name
2121
}
2222

23-
module "replicator_spp" {
23+
module "replicator_service_principal" {
2424
count = var.replicator_enabled ? 1 : 0
25-
source = "./modules/meshcloud-replicator-spp/"
25+
source = "./modules/meshcloud-replicator-service-principal/"
2626

27-
spp_name_suffix = var.spp_name_suffix
28-
scope = data.azurerm_management_group.root.id
27+
service_principal_name_suffix = var.service_principal_name_suffix
28+
scope = data.azurerm_management_group.root.id
2929

3030
additional_required_resource_accesses = var.additional_required_resource_accesses
3131
additional_permissions = var.additional_permissions
3232
}
3333

34-
module "kraken_spp" {
34+
module "kraken_service_principal" {
3535
count = var.kraken_enabled ? 1 : 0
36-
source = "./modules/meshcloud-kraken-spp/"
36+
source = "./modules/meshcloud-kraken-service-principal/"
3737

38-
spp_name_suffix = var.spp_name_suffix
39-
scope = data.azurerm_management_group.root.id
38+
service_principal_name_suffix = var.service_principal_name_suffix
39+
scope = data.azurerm_management_group.root.id
4040
}
4141

42-
module "idp_lookup_spp" {
42+
module "idp_lookup_service_principal" {
4343
count = var.idplookup_enabled ? 1 : 0
44-
source = "./modules/meshcloud-idp-lookup-spp/"
44+
source = "./modules/meshcloud-idp-lookup-service-principal/"
4545

46-
spp_name_suffix = var.spp_name_suffix
47-
scope = data.azurerm_management_group.root.id
46+
service_principal_name_suffix = var.service_principal_name_suffix
47+
scope = data.azurerm_management_group.root.id
4848
}
4949

5050
module "uami_blueprint_user_principal" {
5151
count = length(var.subscriptions)
5252
source = "./modules/uami-blueprint-user-principal/"
5353

54-
spp_name_suffix = var.spp_name_suffix
55-
subscriptions = var.subscriptions
54+
service_principal_name_suffix = var.service_principal_name_suffix
55+
subscriptions = var.subscriptions
5656
}
5757

5858
data "azuread_client_config" "current" {}

‎modules/meshcloud-idp-lookup-spp/README.md renamed to ‎modules/meshcloud-idp-lookup-service-principal/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,15 @@ No modules.
2424
| [azuread_application.meshcloud_idp_lookup](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/resources/application) | resource |
2525
| [azuread_service_principal.meshcloud_idp_lookup](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/resources/service_principal) | resource |
2626
| [azuread_service_principal.msgraph](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/resources/service_principal) | resource |
27-
| [azuread_service_principal_password.spp_pw](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/resources/service_principal_password) | resource |
27+
| [azuread_service_principal_password.service_principal_pw](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/resources/service_principal_password) | resource |
2828
| [azuread_application_published_app_ids.well_known](https://registry.terraform.io/providers/hashicorp/azuread/2.18.0/docs/data-sources/application_published_app_ids) | data source |
2929

3030
## Inputs
3131

3232
| Name | Description | Type | Default | Required |
3333
|------|-------------|------|---------|:--------:|
34-
| <a name="input_spp_name_suffix"></a> [spp\_name\_suffix](#input\_spp\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
34+
| <a name="input_scope"></a> [scope](#input\_scope) | The scope to which Service Principal permissions should be assigned to. Usually this is a management group that sits atop the subscriptions. | `string` | n/a | yes |
35+
| <a name="input_service_principal_name_suffix"></a> [service\_principal\_name\_suffix](#input\_service\_principal\_name\_suffix) | Service principal name suffix. | `string` | n/a | yes |
3536

3637
## Outputs
3738

‎modules/meshcloud-idp-lookup-spp/module.tf renamed to ‎modules/meshcloud-idp-lookup-service-principal/module.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ resource "azuread_service_principal" "msgraph" {
2020
}
2121

2222
resource "azuread_application" "meshcloud_idp_lookup" {
23-
display_name = "idplookup.${var.spp_name_suffix}"
23+
display_name = "idplookup.${var.service_principal_name_suffix}"
2424

2525
web {
2626
implicit_grant {
@@ -60,7 +60,7 @@ resource "azuread_app_role_assignment" "meshcloud_idp_lookup" {
6060
resource_object_id = azuread_service_principal.msgraph.object_id
6161
}
6262

63-
resource "azuread_service_principal_password" "spp_pw" {
63+
resource "azuread_service_principal_password" "service_principal_pw" {
6464
service_principal_id = azuread_service_principal.meshcloud_idp_lookup.id
6565
end_date = "2999-01-01T01:02:03Z" # no expiry
6666
}

0 commit comments

Comments
 (0)