Skill: Refactor Module

技能：重构模块

Overview

概述

This skill guides AI agents in transforming monolithic Terraform configurations into reusable, maintainable modules following HashiCorp's module design principles and community best practices.

本技能指导AI Agent遵循HashiCorp的模块设计原则和社区最佳实践，将单体Terraform配置转换为可复用、可维护的模块。

Capability Statement

能力说明

The agent will analyze existing Terraform code and systematically refactor it into well-structured modules with:

Clear interface contracts (variables and outputs)
Proper encapsulation and abstraction
Versioning and documentation
Testing frameworks
Migration path for existing state

Agent将分析现有Terraform代码，并系统地将其重构为结构良好的模块，具备以下特性：

清晰的接口契约（变量和输出）
适当的封装与抽象
版本控制与文档
测试框架
现有状态的迁移路径

Prerequisites

前提条件

Existing Terraform configuration to refactor
Understanding of resource dependencies
Access to current state file (for migration planning)
Knowledge of module registry patterns

待重构的现有Terraform配置
了解资源依赖关系
可访问当前状态文件（用于迁移规划）
了解模块注册表模式

Input Parameters

输入参数

Parameter	Type	Required	Description
`source_directory`	string	Yes	Path to existing Terraform configuration
`module_name`	string	Yes	Name for the new module
`abstraction_level`	string	No	"simple", "intermediate", "advanced" (default: intermediate)
`preserve_state`	boolean	Yes	Whether to maintain state compatibility
`target_registry`	string	No	Target module registry (local, private, public)

参数	类型	是否必填	描述
`source_directory`	string	是	现有Terraform配置的路径
`module_name`	string	是	新模块的名称
`abstraction_level`	string	否	"simple"、"intermediate"、"advanced"（默认值：intermediate）
`preserve_state`	boolean	是	是否保持状态兼容性
`target_registry`	string	否	目标模块注册表（本地、私有、公共）

Execution Steps

执行步骤

1. Analysis Phase

1. 分析阶段

markdown

**Identify Refactoring Candidates**
- Group resources by logical function
- Identify repeated patterns
- Map resource dependencies
- Detect configuration coupling
- Analyze variable usage patterns

**Complexity Assessment**
- Count resource relationships
- Measure variable propagation depth
- Identify cross-resource references
- Evaluate state migration complexity

markdown

**识别重构候选对象**
- 按逻辑功能对资源进行分组
- 识别重复模式
- 映射资源依赖关系
- 检测配置耦合
- 分析变量使用模式

**复杂度评估**
- 统计资源关系数量
- 衡量变量传播深度
- 识别跨资源引用
- 评估状态迁移复杂度

2. Module Design

2. 模块设计

Interface Design

接口设计

hcl

undefined

hcl

undefined

Define clear input contract

variable "network_config" { description = "Network configuration parameters" type = object({ cidr_block = string availability_zones = list(string) enable_nat = bool })

validation { condition = can(cidrhost(var.network_config.cidr_block, 0)) error_message = "CIDR block must be valid IPv4 CIDR." } }

variable "network_config" { description = "Network configuration parameters" type = object({ cidr_block = string availability_zones = list(string) enable_nat = bool })

validation { condition = can(cidrhost(var.network_config.cidr_block, 0)) error_message = "CIDR block must be valid IPv4 CIDR." } }

Define output contract

output "vpc_id" { description = "ID of the created VPC" value = aws_vpc.main.id }

output "private_subnet_ids" { description = "List of private subnet IDs" value = { for k, v in aws_subnet.private : k => v.id } }

undefined

output "vpc_id" { description = "ID of the created VPC" value = aws_vpc.main.id }

output "private_subnet_ids" { description = "List of private subnet IDs" value = { for k, v in aws_subnet.private : k => v.id } }

undefined

Encapsulation Strategy

封装策略

markdown

**What to Include in Module:**
- Tightly coupled resources (VPC + subnets)
- Resources with shared lifecycle
- Configuration with clear boundaries

**What to Keep Separate:**
- Cross-cutting concerns (monitoring, tagging)
- Resources with different lifecycles
- Provider-specific configurations

markdown

**模块应包含的内容：**
- 紧密耦合的资源（VPC + 子网）
- 具有共享生命周期的资源
- 边界清晰的配置

**应单独保留的内容：**
- 横切关注点（监控、标签）
- 生命周期不同的资源
- 特定于提供商的配置

3. Code Transformation

3. 代码转换

Before: Monolithic Configuration

转换前：单体配置

hcl

undefined

hcl

undefined

main.tf (monolithic)

resource "aws_vpc" "main" { cidr_block = "10.0.0.0/16" enable_dns_hostnames = true

tags = { Name = "production-vpc" Environment = "prod" } }

resource "aws_subnet" "public_1" { vpc_id = aws_vpc.main.id cidr_block = "10.0.1.0/24" availability_zone = "us-east-1a"

tags = { Name = "public-subnet-1" Type = "public" } }

resource "aws_subnet" "public_2" { vpc_id = aws_vpc.main.id cidr_block = "10.0.2.0/24" availability_zone = "us-east-1b"

tags = { Name = "public-subnet-2" Type = "public" } }

resource "aws_internet_gateway" "main" { vpc_id = aws_vpc.main.id

tags = { Name = "production-igw" } }

resource "aws_vpc" "main" { cidr_block = "10.0.0.0/16" enable_dns_hostnames = true

tags = { Name = "production-vpc" Environment = "prod" } }

resource "aws_subnet" "public_1" { vpc_id = aws_vpc.main.id cidr_block = "10.0.1.0/24" availability_zone = "us-east-1a"

tags = { Name = "public-subnet-1" Type = "public" } }

resource "aws_subnet" "public_2" { vpc_id = aws_vpc.main.id cidr_block = "10.0.2.0/24" availability_zone = "us-east-1b"

tags = { Name = "public-subnet-2" Type = "public" } }

resource "aws_internet_gateway" "main" { vpc_id = aws_vpc.main.id

tags = { Name = "production-igw" } }

... more repetitive subnet and routing resources

undefined

undefined

After: Modular Structure

转换后：模块化结构

hcl

undefined

hcl

undefined

modules/vpc/main.tf

locals { subnet_count = length(var.availability_zones) }

resource "aws_vpc" "main" { cidr_block = var.cidr_block enable_dns_hostnames = var.enable_dns_hostnames enable_dns_support = var.enable_dns_support

tags = merge( var.tags, { Name = var.name } ) }

resource "aws_subnet" "public" { for_each = var.create_public_subnets ? toset(var.availability_zones) : []

vpc_id = aws_vpc.main.id cidr_block = cidrsubnet(var.cidr_block, 8, index(var.availability_zones, each.value)) availability_zone = each.value map_public_ip_on_launch = true

tags = merge( var.tags, { Name = "${var.name}-public-${each.value}" Type = "public" } ) }

resource "aws_internet_gateway" "main" { count = var.create_public_subnets ? 1 : 0 vpc_id = aws_vpc.main.id

tags = merge( var.tags, { Name = "${var.name}-igw" } ) }

locals { subnet_count = length(var.availability_zones) }

resource "aws_vpc" "main" { cidr_block = var.cidr_block enable_dns_hostnames = var.enable_dns_hostnames enable_dns_support = var.enable_dns_support

tags = merge( var.tags, { Name = var.name } ) }

resource "aws_subnet" "public" { for_each = var.create_public_subnets ? toset(var.availability_zones) : []

vpc_id = aws_vpc.main.id cidr_block = cidrsubnet(var.cidr_block, 8, index(var.availability_zones, each.value)) availability_zone = each.value map_public_ip_on_launch = true

tags = merge( var.tags, { Name = "${var.name}-public-${each.value}" Type = "public" } ) }

resource "aws_internet_gateway" "main" { count = var.create_public_subnets ? 1 : 0 vpc_id = aws_vpc.main.id

tags = merge( var.tags, { Name = "${var.name}-igw" } ) }

modules/vpc/variables.tf

variable "name" { description = "Name prefix for all resources" type = string }

variable "cidr_block" { description = "CIDR block for the VPC" type = string

validation { condition = can(cidrhost(var.cidr_block, 0)) error_message = "Must be a valid IPv4 CIDR block." } }

variable "availability_zones" { description = "List of availability zones" type = list(string) }

variable "create_public_subnets" { description = "Whether to create public subnets" type = bool default = true }

variable "enable_dns_hostnames" { description = "Enable DNS hostnames in the VPC" type = bool default = true }

variable "enable_dns_support" { description = "Enable DNS support in the VPC" type = bool default = true }

variable "tags" { description = "Tags to apply to all resources" type = map(string) default = {} }