tfmod

README

tfmod

tfmod outputs the dependencies and dependents for Terraform.

Description

tfmod helps you understand the relationships between your Terraform state directories and modules. It shows which state directories use which modules and vice versa.

• dependency: Finds the modules used by the specified state directories.
• dependent: Finds the state directories that use the specified modules.

A "state directory" is where you run terraform plan or terraform apply. It typically stores the terraform.tfstate file.

For example, if you modify a Terraform module, you can see which state directories are affected.

$ tfmod dependent --module=module/foo
state/prd state/stg

With tfmod, you can easily identify relationships and dependencies in your Terraform configurations, making it easier to manage changes and understand their impacts.

Installation

Download binary

Download the latest compiled binaries and put it anywhere in your executable path.

• GitHub Releases

Pull container image

You can pull container image from GitHub Packages.

docker pull ghcr.io/tmknom/tfmod

Usage

Assume you have the following directory structure for managing Terraform:

├── state
│   ├── prd
│   └── stg
└── module
    ├── bar
    └── foo

You can run the subcommands as follows:

Download Terraform modules

Download all the Terraform modules for the state directories under the current directory.

tfmod download

You can also specify the base directory for the state directories.

tfmod download --base state

[!TIP]

To analyze dependencies with tfmod, you need to download Terraform modules first. If you have already run terraform get or terraform init, this command is not needed.

Explore dependencies

Specify a state directory to find the Terraform modules it depends on.

tfmod dependency --state=state/prd

You can specify multiple state directories separated by commas.

tfmod dependency --state=state/prd,state/stg

Explore dependents

Specify a Terraform module to find the state directories that reference it.

tfmod dependent --module=module/foo

You can specify multiple Terraform modules separated by commas.

tfmod dependent --module=module/foo,module/bar

Related projects

N/A

Release notes

See GitHub Releases.

License

Apache 2 Licensed. See LICENSE for full details.

Documentation

Index

• type App
  • func NewApp(io *IO, ldflags *Ldflags) *App
  • func (a *App) Run(ctx context.Context, args []string) error
• type DependencyFlags
  • func NewDependencyFlags(globalFlags *GlobalFlags) *DependencyFlags
  • func (f *DependencyFlags) GoString() string
• type DependencyRunner
  • func NewDependencyRunner(flags *DependencyFlags, store terraform.Store, io *IO) *DependencyRunner
  • func (r *DependencyRunner) List() ([]string, error)
  • func (r *DependencyRunner) Run() error
• type DependentFlags
  • func NewDependentFlags(globalFlags *GlobalFlags) *DependentFlags
  • func (f *DependentFlags) GoString() string
• type DependentRunner
  • func NewDependentRunner(flags *DependentFlags, store terraform.Store, io *IO) *DependentRunner
  • func (r *DependentRunner) List() ([]string, error)
  • func (r *DependentRunner) Run() error
• type DownloadFlags
  • func NewDownloadFlags(globalFlags *GlobalFlags) *DownloadFlags
  • func (f *DownloadFlags) GoString() string
• type DownloadRunner
  • func NewDownloadRunner(flags *DownloadFlags, io *IO) *DownloadRunner
  • func (r *DownloadRunner) Run(ctx context.Context) error
  • func (r *DownloadRunner) TerraformGet(ctx context.Context) ([]string, error)
• type GlobalFlags
  • func (f *GlobalFlags) BaseDir() *dir.BaseDir
  • func (f *GlobalFlags) Format() string
  • func (f *GlobalFlags) GoString() string
• type IO
  • func (i *IO) IsPipe() bool
  • func (i *IO) Read() []string
• type Ldflags

Types

type App

type App struct {
	*IO
	*Ldflags

	*GlobalFlags
	// contains filtered or unexported fields
}

func NewApp

func NewApp(io *IO, ldflags *Ldflags) *App

func (*App) Run

func (a *App) Run(ctx context.Context, args []string) error

type DependencyFlags

type DependencyFlags struct {
	StatePaths []string
	*GlobalFlags
}

func NewDependencyFlags

func NewDependencyFlags(globalFlags *GlobalFlags) *DependencyFlags

func (*DependencyFlags) GoString

func (f *DependencyFlags) GoString() string

type DependencyRunner

type DependencyRunner struct {
	terraform.Store
	*IO
	// contains filtered or unexported fields
}

func NewDependencyRunner

func NewDependencyRunner(flags *DependencyFlags, store terraform.Store, io *IO) *DependencyRunner

func (*DependencyRunner) List

func (r *DependencyRunner) List() ([]string, error)

func (*DependencyRunner) Run

func (r *DependencyRunner) Run() error

type DependentFlags

type DependentFlags struct {
	ModulePaths []string
	*GlobalFlags
}

func NewDependentFlags

func NewDependentFlags(globalFlags *GlobalFlags) *DependentFlags

func (*DependentFlags) GoString

func (f *DependentFlags) GoString() string

type DependentRunner

type DependentRunner struct {
	terraform.Store
	*IO
	// contains filtered or unexported fields
}

func NewDependentRunner

func NewDependentRunner(flags *DependentFlags, store terraform.Store, io *IO) *DependentRunner

func (*DependentRunner) List

func (r *DependentRunner) List() ([]string, error)

func (*DependentRunner) Run

func (r *DependentRunner) Run() error

type DownloadFlags

type DownloadFlags struct {
	MaxConcurrent int
	*GlobalFlags
}

func NewDownloadFlags

func NewDownloadFlags(globalFlags *GlobalFlags) *DownloadFlags

func (*DownloadFlags) GoString

func (f *DownloadFlags) GoString() string

type DownloadRunner

type DownloadRunner struct {
	*IO
	// contains filtered or unexported fields
}

func NewDownloadRunner

func NewDownloadRunner(flags *DownloadFlags, io *IO) *DownloadRunner

func (*DownloadRunner) Run

func (r *DownloadRunner) Run(ctx context.Context) error

func (*DownloadRunner) TerraformGet

func (r *DownloadRunner) TerraformGet(ctx context.Context) ([]string, error)

type GlobalFlags

type GlobalFlags struct {
	// contains filtered or unexported fields
}

func (*GlobalFlags) BaseDir

func (f *GlobalFlags) BaseDir() *dir.BaseDir

func (*GlobalFlags) Format

func (f *GlobalFlags) Format() string

func (*GlobalFlags) GoString

func (f *GlobalFlags) GoString() string

type IO

type IO struct {
	InReader  io.Reader
	OutWriter io.Writer
	ErrWriter io.Writer
}

func (*IO) IsPipe

func (i *IO) IsPipe() bool

func (*IO) Read

func (i *IO) Read() []string

type Ldflags

type Ldflags struct {
	Name    string
	Version string
	Commit  string
	Date    string
	Url     string
}