0a5059df15
In an earlier commit we added the "Best Practices" situation to try to clarify the intended uses of named workspaces and to warn against using them as an alternative to system decomposition. However, the prior statement was cautious in its recommendations in the interests of being pragmatic, and as a result we've seen that users have in some cases misunderstood or disregarded these recommendations. The new "When to use Multiple Workspaces" section aims to be more explicit that having multiple separate Terraform configurations is the preferred solution for many use-cases, and that workspaces are intended for a more limited set of use-cases around convenient development and testing. It also emphasizes the analogy to version control branches that was just a footnote in the prior text, to help the reader become familiar with the concept by relating it to a concept and workflow they are hopefully already familiar with. This new section also attempts to provide a more elaborate description of the proposed alternative when the goal is system decomposition. In the long run some of this content would probably be better placed elsewhere since it is useful advice even for users who never discover named workspaces, but it can live here for the time being to limit the scope of this change until we are ready to make more comprehensive revisions to the docs in this area. Finally, the introductory documentation here is adjusted slightly in preparation for the intended future expansion of workspaces to include stored variable values and, for more tailored backends like Terraform Enterprise, a full log of prior operations. More revisions will be required to cover the specifics of this later, but this new framing will hopefully help users form a mental model of named workspaces that has room for these future enhancements and the corresponding concept in Terraform Enterprise, rather than our previous framing that workspaces are fundamentally just named states. |
||
|---|---|---|
| .. | ||
| docs | ||
| guides | ||
| intro | ||
| layouts | ||
| upgrade-guides | ||
| README.md | ||
README.md
Terraform Documentation
This directory contains the portions of the Terraform website that pertain to the core functionality, excluding providers and the overall configuration.
The files in this directory are intended to be used in conjunction with
the terraform-website repository, which brings all of the
different documentation sources together and contains the scripts for testing and building the site as
a whole.