wata727/tflint

TFLint Docker镜像文档

镜像概述

注意：此镜像已弃用。请使用新的官方镜像：https://github.com/terraform-linters/tflint/pkgs/container/tflint

TFLint是一款针对Terraform的代码检查工具（linter），旨在识别terraform plan命令无法检测到的潜在错误、最佳实践问题和不一致性，帮助提升Terraform代码质量和可靠性。

核心功能与特性

• 错误检测：识别Terraform配置中的语法错误、无效引用和不兼容的资源参数
• 最佳实践检查：验证是否遵循Terraform推荐的配置规范和最佳实践
• 自定义规则支持：允许通过插件扩展检查规则，适应特定项目需求
• 快速反馈：在代码提交前提供即时检查结果，减少部署后的问题

使用场景与适用范围

• Terraform项目开发过程中的代码质量控制
• CI/CD流水线集成，作为代码提交或部署前的自动化检查步骤
• 团队协作中统一代码规范和配置标准
• 大规模Terraform基础设施维护，降低配置错误风险

使用方法与配置说明

获取官方镜像

由于原镜像已弃用，建议从新的官方仓库拉取最新镜像：

bash
docker pull ghcr.io/terraform-linters/tflint:latest

基本使用示例

在Terraform项目目录中运行TFLint检查：

bash
docker run --rm -v $(pwd):/app -w /app ghcr.io/terraform-linters/tflint:latest

配置参数

TFLint支持通过配置文件（.tflint.hcl）自定义检查规则。常见配置选项包括：

• plugin：配置第三方检查插件
• rule：启用/禁用特定检查规则
• var-file：指定变量文件路径

示例配置文件（.tflint.hcl）：

hcl
config {
  module = true
  force = false
}

plugin "aws" {
  enabled = true
  version = "0.21.0"
  source  = "github.com/terraform-linters/tflint-ruleset-aws"
}

CI/CD集成示例（GitHub Actions）

在GitHub Actions工作流中集成TFLint检查：

yaml
name: TFLint
on: [pull_request]

jobs:
  tflint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up TFLint
        uses: terraform-linters/setup-tflint@v4
      - name: Run TFLint
        run: tflint