Skip to content

Commit 4ecff37

Browse files
committed
chore: more infos in README
chore: adding var for namespace
1 parent 5509539 commit 4ecff37

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,64 @@
11
# AKS meshPlatform Module
22

3-
Terraform module to integrate AKS as a meshPlatform into meshStack instance. The output of this module is a set of Service Account credentials that need to be configured in meshStack as described in [meshcloud public docs](https://docs.meshcloud.io/docs/meshstack.how-to.integrate-meshplatform.html).
3+
Terraform module to integrate AKS as a meshPlatform into a meshStack instance. The output of this module is a set of Service Account credentials that need to be configured in meshStack as described in [meshcloud public docs](https://docs.meshcloud.io/docs/meshstack.how-to.integrate-meshplatform.html).
44

55
## Prerequisites
66

77
To run this module, you need:
88

9-
- cluster admin permissions on the cluster
9+
- Cluster admin permissions on the cluster
1010
- [Terraform installed](https://learn.hashicorp.com/tutorials/terraform/install-cli)
1111
- [kubectl installed](https://kubernetes.io/docs/tasks/tools/#kubectl)
1212

1313
To integrate an AKS cluster, you additionally need:
1414

1515
- An AKS cluster with [Azure AD enabled](https://learn.microsoft.com/en-us/azure/aks/managed-aad)
16-
- Integrate [RBAC based user access](https://learn.microsoft.com/en-us/azure/aks/manage-azure-rbac) with the AKS cluster
16+
- Integrate [RBAC-based user access](https://learn.microsoft.com/en-us/azure/aks/manage-azure-rbac) with the AKS cluster
17+
18+
## Usage
19+
20+
Below is an example of how to use this module in your Terraform configuration:
21+
22+
```terraform
23+
module "aks_meshplatform" {
24+
source = "path/to/this/module"
25+
26+
namespace = "meshcloud"
27+
metering_enabled = true
28+
replicator_enabled = true
29+
scope = "your-aks-subscription-id"
30+
service_principal_name = "replicator-service-principal"
31+
create_password = true
32+
workload_identity_federation = {
33+
issuer = "https://issuer.example.com"
34+
subject = "subject-claim"
35+
}
36+
application_owners = ["[email protected]", "[email protected]"]
37+
}
38+
```
39+
40+
## Outputs
41+
After applying the configuration, you can retrieve the following outputs using `terraform output`:
42+
43+
- **Replicator Service Principal Credentials**
44+
```bash
45+
terraform output replicator_service_principal
46+
```
47+
48+
- **Replicator Service Principal Password**
49+
```bash
50+
terraform output replicator_service_principal_password
51+
```
52+
53+
- **Metering Service Account Token**
54+
```bash
55+
terraform output metering_token
56+
```
57+
58+
- **Replicator Service Account Token**
59+
```bash
60+
terraform output replicator_token
61+
```
1762

1863
<!-- BEGIN_TF_DOCS -->
1964
## Requirements

0 commit comments

Comments
 (0)