Configuration

Configuration File

tfsumpy can be customized using a JSON configuration file. Create a file named config.json:

{
  "sensitive_patterns": [
    {
      "pattern": "\\b(?:password|secret|key)\\b",
      "replacement": "[REDACTED]"
    }
  ],
  "risk_rules": {
    "high": [
      {
        "pattern": "\\bdelete\\b.*\\b(database|storage)\\b",
        "message": "Critical resource deletion"
      }
    ]
  }
}

Configuration Options

Sensitive Pattern Configuration

The sensitive_patterns section defines patterns for redacting sensitive information:

{
  "sensitive_patterns": [
    {
      "pattern": "pattern_regex",
      "replacement": "replacement_text",
      "description": "Optional description"
    }
  ]
}

Risk Rules Configuration

The risk_rules section defines patterns for identifying risky changes:

{
  "risk_rules": {
    "high": [
      {
        "pattern": "pattern_regex",
        "message": "Risk message",
        "description": "Optional description"
      }
    ],
    "medium": [],
    "low": []
  }
}

Using Custom Configuration

Apply your configuration using the --config flag:

tfsumpy plan.json --config path/to/config.json

Environment Variables

tfsumpy supports the following environment variables:

TFSUMPY_CONFIG: Path to configuration file
TFSUMPY_DEBUG: Enable debug mode (set to "1" or "true")