How do I use tfvar to create environment variables for my Terraform module?

Run tfvar with the -e flag, e.g., 'tfvar . -e', to output variable definitions as export TF_VAR_* commands. This is useful for CI/CD pipelines or shell scripts where environment variables are preferred.

Can tfvar handle nested Terraform modules?

Yes, tfvar scans directories recursively, so it can extract variables from nested modules. However, it treats all variables as part of the root module's inputs without distinguishing hierarchy in the output.

tfvar or manually writing .tfvars files – which is better?

tfvar automates the process, reducing errors and saving time for complex modules with many variables. Manual writing is sufficient for simple cases, but tfvar ensures consistency and integrates with existing variable sources like .tfvars files.

How to ignore sensitive variables when generating templates with tfvar?

tfvar does not have built-in sensitivity filtering; it outputs all variables including sensitive ones. You need to manually filter the output or rely on Terraform's sensitive flag, but tfvar will still include them in the generated templates.

Does tfvar work with Terraform 0.12 and newer syntax?

Yes, tfvar is designed to parse modern Terraform configurations, including HCL2 syntax from Terraform 0.12 onwards, as shown in the examples with complex types like lists and objects.

How to install tfvar on Windows?

Download the Windows binary from the release page (e.g., tfvar_windows_amd64.exe) and place it in your PATH. Alternatively, use package managers if available, though primary installation methods are geared towards Unix-like systems.

Open-Awesome

tfvar

MITGov0.11.0

A CLI tool that scans Terraform configurations and generates variable definition templates in multiple formats.

Visit Website GitHub

231 stars24 forks0 contributors

What is tfvar?

tfvar is a Terraform variable definitions template generator. It scans Terraform configurations or modules, extracts declared input variables, and produces templates in formats like .tfvars, environment variables, or Terraform Enterprise resources. It solves the problem of manually creating and maintaining variable definition files, especially in complex modules with many inputs.

Target Audience

Terraform users and DevOps engineers who work with multiple Terraform modules or need to consistently populate variable values across different environments.

Value Proposition

Developers choose tfvar because it automates a repetitive and error-prone task, supports multiple output formats for different workflows (local, CI/CD, Terraform Cloud/Enterprise), and integrates seamlessly with Terraform's existing variable precedence system.

Overview

Terraform's variable definitions template generator.

Use Cases

Best For

Generating initial .tfvars files for a new Terraform module
Converting Terraform variables to environment variables for CI/CD pipelines
Creating Terraform Enterprise (tfe) variable resources from existing modules
Preparing variable payloads for Terraform Cloud's Workspace Variables API
Auditing all required inputs for a complex Terraform configuration
Automating variable population from existing tfvars files and environment variables

Not Ideal For

Teams managing Terraform exclusively through Terraform Cloud's web UI without CLI integration
Projects with monolithic, single-file Terraform configurations that have fewer than five input variables
Environments requiring dynamic variable generation from external APIs or databases at runtime
Organizations using multiple IaC tools like Pulumi or CloudFormation alongside Terraform

Pros & Cons

Pros

Flexible Output Formats

Generates templates in .tfvars, environment variable exports, Terraform Enterprise resources, and Terraform Cloud API payloads, catering to diverse deployment workflows as shown in the README examples.

Seamless Terraform Integration

Mirrors Terraform's variable precedence with --var and --var-file flags, ensuring consistency with existing CLI practices and reducing learning curve.

Automated Value Population

The --auto-assign option pulls values from terraform.tfvars and environment variables, streamlining setup by minimizing manual entry errors.

Customizable Default Handling

Offers --ignore-default to exclude variable defaults, allowing for clean templates when defaults are not desired, as demonstrated in the usage examples.

Cons

Limited Scope

Only extracts input variables and ignores outputs, providers, or other Terraform elements, necessitating additional tools for full module documentation.

No Built-in Validation

Does not validate variable types or values against Terraform schemas, which could lead to runtime errors if incorrect values are used without proper checks.

Terraform-Exclusive Utility

Useful only for Terraform projects, with no support for other infrastructure-as-code platforms, limiting its applicability in mixed environments.

Frequently Asked Questions

Related Projects

terraformer

CLI tool to generate terraform files from existing infrastructure (reverse Terraform). Infrastructure to Code

Stars14,557

Forks1,837

Last commit5 months ago

$Infracost$ Infracost

Cloud cost intelligence for engineers, AI coding agents, and CI/CD 💰📉 Shift FinOps Left!

Stars12,509

Forks686

Last commit6 days ago

Terragrunt

Terragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.

Stars9,819

Forks1,222

Last commit15 hours ago

atlantis

Terraform Pull Request Automation

Stars9,281

Forks1,335

Last commit13 hours ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub