Skip to content

Add configurable tf-path parameter for Terragrunt templates #3398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
+30,884 −30,849
Closed

Add configurable tf-path parameter for Terragrunt templates #3398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcf8de8
Initial plan
Copilot Nov 4, 2025
05947f7
Initial commit - plan for OpenTofu support in Terragrunt
Copilot Nov 4, 2025
f613e6b
Add OpenTofu support for Terragrunt via tf_path parameter
Copilot Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions db/Template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ type TerraformTemplateParams struct {
AutoApprove bool `json:"auto_approve,omitempty"`
OverrideBackend bool `json:"override_backend,omitempty"` // override backend if internal backend is used
BackendFilename string `json:"backend_filename,omitempty"`
TfPath string `json:"tf_path,omitempty"` // path to terraform binary (e.g., "tofu" for OpenTofu)
}

type SurveyVarEnumValue struct {
Expand Down
58 changes: 39 additions & 19 deletions db_lib/TerraformApp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ func (t *TerraformApp) SetLogger(logger task_logger.Logger) task_logger.Logger {
return logger
}

func (t *TerraformApp) init(environmentVars []string, keyInstaller AccessKeyInstaller, params *db.TerraformTaskParams) error {
func (t *TerraformApp) init(environmentVars []string, keyInstaller AccessKeyInstaller, params *db.TerraformTaskParams, tplParams *db.TerraformTemplateParams) error {

keyInstallation, err := keyInstaller.Install(t.Inventory.SSHKey, db.AccessKeyRoleGit, t.Logger)
if err != nil {
Expand All @@ -127,7 +127,11 @@ func (t *TerraformApp) init(environmentVars []string, keyInstaller AccessKeyInst
}

if t.Name == string(db.AppTerragrunt) {
args = append(args, "--tf-path=terraform")
tfPath := "terraform"
if tplParams.TfPath != "" {
tfPath = tplParams.TfPath
}
args = append(args, "--tf-path="+tfPath)
}

cmd := t.makeCmd(t.Name, args, environmentVars)
Expand Down Expand Up @@ -159,11 +163,15 @@ func (t *TerraformApp) init(environmentVars []string, keyInstaller AccessKeyInst
return nil
}

func (t *TerraformApp) isWorkspacesSupported(environmentVars []string) bool {
func (t *TerraformApp) isWorkspacesSupported(environmentVars []string, tplParams *db.TerraformTemplateParams) bool {
args := []string{"workspace", "list"}
if t.Name == string(db.AppTerragrunt) {
args = append([]string{"run", "--"}, args...)
args = append(args, "--tf-path=terraform")
tfPath := "terraform"
if tplParams.TfPath != "" {
tfPath = tplParams.TfPath
}
args = append(args, "--tf-path="+tfPath)
}
cmd := t.makeCmd(t.Name, args, environmentVars)
err := cmd.Run()
Expand All @@ -174,11 +182,15 @@ func (t *TerraformApp) isWorkspacesSupported(environmentVars []string) bool {
return true
}

func (t *TerraformApp) selectWorkspace(workspace string, environmentVars []string) error {
func (t *TerraformApp) selectWorkspace(workspace string, environmentVars []string, tplParams *db.TerraformTemplateParams) error {
args := []string{"workspace", "select", "-or-create=true", workspace}
if t.Name == string(db.AppTerragrunt) {
args = append([]string{"run", "--"}, args...)
args = append(args, "--tf-path=terraform")
tfPath := "terraform"
if tplParams.TfPath != "" {
tfPath = tplParams.TfPath
}
args = append(args, "--tf-path="+tfPath)
}
cmd := t.makeCmd(t.Name, args, environmentVars)
t.Logger.LogCmd(cmd)
Expand Down Expand Up @@ -232,7 +244,7 @@ func (t *TerraformApp) InstallRequirements(args LocalAppInstallingArgs) (err err
}
}

if err = t.init(args.EnvironmentVars, args.Installer, p); err != nil {
if err = t.init(args.EnvironmentVars, args.Installer, p, tpl); err != nil {
return
}

Expand All @@ -242,18 +254,22 @@ func (t *TerraformApp) InstallRequirements(args LocalAppInstallingArgs) (err err
workspace = t.Inventory.Inventory
}

if !t.isWorkspacesSupported(args.EnvironmentVars) {
if !t.isWorkspacesSupported(args.EnvironmentVars, tpl) {
return
}

err = t.selectWorkspace(workspace, args.EnvironmentVars)
err = t.selectWorkspace(workspace, args.EnvironmentVars, tpl)
return
}

func (t *TerraformApp) Plan(args []string, environmentVars []string, inputs map[string]string, cb func(*os.Process)) error {
func (t *TerraformApp) Plan(args []string, environmentVars []string, inputs map[string]string, cb func(*os.Process), tplParams *db.TerraformTemplateParams) error {
planArgs := []string{"plan", "-lock=false"}
if t.Name == string(db.AppTerragrunt) {
planArgs = append(planArgs, "--tf-path=terraform")
tfPath := "terraform"
if tplParams.TfPath != "" {
tfPath = tplParams.TfPath
}
planArgs = append(planArgs, "--tf-path="+tfPath)
}
planArgs = append(planArgs, args...)
cmd := t.makeCmd(t.Name, planArgs, environmentVars)
Expand Down Expand Up @@ -282,10 +298,14 @@ func (t *TerraformApp) Plan(args []string, environmentVars []string, inputs map[
return nil
}

func (t *TerraformApp) Apply(args []string, environmentVars []string, inputs map[string]string, cb func(*os.Process)) error {
func (t *TerraformApp) Apply(args []string, environmentVars []string, inputs map[string]string, cb func(*os.Process), tplParams *db.TerraformTemplateParams) error {
applyArgs := []string{"apply", "-auto-approve", "-lock=false"}
if t.Name == string(db.AppTerragrunt) {
applyArgs = append(applyArgs, "--tf-path=terraform")
tfPath := "terraform"
if tplParams.TfPath != "" {
tfPath = tplParams.TfPath
}
applyArgs = append(applyArgs, "--tf-path="+tfPath)
}
applyArgs = append(applyArgs, args...)
cmd := t.makeCmd(t.Name, applyArgs, environmentVars)
Expand All @@ -307,22 +327,22 @@ func (t *TerraformApp) Apply(args []string, environmentVars []string, inputs map
}

func (t *TerraformApp) Run(args LocalAppRunningArgs) error {
err := t.Plan(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback)
params := args.TaskParams.(*db.TerraformTaskParams)
tplParams := args.TemplateParams.(*db.TerraformTemplateParams)

err := t.Plan(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback, tplParams)
if err != nil {
return err
}

params := args.TaskParams.(*db.TerraformTaskParams)
tplParams := args.TemplateParams.(*db.TerraformTemplateParams)

if t.PlanHasNoChanges || params.Plan {
t.Logger.SetStatus(task_logger.TaskSuccessStatus)
return nil
}

if tplParams.AutoApprove || tplParams.AllowAutoApprove && params.AutoApprove {
t.Logger.SetStatus(task_logger.TaskRunningStatus)
return t.Apply(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback)
return t.Apply(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback, tplParams)
}

t.Logger.SetStatus(task_logger.TaskWaitingConfirmation)
Expand All @@ -341,7 +361,7 @@ func (t *TerraformApp) Run(args LocalAppRunningArgs) error {
t.Logger.SetStatus(task_logger.TaskFailStatus)
case task_logger.TaskConfirmed:
t.Logger.SetStatus(task_logger.TaskRunningStatus)
return t.Apply(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback)
return t.Apply(args.CliArgs, args.EnvironmentVars, args.Inputs, args.Callback, tplParams)
}

return nil
Expand Down
Loading
Loading