This project is mirrored from https://:*****@github.com/hashicorp/terraform.git. Pull mirroring failed .
Repository mirroring has been paused due to too many failed attempts. It can be resumed by a project maintainer.
  1. 27 Jan, 2022 3 commits
  2. 15 Dec, 2021 1 commit
  3. 22 Nov, 2021 2 commits
  4. 30 Jul, 2021 2 commits
  5. 23 Jul, 2021 2 commits
  6. 06 Jul, 2021 1 commit
  7. 22 Jun, 2021 2 commits
    • Martin Atkins's avatar
      website: Explicit examples of -var escaping in various shells · a945b379
      Martin Atkins authored
      The -var command line option comes with the disadvantage that a user must
      contend both with Terraform's own parser and with the parser in whichever
      shell they've decided to use, and different shells on different platforms
      have different rules.
      
      Previously we've largely just assumed that folks know the appropriate
      syntax for the shell they chose, but it seems that command lines involving
      spaces and other special characters arise rarely enough in other commands
      that Terraform is often the first time someone needs to learn the
      appropriate syntax for their shell.
      
      We can't possibly capture all of the details of all shells in our docs,
      because that's far outside of our own scope, but hopefully this new
      section will go some way to give some real examples that will help folks
      figure out how to write suitable escape sequences, if they choose to
      set complex variable values on the command line rather than in .tfvars
      as we recommend elsewhere on this page.
      a945b379
    • Vlad Romanenko's avatar
      Add back missing closing quote character · d4d56a96
      Vlad Romanenko authored
      d4d56a96
  8. 08 Jun, 2021 1 commit
    • Judith Malnick's avatar
      Gloss of top docs pages (#28891) · 044c439d
      Judith Malnick authored
      
      * clarify input variables opening sentence
      
      * adjust variables description
      
      * claraify providers text and add learn callout
      
      * add description to providers page
      
      * add desscription and clarify provider configuration
      
      * add deprecation note to versions in proivder configs
      
      * add hands on callout and clarify next steps in intro
      
      * link to language collection from language docs
      
      * give more context about configurtion language up front
      
      * clarify output top page
      
      * reorganize for each intro to present feature before notes
      
      * move description before link out and remove passive voice
      
      * fix typo
      
      * clarify purpose of plan
      
      * move explanation before learn link and fully spell boolean
      
      * add a syntax heading  to separate intro from details
      
      * add learn callout to module source docs
      
      * clean up intro to provider requirements and add link
      
      * Apply suggestions from code review
      Co-authored-by: default avatarTu Nguyen <im2nguyen@users.noreply.github.com>
      
      * Apply suggestions from code review
      Co-authored-by: default avatarTu Nguyen <im2nguyen@users.noreply.github.com>
      Co-authored-by: default avatarTu Nguyen <im2nguyen@users.noreply.github.com>
      044c439d
  9. 26 May, 2021 1 commit
    • Martin Atkins's avatar
      website: More accurate release versions for new plan options · 6d80088f
      Martin Atkins authored
      While we were working on and documenting these it wasn't clear exactly
      what Terraform CLI version they would land in, and so we used
      "Terraform v1.0" in the docs as a safe bound that was definitely going to
      include all of them.
      
      With everything now landed though, we can be more specific about which
      v0.15.x minor release each of these appeared in.
      6d80088f
  10. 25 May, 2021 1 commit
  11. 18 May, 2021 1 commit
  12. 13 May, 2021 1 commit
    • Martin Atkins's avatar
      command+backend/local: -refresh-only and drift detection · 3c8a4e6e
      Martin Atkins authored
      This is a light revamp of our plan output to make use of Terraform core's
      new ability to report both the previous run state and the refreshed state,
      allowing us to explicitly report changes made outside of Terraform.
      
      Because whether a plan has "changes" or not is no longer such a
      straightforward matter, this now merges views.Operation.Plan with
      views.Operation.PlanNoChanges to produce a single function that knows how
      to report all of the various permutations. This was also an opportunity
      to fill some holes in our previous logic which caused it to produce some
      confusing messages, including a new tailored message for when
      "terraform destroy" detects that nothing needs to be destroyed.
      
      This also allows users to request the refresh-only planning mode using a
      new -refresh-only command line option. In that case, Terraform _only_
      performs drift detection, and so applying a refresh-only plan only
      involves writing a new state snapshot, without changing any real
      infrastructure objects.
      3c8a4e6e
  13. 12 May, 2021 1 commit
    • Martin Atkins's avatar
      command: use -lock=false consistently in -help output · 42e09858
      Martin Atkins authored
      Previously the docs for this were rather confusing because they showed an
      option to turn _on_ state locking, even though it's on by default.
      
      Instead, we'll now show -lock=false in all cases and document it as
      _disabling_ the default locking.
      
      While working on this I also noticed that the equivalent docs on the
      website were differently inconsistent. I've not made them fully consistent
      here but at least moreso than they were before.
      42e09858
  14. 03 May, 2021 1 commit
    • Martin Atkins's avatar
      command: New -replace=... planning option · 1d3e34e3
      Martin Atkins authored
      This allows a similar effect to pre-tainting an object but does the action
      within the context of a normal plan and apply, avoiding the need for an
      intermediate state where the old object still exists but is marked as
      tainted.
      
      The core functionality for this was already present, so this commit is
      just the UI-level changes to make that option available for use and to
      explain how it contributed to the resulting plan in Terraform's output.
      1d3e34e3
  15. 30 Apr, 2021 2 commits
    • Martin Atkins's avatar
      website: Reworking of the "terraform plan" docs, and related pages · 6bed3008
      Martin Atkins authored
      It's been a long time since we gave this page an overhaul, and with our
      ongoing efforts to make plan and apply incorporate all of the side-effects
      that might need to be done against a configuration it seems like a good
      time for some restructuring in that vein.
      
      The starting idea here is to formally split the many "terraform plan"
      options into a few different categories:
       - Planning modes
       - Planning options
       - Other options
      
      The planning modes and options are the subset that are also accepted by
      "terraform apply" when it's running in its default mode of generating a
      plan and then prompting for interactive approval of it. This then allows
      us to avoid duplicating all of that information on the "terraform apply"
      page, and thus allows us to spend more words discussing each of them.
      
      This set of docs is intended as a fresh start into which we'll be able to
      more surgically add in the information about -refresh-only and -replace=...
      once we have those implemented. Consequently there are some parts of this
      which may seem a little overwraught for what it's currently describing;
      that's a result of my having prepared this by just deleting the
      -refresh-only and -replace=... content from our initial docs draft and
      submitted the result, in anticipation of re-adding the parts I've deleted
      here in the very near future in other commits.
      6bed3008
    • Sam Velie's avatar
      docs: correct spelling of normally (#28508) · 5d04c4ea
      Sam Velie authored
      5d04c4ea
  16. 25 Mar, 2021 1 commit
    • Martin Atkins's avatar
      command: Reorganize docs of the local backend's legacy CLI options · 6f35c284
      Martin Atkins authored
      We have these funny extra options that date back to before Terraform even
      had remote state, which we've preserved along the way by most recently
      incorporating them as special-case overrides for the local backend.
      
      The documentation we had for these has grown less accurate over time as
      the details have shifted, and was in many cases missing the requisite
      caveats that they are only for the local backend and that backend
      configuration is the modern, preferred way to deal with the use-cases they
      were intended for.
      
      We always have a bit of a tension with this sort of legacy option because
      we want to keep them documented just enough to be useful to someone who
      finds an existing script/etc using them and wants to know what they do,
      but not to take up so much space that they might distract users from
      finding the modern alternative they should consider instead.
      
      As a compromise in that vein here I've created a new section about these
      options under the local backend documentation, which then gives us the
      space to go into some detail about the various behaviors and interactions
      and also to discuss their history and our recommended alternatives. I then
      simplified all of the other mentions of these in command documentation
      to just link to or refer to the local backend documentation. My hope then
      is that folks who need to know what these do can still find the docs, but
      that information can be kept out of the direct path of new users so they
      can focus on learning about remote backends instead.
      
      This is certainly not the most ideal thing ever, but it seemed like the
      best compromise between the competing priorities I described above.
      6f35c284
  17. 22 Mar, 2021 1 commit
  18. 22 Jan, 2021 3 commits
  19. 17 Dec, 2020 1 commit
    • Nick Fagerlund's avatar
      website: Fix numerous links with redirects or broken anchors · 85d477ae
      Nick Fagerlund authored
      These links largely still go somewhere useful, but they have some kind of issue
      revealed by our new link checker:
      
      - Some of them point to a stale URL that redirects, and can be updated to the
        new destination.
      - Some of them point to anchors that don't exist (anymore?) in the destination.
      - Some of them end up redirecting unnecessarily due to how the server handles
        directory URLs without trailing slashes. Sorry, I know that's pointless, just,
        humor me for the time being so we can get our CI green. :sob:
      
      In a couple cases, I've added invisible anchors to destination pages, either to
      preserve an old habit or because the current anchors kind of suck due to being
      particularly long or meandering.
      85d477ae
  20. 02 Oct, 2020 1 commit
  21. 04 Sep, 2020 1 commit
    • Martin Atkins's avatar
      main: new global option -chdir · efe78b29
      Martin Atkins authored
      This new option is intended to address the previous inconsistencies where
      some older subcommands supported partially changing the target directory
      (where Terraform would use the new directory inconsistently) where newer
      commands did not support that override at all.
      
      Instead, now Terraform will accept a -chdir command at the start of the
      command line (before the subcommand) and will interpret it as a request
      to direct all actions that would normally be taken in the current working
      directory into the target directory instead. This is similar to options
      offered by some other similar tools, such as the -C option in "make".
      
      The new option is only accepted at the start of the command line (before
      the subcommand) as a way to reflect that it is a global command (not
      specific to a particular subcommand) and that it takes effect _before_
      executing the subcommand. This also means it'll be forced to appear before
      any other command-specific arguments that take file paths, which hopefully
      communicates that those other arguments are interpreted relative to the
      overridden path.
      
      As a measure of pragmatism for existing uses, the path.cwd object in
      the Terraform language will continue to return the _original_ working
      directory (ignoring -chdir), in case that is important in some exceptional
      workflows. The path.root object gives the root module directory, which
      will always match the overriden working directory unless the user
      simultaneously uses one of the legacy directory override arguments, which
      is not a pattern we intend to support in the long run.
      
      As a first step down the deprecation path, this commit adjusts the
      documentation to de-emphasize the inconsistent old command line arguments,
      including specific guidance on what to use instead for the main three
      workflow commands, but all of those options remain supported in the same
      way as they were before. In a later commit we'll make those arguments
      produce a visible deprecation warning in Terraform's output, and then
      in an even later commit we'll remove them entirely so that -chdir is the
      single supported way to run Terraform from a directory other than the
      one containing the root module configuration.
      efe78b29
  22. 31 Jul, 2020 1 commit
  23. 29 May, 2020 2 commits
    • Martin Atkins's avatar
      website: Small corrections to the "plan" and "apply" command docs · 89c2a61b
      Martin Atkins authored
      The "apply" documentation contained a simple typo, while the "plan"
      documentation contained outdated information about using
      "terraform plan PLANFILE" to view a plan. The latter is now a separate
      command entirely, since Terraform 0.12: "terraform show PLANFILE".
      89c2a61b
    • Martin Atkins's avatar
      backend/local: treat output changes as side-effects to be applied · 31a4b44d
      Martin Atkins authored
      This is a baby-step towards an intended future where all Terraform actions
      which have side-effects in either remote objects or the Terraform state
      can go through the plan+apply workflow.
      
      This initial change is focused only on allowing plan+apply for changes to
      root module output values, so that these can be written into a new state
      snapshot (for consumption by terraform_remote_state elsewhere) without
      having to go outside of the primary workflow by running
      "terraform refresh".
      
      This is also better than "terraform refresh" because it gives an
      opportunity to review the proposed changes before applying them, as we're
      accustomed to with resource changes.
      
      The downside here is that Terraform Core was not designed to produce
      accurate changesets for root module outputs. Although we added a place for
      it in the plan model in Terraform 0.12, Terraform Core currently produces
      inaccurate changesets there which don't properly track the prior values.
      
      We're planning to rework Terraform Core's evaluation approach in a
      forthcoming release so it would itself be able to distinguish between the
      prior state and the planned new state to produce an accurate changeset,
      but this commit introduces a temporary stop-gap solution of implementing
      the logic up in the local backend code, where we can freeze a snapshot of
      the prior state before we take any other actions and then use that to
      produce an accurate output changeset to decide whether the plan has
      externally-visible side-effects and render any changes to output values.
      
      This temporary approach should be replaced by a more appropriately-placed
      solution in Terraform Core in a release, which should then allow further
      behaviors in similar vein, such as user-visible drift detection for
      resource instances.
      31a4b44d
  24. 05 Feb, 2020 1 commit
  25. 10 Dec, 2019 1 commit
    • Martin Atkins's avatar
      command: New -compact-warnings option · c06675c6
      Martin Atkins authored
      When warnings appear in isolation (not accompanied by an error) it's
      reasonable to want to defer resolving them for a while because they are
      not actually blocking immediate work.
      
      However, our warning messages tend to be long by default in order to
      include all of the necessary context to understand the implications of
      the warning, and that can make them overwhelming when combined with other
      output.
      
      As a compromise, this adds a new CLI option -compact-warnings which is
      supported for all the main operation commands and which uses a more
      compact format to print out warnings as long as they aren't also
      accompanied by errors.
      
      The default remains unchanged except that the threshold for consolidating
      warning messages is reduced to one so that we'll now only show one of
      each distinct warning summary.
      
      Full warning messages are always shown if there's at least one error
      included in the diagnostic set too, because in that case the warning
      message could contain additional cont...
      c06675c6
  26. 28 Jun, 2019 2 commits
    • mg's avatar
      Update plan.html.markdown · fcf0610b
      mg authored
      fcf0610b
    • mg's avatar
      Update plan.html.markdown · 9523040b
      mg authored
      Ran into an issue requiring `-var='foo=bar'` over `-var 'foo=bar'`.  
      
      Without the `=` the generic response came back:
      
      ```
      Usage: terraform plan [options] [DIR]
      
      Generates an execution plan for Terraform.
      
       This execution plan can be reviewed...
      ```
      
      Terraform `0.12.2`
      9523040b
  27. 22 Mar, 2019 1 commit
  28. 19 Mar, 2019 1 commit
  29. 06 Mar, 2019 1 commit