terraform icon indicating copy to clipboard operation
terraform copied to clipboard

[docs] Add warning about prefix loss when migrating

Open philomory opened this issue 3 years ago • 2 comments
trafficstars

This adds a warning about the consequences of switching to the cloud block, in terms of losing prefix support, and the impact that has on CLI usage. Specifically, after switching from the remote backend to the cloud block, CLI users lose the ability to run e.g. terraform workspace select prod, and must instead run e.g. terraform workspace select my-app-prod. This has the potential to impact previously written scripts, as well, but was until now not actually noted in the migration documentation.

philomory avatar Oct 11 '22 22:10 philomory

CLA assistant check
All committers have signed the CLA.

hashicorp-cla avatar Oct 11 '22 22:10 hashicorp-cla

Thanks for this submission! I've notified the docs team for review.

crw avatar Oct 12 '22 22:10 crw

What needs to be done to merge this?

philomory avatar Nov 11 '22 02:11 philomory

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

vercel[bot] avatar May 05 '23 23:05 vercel[bot]

📄 Content Checks

Updated: Fri, 05 May 2023 23:06:11 GMT

Found 8 error(s)

docs/cli/cloud/migrating.mdx

Position Description Rule
1:1-1:1 Document does not have a description key in its frontmatter. Add a description key at the top of the document. ensure-valid-frontmatter
7:7-7:66 Unexpected product-relative link: /cli/cloud/settings. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/cli/cloud/settings ensure-valid-link-format
7:274-7:320 Unexpected product-relative link: /cloud-docs/run/cli. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/cloud-docs/run/cli ensure-valid-link-format
17:25-17:122 Unexpected link to learn.hashicorp.com: https://learn.hashicorp.com/tutorials/terraform/cloud-migrate. Replace it with a relative path internal to Developer with the format: /{productSlug}/tutorials/{collectionSlug}/{tutorialSlug}. ensure-valid-link-format
19:90-20:38 Unexpected product-relative link: /language/settings/backends. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/language/settings/backends ensure-valid-link-format
33:41-34:39 Unexpected product-relative link: /cloud-docs/workspaces/naming. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/cloud-docs/workspaces/naming ensure-valid-link-format
40:5-40:59 Unexpected product-relative link: /language/settings/backends/remote. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/language/settings/backends/remote ensure-valid-link-format
40:112-40:158 Unexpected product-relative link: /cloud-docs/run/cli. Ensure that relative links are fully-qualified Developer paths: /{productSlug}/cloud-docs/run/cli ensure-valid-link-format

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

github-actions[bot] avatar May 05 '23 23:05 github-actions[bot]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

github-actions[bot] avatar Jun 05 '23 02:06 github-actions[bot]