root-module-integration

Integrate new Terraform modules into the Azure CAF root framework.

7|5|Updated Jan 22, 2025
One-click install
npx skills add https://github.com/aztfmodnew/terraform-azurerm-caf --skill root-module-integration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: root-module-integration
Source: https://github.com/aztfmodnew/terraform-azurerm-caf/tree/main/.github/skills/root-module-integration
Command: npx skills add https://github.com/aztfmodnew/terraform-azurerm-caf --skill root-module-integration

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the complex process of integrating newly created Terraform modules into the Azure Cloud Adoption Framework (CAF) root module, ensuring proper wiring, dependency management, and CI/CD integration.

Core Features & Use Cases

  • Automated Integration Workflow: Guides users through an 8-step process to connect a module to the root aggregator, configure variables and locals, set up cross-module references via combined_objects, and generate examples.
  • CI/CD and Testing Setup: Automatically adds the new module integration to relevant CI/CD workflows and provides commands for mock testing and validation.
  • Use Case: After developing a new Terraform module for Azure Key Vault, use this Skill to seamlessly integrate it into the existing CAF infrastructure, making it discoverable, testable, and usable by other modules.

Quick Start

Use the root-module-integration skill to integrate the new 'key_vault' module into the root framework.

Frequently Asked Questions about root-module-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate a new Terraform module into the Azure CAF root framework?

To integrate a new Terraform module into the Azure CAF root framework, you follow an automated 8-step process that creates the root aggregator, configures variables and locals, sets up combined_objects for cross-module references, and generates module examples.

What does the combined_objects configuration do in Azure CAF Terraform deployments?

In Azure CAF Terraform deployments, the combined_objects configuration manages cross-module dependencies and references. It ensures newly integrated modules can properly discover and interact with existing infrastructure components within the root aggregator.

Can I automatically add Terraform module integration to my CI/CD pipeline?

Yes, you can automatically add Terraform module integration to your CI/CD pipeline. The integration process automatically incorporates the new module into relevant CI/CD workflows and provides commands for mock testing and validation.

What is the standard workflow for onboarding Terraform modules into a large IaC codebase?

The standard workflow for onboarding Terraform modules into a large IaC codebase involves creating a root aggregator, configuring variables and locals, setting up dependency management via combined_objects, generating examples, and integrating CI/CD pipelines to ensure discoverability and testability.

How do I validate a newly integrated Azure CAF Terraform module before deployment?

You validate a newly integrated Azure CAF Terraform module by running the provided mock testing and validation commands. The integration process automatically generates these validation steps as part of the CI/CD workflow setup to ensure proper module configuration.