Merge pull request #100 from meshcloud/feature/platform-integration-page

Author: Jelledb

.pre-commit-config.yaml

@@ -5,6 +5,7 @@ repos:
       - id: terraform_docs
         args:
             - --args=--config=.terraform-docs.yml
+        files: ^modules/[^/]+/[^/]+/.+\.tf$ # Only run on .tf files in modules/*/*/ directories
       - id: terraform_fmt
       - id: terragrunt_fmt
   - repo: https://github.com/pre-commit/pre-commit-hooks

.terraform-docs.yml

@@ -4,7 +4,6 @@ version: ""
 
 recursive:
   enabled: false
-  path: kit
 
 content: ""
 

README.md

@@ -21,6 +21,10 @@ AWS S3 Module – Provision S3 buckets with encryption and logging.
 All Terraform modules are listed in the `modules/` directory.
 This directory is split into subdirectories for each platform.
 In a platform's directory, you will find all modules that are available for that platform.
+Additionally, you might also find a `meshstack_integration.tf` and `README.md` file in a platform
+directory. These allow you to integrate a given platform directly with meshStack.
+
+```
 
 A single module is structured as follows:
 

index.ts

@@ -3,6 +3,9 @@ const path = require("path");
 const matter = require("gray-matter");
 const { execSync } = require("child_process");
 
+const repoRoot = path.resolve(__dirname, "modules");
+const assetsDir = path.resolve(__dirname, "website/public/assets/logos");
+
 function getGitHubRemoteUrl() {
   try {
     const remoteUrl = execSync("git config --get remote.origin.url")
@@ -38,44 +41,76 @@ function findReadmes(dir){
   });
 }
 
-function copyFilesToAssets(
-  sourceDir,
-  destinationDir,
-  fileFilter
-){
-  const copiedFiles = {};
+function findPlatforms(): Platform[] {
+  fs.mkdirSync(assetsDir, { recursive: true });
 
-  fs.readdirSync(sourceDir, { withFileTypes: true })
+  return fs.readdirSync(repoRoot, { withFileTypes: true })
     .filter((dirent) => dirent.isDirectory() && dirent.name !== ".github")
-    .forEach((dir) => {
-      const platformDir = path.join(sourceDir, dir.name);
-      fs.readdirSync(platformDir)
-        .filter(fileFilter)
-        .forEach((file) => {
-          const sourcePath = path.join(platformDir, file);
-          const destinationPath = path.join(
-            destinationDir,
-            `${dir.name}${path.extname(file)}`
-          );
-
-          fs.mkdirSync(destinationDir, { recursive: true });
-          fs.copyFileSync(sourcePath, destinationPath);
-
-          copiedFiles[dir.name] = destinationPath
-            .replace(path.resolve(__dirname, "website/public"), "")
-            .replace(/^\/+/g, "");
-        });
+    .map((dir) => {
+      const platformDir: string = path.join(repoRoot, dir.name);
+      const platformLogo = getPlatformLogoOrThrow(platformDir, dir.name);
+      const platformReadme = getPlatformReadmeOrThrow(platformDir);
+      const { name, description, content } = extractReadmeFrontMatter(platformReadme);
+      const terraformSnippet = getTerraformSnippet(platformDir);
+
+      return {
+        platformType: dir.name,
+        name,
+        description,
+        logo: platformLogo,
+        readme: content,
+        terraformSnippet
+      };
     });
+}
 
-  return copiedFiles;
+// Finds the logo, copies it to website assets and returns the path.
+function getPlatformLogoOrThrow(platformDir: string, platformType: string): string {
+  const logoFile = fs.readdirSync(platformDir).find(f => f.endsWith('.png') || f.endsWith('.svg'));
+  if (logoFile) {
+    const sourcePath = path.join(platformDir, logoFile);
+    const destPath = path.join(assetsDir, `${platformType}${path.extname(logoFile)}`);
+    fs.copyFileSync(sourcePath, destPath);
+    return destPath.replace(path.resolve(__dirname, "website/public"), "").replace(/^\/+/g, "");
+  }
+
+  throw new Error(`Logo file not found for platform: ${platformType} in directory: ${platformDir}. Each platform should have a logo.`);
 }
 
-function copyPlatformLogosToAssets() {
-  const modulesDir = path.resolve(__dirname, "modules");
-  const assetsDir = path.resolve(__dirname, "website/public/assets/logos");
-  return copyFilesToAssets(modulesDir, assetsDir, (file) =>
-    file.endsWith(".png") || file.endsWith(".svg")
-  );
+function getPlatformReadmeOrThrow(platformDir: string) {
+  try {
+    return fs.readFileSync(path.join(platformDir, "README.md"), "utf-8");
+  } catch {
+    throw new Error('Platform README.md not found. Each platform should have a README.md file.');
+  }
+}
+
+function extractReadmeFrontMatter(platformReadme: string): { name: string; description: string; content: string } {
+  const { data, content } = matter(platformReadme);
+
+  const name = data.name;
+  if (!name) {
+    throw new Error('Property "name" is missing in the front matter of the platform README.md. Each platform README.md should have a name defined in the front matter.');
+  }
+
+  const description = data.description;
+  if (!description) {
+    throw new Error('Property "description" is missing in the front matter of the platform README.md. Each platform README.md should have a description defined in the front matter.');
+  }
+
+  return {
+    name,
+    description,
+    content
+  }
+}
+
+function getTerraformSnippet(platformDir: string): string | null {
+  try {
+    return fs.readFileSync(path.join(platformDir, "meshstack_integration.tf"), "utf-8")
+  } catch {
+    return null;
+  }
 }
 
 function copyBuildingBlockLogoToAssets(buildingBlockDir) {
@@ -161,15 +196,13 @@ function getIdAndPlatform(filePath) {
 
 // Main execution
 function main() {
-  const repoRoot = path.resolve(__dirname, "modules");
-
-  const platformLogos = copyPlatformLogosToAssets();
+  const platforms = findPlatforms();
   fs.writeFileSync(
-    "website/public/assets/platform-logos.json",
-    JSON.stringify(platformLogos, null, 2)
+    "website/public/assets/platform.json",
+    JSON.stringify(platforms, null, 2)
   );
   console.log(
-    `✅ Successfully processed ${Object.entries(platformLogos).length} platform logos. Output saved to platform-logos.json`
+    `✅ Successfully processed ${platforms.length} platforms. Output saved to platform.json`
   );
 
   const readmeFiles = findReadmes(repoRoot);
@@ -184,3 +217,12 @@ function main() {
 }
 
 main();
+
+export interface Platform {
+  platformType: string;
+  name: string;
+  description: string;
+  logo: string;
+  readme: string;
+  terraformSnippet?: string;
+}

modules/aks/README.md

@@ -0,0 +1,7 @@
+---
+name: Azure Kubernetes Service
+description: Managed Kubernetes service on Azure
+category: hyperscaler
+---
+
+A meshStack integration of AKS allows you to automatically provision and manage Kubernetes namespaces for meshStack projects, enforce policies and enable secure authentication for your AKS workloads, and track usage to enable billing across namespaces.

modules/aws/README.md

@@ -0,0 +1,7 @@
+---
+name: Amazon Web Services
+description: Scalable cloud computing platform by Amazon
+category: hyperscaler
+---
+
+meshStack integration with AWS enables automated account provisioning, policy enforcement, and unified billing for AWS resources across your organization.

modules/azure/README.md

@@ -0,0 +1,7 @@
+---
+name: Microsoft Azure
+description: Cloud computing platform and services by Microsoft
+category: hyperscaler
+---
+
+meshStack integration with Azure streamlines subscription management, enforces governance, and enables cost tracking for Azure resources in your organization.

modules/azuredevops/README.md

@@ -0,0 +1,7 @@
+---
+name: Azure DevOps
+description: Developer services for support teams to plan, build, and ship software
+category: devops
+---
+
+meshStack integration with Azure DevOps automates project and repository setup, ensuring consistent governance and access management for your development workflows.

modules/cloudfoundry/README.md

@@ -0,0 +1,7 @@
+---
+name: Cloud Foundry
+description: Open source cloud application platform
+category: private-cloud
+---
+
+meshStack integration with Cloud Foundry automates org and space provisioning, policy enforcement, and enables usage-based billing for your cloud-native applications.

modules/datadog/README.md

@@ -0,0 +1,7 @@
+---
+name: Datadog
+description: Monitoring and security platform for cloud applications
+category: devops
+---
+
+meshStack integration with Datadog enables automated account management and unified monitoring setup for your cloud environments.