Skip to content

Fix remote backend multi workspace state migration #28864

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

Merged
alisdair merged 2 commits into from
Jun 8, 2021
Merged

Fix remote backend multi workspace state migration #28864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6692336
cli: Fix state migration version check
alisdair Jun 2, 2021
3f0c6a2
cli: Add -ignore-remote-version flag for init
alisdair Jun 2, 2021
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
62 changes: 33 additions & 29 deletions internal/command/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ func (c *InitCommand) Run(args []string) int {
cmdFlags.BoolVar(&flagUpgrade, "upgrade", false, "")
cmdFlags.Var(&flagPluginPath, "plugin-dir", "plugin directory")
cmdFlags.StringVar(&flagLockfile, "lockfile", "", "Set a dependency lockfile mode")
cmdFlags.BoolVar(&c.Meta.ignoreRemoteVersion, "ignore-remote-version", false, "continue even if remote and local Terraform versions are incompatible")
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
if err := cmdFlags.Parse(args); err != nil {
return 1
Expand Down Expand Up @@ -962,46 +963,49 @@ Usage: terraform [global options] init [options]

Options:

-backend=true Configure the backend for this configuration.
-backend=true Configure the backend for this configuration.

-backend-config=path This can be either a path to an HCL file with key/value
assignments (same format as terraform.tfvars) or a
'key=value' format. This is merged with what is in the
configuration file. This can be specified multiple
times. The backend type must be in the configuration
itself.
-backend-config=path This can be either a path to an HCL file with key/value
assignments (same format as terraform.tfvars) or a
'key=value' format. This is merged with what is in the
configuration file. This can be specified multiple
times. The backend type must be in the configuration
itself.

-force-copy Suppress prompts about copying state data. This is
equivalent to providing a "yes" to all confirmation
prompts.
-force-copy Suppress prompts about copying state data. This is
equivalent to providing a "yes" to all confirmation
prompts.

-from-module=SOURCE Copy the contents of the given module into the target
directory before initialization.
-from-module=SOURCE Copy the contents of the given module into the target
directory before initialization.

-get=true Download any modules for this configuration.
-get=true Download any modules for this configuration.

-input=true Ask for input if necessary. If false, will error if
input was required.
-input=true Ask for input if necessary. If false, will error if
input was required.

-no-color If specified, output won't contain any color.
-no-color If specified, output won't contain any color.

-plugin-dir Directory containing plugin binaries. This overrides all
default search paths for plugins, and prevents the
automatic installation of plugins. This flag can be used
multiple times.
-plugin-dir Directory containing plugin binaries. This overrides all
default search paths for plugins, and prevents the
automatic installation of plugins. This flag can be used
multiple times.

-reconfigure Reconfigure the backend, ignoring any saved
configuration.
-reconfigure Reconfigure the backend, ignoring any saved
configuration.

-migrate-state Reconfigure the backend, and attempt to migrate any
existing state.
-migrate-state Reconfigure the backend, and attempt to migrate any
existing state.

-upgrade=false If installing modules (-get) or plugins, ignore
previously-downloaded objects and install the
latest version allowed within configured constraints.
-upgrade=false If installing modules (-get) or plugins, ignore
previously-downloaded objects and install the
latest version allowed within configured constraints.

-lockfile=MODE Set a dependency lockfile mode.
Currently only "readonly" is valid.
-lockfile=MODE Set a dependency lockfile mode.
Currently only "readonly" is valid.

-ignore-remote-version A rare option used for the remote backend only. See
the remote backend documentation for more information.

`
return strings.TrimSpace(helpText)
Expand Down
16 changes: 9 additions & 7 deletions internal/command/meta_backend_migrate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error {
errMigrateLoadStates), opts.OneType, err)
}

_, err = opts.Two.Workspaces()
twoWorkspaces, err := opts.Two.Workspaces()
Copy link
Copy Markdown
Member

@radditude radditude Jun 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A very small naming nit: I was momentarily confused by this variable name because my brain tried to parse two as the number of workspaces 😆 would it be weird to call this backendTwoWorkspaces instead? I realize that breaks with the naming convention of the other variables in this file, though.

Copy link
Copy Markdown
Contributor Author

@alisdair alisdair Jun 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this variable naming is confusing, but as you noted the rest of the function (and the entire file) has this pattern established, and I don't want to change everything else so I intend to leave it as-is 😑

if err == backend.ErrWorkspacesNotSupported {
twoSingle = true
err = nil
Expand All @@ -77,12 +77,14 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error {
// as we are migrating away and will not break a remote workspace.
m.ignoreRemoteBackendVersionConflict(opts.One)

// Check the remote Terraform version for the state destination backend. If
// it's a Terraform Cloud remote backend, we want to ensure that we don't
// break the workspace by uploading an incompatible state file.
diags := m.remoteBackendVersionCheck(opts.Two, opts.twoEnv)
if diags.HasErrors() {
return diags.Err()
for _, twoWorkspace := range twoWorkspaces {
// Check the remote Terraform version for the state destination backend. If
// it's a Terraform Cloud remote backend, we want to ensure that we don't
// break the workspace by uploading an incompatible state file.
diags := m.remoteBackendVersionCheck(opts.Two, twoWorkspace)
if diags.HasErrors() {
return diags.Err()
}
}

// Determine migration behavior based on whether the source/destination
Expand Down