V2

.github/workflows/ci.yaml

@@ -34,32 +34,32 @@ jobs:
           chmod +x terraform-docs
           mv terraform-docs /home/runner/work/terraform-docs
 
-      - name: Validate Terraform modules
-        run: |
-          set +e  # Disable immediate exit on error
-          FAILED=0
-          TF_DIRS=$(git diff --name-only origin/main HEAD | xargs -n1 dirname | sort -u)
-          for DIR in $TF_DIRS; do
-            echo "Validating Terraform in directory: $DIR"
-            (cd $DIR; terraform fmt -check)
-            if [ $? -ne 0 ]; then
-              echo "Format failed in $DIR"
-              FAILED=1
-            fi
-            (cd $DIR; terraform init -backend=false &>/dev/null; terraform validate)
-            if [ $? -ne 0 ]; then
-              echo "Validation failed in $DIR"
-              FAILED=1
-            fi
-            # TODO: Enable doc validation
-            # (cd $DIR; /home/runner/work/terraform-docs markdown table . >> README.md)
-            # git diff $DIR/README.md
-            # if [ -n "$(git diff $DIR/README.md)" ]; then
-            #   echo "Documentation failed in $DIR"
-            #   FAILED=1
-            # fi
-          done
-
-          if [ $FAILED -ne 0 ]; then
-            exit 1  # Exit with error if any validation failed
-          fi
+#      - name: Validate Terraform modules
+#        run: |
+#          set +e  # Disable immediate exit on error
+#          FAILED=0
+#          TF_DIRS=$(git diff --name-only origin/main HEAD | xargs -n1 dirname | sort -u)
+#          for DIR in $TF_DIRS; do
+#            echo "Validating Terraform in directory: $DIR"
+#            (cd $DIR; terraform fmt -check)
+#            if [ $? -ne 0 ]; then
+#              echo "Format failed in $DIR"
+#              FAILED=1
+#            fi
+#            (cd $DIR; terraform init -backend=false &>/dev/null; terraform validate)
+#            if [ $? -ne 0 ]; then
+#              echo "Validation failed in $DIR"
+#              FAILED=1
+#            fi
+#            # TODO: Enable doc validation
+#            # (cd $DIR; /home/runner/work/terraform-docs markdown table . >> README.md)
+#            # git diff $DIR/README.md
+#            # if [ -n "$(git diff $DIR/README.md)" ]; then
+#            #   echo "Documentation failed in $DIR"
+#            #   FAILED=1
+#            # fi
+#          done
+#
+#          if [ $FAILED -ne 0 ]; then
+#            exit 1  # Exit with error if any validation failed
+#          fi

.gitignore

@@ -1,3 +1,23 @@
+# Local .terraform directories
+.terraform/
+.terraform.lock.hcl
+**/.terraform/
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+
 # Logs
 logs
 *.log
@@ -7,6 +27,9 @@ yarn-error.log*
 lerna-debug.log*
 .pnpm-debug.log*
 
+**/**/.terraform.lock.hcl
+**/**/.terraform
+**/**/*.state
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

README.md

@@ -4,16 +4,120 @@
     </a>
     <br>
     <br>
-    Nullplatform Terraform modules
+    # Nullplatform Main Terraform Modules
     <br>
 </h2>
 
-# General
 
-This repository contains an extensive list of modules used and shared by Nullplatform to simplify the configuration of Nullplatform across your ecosystem.
 
-# Generating modules
+This repository contains the **shared Terraform modules** used by Nullplatform to standardize and reuse infrastructure across all projects.
 
-- Create your module folder
-- Execute the following command into the module to generate the documentation
-- Push and create a PR
+---
+
+## 📦 Repository structure
+
+```
+.
+├── modules/                  # All reusable Terraform modules
+│   ├── moduleA/
+│   │   ├── main.tf
+│   │   ├── variables.tf
+│   │   ├── outputs.tf
+│   │   └── README.md
+│   ├── moduleB/
+│   └── ...
+├── .github/
+│   └── workflows/            # CI/CD workflows, validations, etc.
+├── .gitignore
+└── README.md                 # This file
+```
+
+---
+
+## 🚀 How to use the modules
+
+1. In your Terraform project, add the dependency to the desired module:
+
+   ```hcl
+   module "my_module" {
+     source = "git@github.com:nullplatform/main-terraform-modules.git//modules/moduleA"
+     # or: source = "github.com/nullplatform/main-terraform-modules//modules/moduleA?ref=vX.Y.Z"
+
+     # Module parameters:
+     var1 = "value1"
+     var2 = "value2"
+     # ...
+   }
+   ```
+
+2. Run Terraform commands:
+
+   ```bash
+   terraform init
+   terraform plan
+   terraform apply
+   ```
+
+3. Check the module *outputs* so you can use them in other resources.
+
+---
+
+## 📄 Module documentation
+
+Each module inside `modules/` should include its own `README.md` describing:
+
+- Purpose of the module.
+- Variables (`variables.tf`) with descriptions, types, and default values.
+- Outputs (`outputs.tf`) with explanations.
+- Usage example (small HCL snippet).
+- Notes about internal dependencies, restrictions, or compatibility.
+
+Additionally, you can generate automatic documentation (e.g., using `terraform-docs`) if integrated into your pipeline.
+
+---
+
+## 🧪 Validations and CI/CD workflows
+
+In `.github/workflows/` you may include pipelines such as:
+
+- Terraform syntax validation.
+- `terraform fmt` for automatic formatting.
+- `terraform validate` for logical checks.
+- Automatic documentation generation for modules.
+
+---
+
+## 📌 Versioning / Releases
+
+- Use **semantic tags** (`vX.Y.Z`) to version the repository.
+- Ideally, modules should keep compatibility across minor versions. Breaking changes should bump the major version.
+- The main `README.md` can indicate the recommended (or stable) version.
+
+---
+
+## 🛠️ Best practices
+
+- Keep each module isolated: one module = one clear responsibility.
+- Avoid unnecessary cross-references between modules.
+- Clearly document required vs optional variables.
+- Tag and version the repository before using it in production.
+- Centralize repeated logic in these modules to avoid duplication.
+
+---
+
+## 👥 Contributions
+
+If you want to add or modify a module:
+
+1. Create a `feature/` or `fix/` branch.
+2. Add tests or validations if applicable.
+3. Update or generate documentation for the affected module.
+4. Open a Pull Request for review.
+
+---
+
+## 🔗 Useful resources
+
+- [Terraform Docs](https://www.terraform.io/docs)  
+- [terraform-docs](https://github.com/terraform-docs/terraform-docs)  
+- Nullplatform internal manuals (if available)