Skip to content

Commit ccfece3

Browse files
committed
update READMEs
1 parent c9ed4cc commit ccfece3

File tree

10 files changed

+9
-58
lines changed

10 files changed

+9
-58
lines changed

README.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,10 @@ Tenant wide admin consent must be granted for a succesful meshPlatform setup. Th
1515

1616
## How to use this module
1717

18-
Prerequisites:
19-
20-
- [Azure CLI installed](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
21-
- [Terraform installed](https://learn.hashicorp.com/tutorials/terraform/install-cli)
22-
2318
### Using Azure Portal
2419

20+
Prerequisites: [Terraform installed](https://learn.hashicorp.com/tutorials/terraform/install-cli)
21+
2522
1. Login into [Azure Portal](https://portal.azure.com/) with your Admin user.
2623

2724
2. Open a cloud shell.
@@ -61,6 +58,11 @@ Prerequisites:
6158
```
6259
6360
### Using CLI
61+
62+
Prerequisites:
63+
64+
- [Azure CLI installed](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
65+
- [Terraform installed](https://learn.hashicorp.com/tutorials/terraform/install-cli)
6466
6567
1. Login with az CLI
6668
```sh
@@ -88,35 +90,9 @@ Prerequisites:
8890
# The JSON output contains sensitive values that must not be transmitted to meshcloud in plain text.
8991
terraform output -json
9092
```
91-
## Advanced Usage
92-
93-
The default case creates kraken, replicator and idplookup service principals.
94-
95-
```hcl
96-
module "meshplatform" {
97-
source = "git@github.com:meshcloud/terraform-azure-meshplatform.git"
98-
99-
spp_name_suffix = "UNIQUE_NAME"
100-
mgmt_group_name = "MANAGEMENT_GROUP_NAME|MANAGEMENT_GROUP_UUID"
101-
}
102-
```
103-
104-
If UAMI blueprint user principal is needed, you also need to pass a list of subscriptions this user will be assigned to.
105-
106-
```hcl
107-
module "meshplatform" {
108-
source = "git@github.com:meshcloud/terraform-azure-meshplatform.git"
109-
110-
spp_name_suffix = "UNIQUE_NAME"
111-
mgmt_group_name = "MANAGEMENT_GROUP_NAME|MANAGEMENT_GROUP_UUID"
93+
## Example Usages
11294
113-
subscriptions = [
114-
"abcdefgh-abcd-efgh-abcd-abcdefgh1234"
115-
, "abcdefgh-abcd-efgh-abcd-abcdefgh5678"
116-
, ...
117-
]
118-
}
119-
```
95+
Check [examples](./examples/) for different use cases. As a quick start we recommend using [basic-azure-integration](./examples/basic-azure-integration) example.
12096
12197
## Requirements
12298
@@ -125,7 +101,6 @@ module "meshplatform" {
125101
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
126102
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 2.18.0 |
127103
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.97.0 |
128-
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
129104
130105
## Providers
131106

main.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ terraform {
55
source = "hashicorp/azurerm"
66
version = "2.97.0"
77
}
8-
random = {
9-
source = "hashicorp/random"
10-
version = "2.2.1"
11-
}
128
azuread = {
139
source = "hashicorp/azuread"
1410
version = "2.18.0"

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
66
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 2.18.0 |
77
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.97.0 |
8-
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
98

109
## Providers
1110

modules/meshcloud-idp-lookup-spp/module.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ terraform {
55
source = "hashicorp/azurerm"
66
version = "2.97.0"
77
}
8-
random = {
9-
source = "hashicorp/random"
10-
version = "2.2.1"
11-
}
128
azuread = {
139
source = "hashicorp/azuread"
1410
version = "2.18.0"

modules/meshcloud-kraken-spp/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
66
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 2.18.0 |
77
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.97.0 |
8-
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
98

109
## Providers
1110

modules/meshcloud-kraken-spp/module.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ terraform {
55
source = "hashicorp/azurerm"
66
version = "2.97.0"
77
}
8-
random = {
9-
source = "hashicorp/random"
10-
version = "2.2.1"
11-
}
128
azuread = {
139
source = "hashicorp/azuread"
1410
version = "2.18.0"

modules/meshcloud-replicator-spp/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
66
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 2.18.0 |
77
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.97.0 |
8-
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
98

109
## Providers
1110

modules/meshcloud-replicator-spp/module.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ terraform {
66
source = "hashicorp/azurerm"
77
version = "2.97.0"
88
}
9-
random = {
10-
source = "hashicorp/random"
11-
version = "2.2.1"
12-
}
139
azuread = {
1410
source = "hashicorp/azuread"
1511
version = "2.18.0"

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
66
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | 2.18.0 |
77
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | 2.97.0 |
8-
| <a name="requirement_random"></a> [random](#requirement\_random) | 2.2.1 |
98

109
## Providers
1110

modules/uami-blueprint-user-principal/module.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ terraform {
55
source = "hashicorp/azurerm"
66
version = "2.97.0"
77
}
8-
random = {
9-
source = "hashicorp/random"
10-
version = "2.2.1"
11-
}
128
azuread = {
139
source = "hashicorp/azuread"
1410
version = "2.18.0"

0 commit comments

Comments
 (0)