Skip to content

Commit 35ff598

Browse files
committed
feat: Altered the standard of module files
1 parent e51ce28 commit 35ff598

File tree

25 files changed

+12
-12
lines changed

25 files changed

+12
-12
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,17 @@ A single module is structured as follows:
2626

2727
```
2828
module_name/
29-
building_block/ -- This is the *actual* Terraform module that provisions resources.
29+
building_block/ -- This is the *actual* Terraform module that provisions resources for application teams.
3030
main.tf
3131
provider.tf
3232
outputs.tf
3333
variables.tf
34+
README.md -- This explains the module and how to use it from a platform engineering perspective.
35+
APP_TEAM_README.md -- This explains the module and how to use it from an application team perspective.
36+
logo.png -- This is the logo that is shown in the meshStack Hub and in the meshStack UI (if imported).
3437
backplane/ -- This is the Terraform code that provisions all supporting resources such as roles & techical users.
3538
<... Terraform files ...>
36-
README.md -- This describes the module and how to use it.
39+
README.md -- This explains the backplane module and how to use it. (optional)
3740
```
3841

3942
## 🔧 Usage

modules/aks/github-connector/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: GitHub Actions Integration with AKS
33
supportedPlatforms:
44
- aks
55
description: |
6-
Provides an automated CI/CD pipeline using GitHub Actions to deploy applications to Azure Kubernetes Service (AKS). It enables application teams to build, test, and deploy containerized applications seamlessly while following best practices for security and scalability.
6+
CI/CD pipeline using GitHub Actions for secure, scalable AKS deployment.
77
---
88

99
# GitHub Actions Integration with AKS
Binary file not shown.
Loading

modules/aks/postgresql/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: PostgreSQL Integration with AKS
33
supportedPlatforms:
44
- aks
55
description: |
6-
Provides an Azure Database for PostgreSQL instance integrated with Azure Kubernetes Service (AKS). It enables application teams to use a fully managed PostgreSQL database while ensuring seamless connectivity and security with their AKS workloads.
6+
Provides managed PostgreSQL with direct integration to AKS for secure access.
77
---
88

99
# Postgresql Integration with AKS
Binary file not shown.

modules/aws/s3_bucket/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: AWS S3 Bucket
33
supportedPlatforms:
44
- aws
55
description: |
6-
Provides an AWS S3 bucket for object storage. It enables application teams to store and retrieve data securely with configurable access controls, lifecycle policies, and encryption.
6+
Provides an AWS S3 bucket for object storage with access controls, lifecycle policies, and encryption.
77
---
88

99
# AWS S3 Bucket

modules/azure/budget-alert/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Azure Subscription Budget Alert
33
supportedPlatforms:
44
- azure
55
description: |
6-
Provides a budget alert for an Azure subscription. This module helps teams monitor cloud spending and avoid unexpected cost overruns by setting up automated budget alerts.
6+
Sets up budget alerts for an Azure subscription to monitor spending and prevent cost overruns.
77
---
88

99
# Azure Subscription Budget Alert

modules/azure/key-vault/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Azure Key Vault
33
supportedPlatforms:
44
- azure
55
description: |
6-
Provides an Azure Key Vault for secure storage and management of secrets, keys, and certificates. It helps application teams protect sensitive data, manage access control, and integrate securely with their applications.
6+
Provides an Azure Key Vault to securely store and manage secrets, keys, and certificates with access control.
77
---
88

99
# Azure Key Vault

modules/azure/key-vault/buildingblock/key-vault.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.
Loading

modules/azure/postgresql/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Azure PostgreSQL Deployment
33
supportedPlatforms:
44
- azure
55
description: |
6-
Provides an Azure Database for PostgreSQL instance, offering a fully managed, scalable, and secure relational database service. It supports enterprise-grade PostgreSQL workloads with automated maintenance, high availability, and built-in security features.
6+
Provides a managed Azure PostgreSQL database with scalability, security, and high availability.
77
---
88

99
# Azure PostgreSQL Deployment

modules/github/repository/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: GitHub Repository Creation
33
supportedPlatforms:
44
- github
55
description: |
6-
Provides an automated way to create and manage GitHub repositories for application teams. It ensures repositories are set up with predefined configurations, including access control, branch protection rules, and compliance settings.
6+
Automates GitHub repository setup with predefined configurations and access control.
77
---
88

99
# GitHub Repository Building Block

modules/github/repository/buildingblock/git-repo.svg

Lines changed: 0 additions & 2 deletions
This file was deleted.
5.57 KB
Loading

0 commit comments

Comments
 (0)