Commit Graph

6808 Commits

Author SHA1 Message Date
Laura Pacilio bfefb7405e Update layout file to remove deleted page 2022-01-18 14:07:40 -08:00
Laura Pacilio fc4ceedc6d Remove overview page and update notes on provisioner pages 2022-01-18 14:07:40 -08:00
Laura Pacilio 5f61140655
Merge pull request #30332 from hashicorp/fix-broken-links-1-10
Fix broken links to external docs
2022-01-11 10:40:12 -05:00
Martin Atkins beb9432155 website: CLI state manipulation section de-emphasize old features
Previously the "terraform state ..." subcommands were the only way to
perform various manipulations of the state, but in recent Terraform
versions we have replaced these with better options.

Since these pages seem to already have pretty good search engine
optimization for the use-cases they are describing, we'll prioritize
mentioning the new approaches and only mention the now-deprecated or
de-emphasized features as a secondary approach.

Specifically:
 - Describe the -replace=... planning option in preference to
   "terraform taint", and present taint as primarily a mechanism for
   Terraform to use itself, as opposed to something end-users should
   typically use directly.
 - Introduce the config-based refactoring features before describing
   "terraform state mv".

The older features here are still applicable in some situations and are
required for those still using older versions of Terraform, so we will
retain the information about them for now while aiming to be clearer in
each case about which is our preferred, modern approach.
2022-01-11 07:36:20 -08:00
Laura Pacilio 1b7e7b967d Fix broken links to external docs 2022-01-10 17:49:49 -05:00
Laura Pacilio f4eb0ed24d
Merge pull request #30280 from Mukesh05/patch-2
Update local values definition
2022-01-07 10:22:57 -05:00
Mukesh Kumar 3ac334f267
Update website/docs/language/values/locals.mdx
Thank you. Your suggestion to use "instead of" makes the sentence even more easy to understand.

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2022-01-07 05:52:12 +05:30
Martin Atkins 087c2f06ee website: Documentation of how provisioners upload files
We recently made a change to how provisioners upload files in order to
address an unintended remote code execution vector when using SSH, which
revealed that we had not previously documented well enough the expected
contract for how provisioners upload files to remote systems, and so some
users were depending on unintended consequences of the the bug now fixed.

We are retaining the fix on security-related grounds, but this is a good
prompt to be clearer in the docs about what exactly Terraform is doing
when asked to upload files over SSH and WinRM, so users can understand
what is supported and write their configurations accordingly.

This also includes an additional section to the v1.1 upgrade guide, since
we apparently neglected to document this intentional breaking change in
the first draft of that page.

Of course, provisioners as a whole remain a last resort, and so we're
documenting this as hopefully a helpful aid to those who have no other
option, and not meaning in any way to recommend their use for any new
use-cases.
2022-01-06 13:04:55 -08:00
Laura Pacilio 870116c509 more langauge edits 2022-01-06 11:48:13 -05:00
Laura Pacilio fbf02d6342 Language edits 2022-01-06 11:46:08 -05:00
Laura Pacilio 6ef9cf652e
Merge pull request #30270 from addison-grant/patch-1
Update variables.mdx to fix typo
2022-01-06 11:14:46 -05:00
Laura Pacilio 8b69d24147 Update remote state data source page 2022-01-04 16:31:52 -05:00
Laura Pacilio 96b31fb1d3 Update core workflow page 2022-01-04 15:43:52 -05:00
Laura Pacilio 5792973dd6 Update language on import command page 2022-01-04 15:22:12 -05:00
Laura Pacilio cab5305191 Fix formatting 2022-01-04 14:58:31 -05:00
Dylan Staley a8bc7a0170
Merge pull request #30237 from hashicorp/ds.submodule-nav-main
Store website nav files (main)
2022-01-04 11:45:49 -08:00
Martin Atkins 74761b2f8b getmodules: Use go-getter v1.5.10 and return to upstream GitGetter
There was an unintended regression in go-getter v1.5.9's GitGetter which
caused us to temporarily fork that particular getter into Terraform to
expedite a fix. However, upstream v1.5.10 now includes a
functionally-equivalent fix and so we can heal that fork by upgrading.

We'd also neglected to update the Module Sources docs when upgrading to
go-getter v1.5.9 originally and so we were missing documentation about the
new "depth" argument to enable shadow cloning, which I've added
retroactively here along with documenting its restriction of only
supporting named refs.

This new go-getter release also introduces a new credentials-passing
method for the Google Cloud Storage getter, and so we must incorporate
that into the Terraform-level documentation about module sources.
2022-01-03 11:44:16 -08:00
Mukesh Kumar 27cc49fe91
Update local values definition
The definition of local values used "it" many times, making the sentence not very clear.
2022-01-01 20:35:47 +05:30
Addison Grant 01be55b5c4
Update variables.mdx
Remove extraneous word "from" in "...use a sensitive value from as part of an..."
2021-12-27 10:25:31 -08:00
Martin Atkins e35c25da44 website: Try function documentation "provably" vs "probably" typo
This paragraph is trying to say that try only works for dynamic errors and
not for errors that are _not_ based on dynamic decision-making in
expressions.

I'm not sure if this typo was always here or if it was mistakenly "corrected"
at some point, but either way the word "probably" changes the meaning
of this sentence entirely, making it seem like Terraform is hedging
the likelihood of a problem rather than checking exactly for one.
2021-12-22 12:10:07 -08:00
Dylan Staley 31ed2d987c store website nav files 2021-12-21 14:52:51 -08:00
Laura Pacilio 138ca02b90 More mentions of remote backend 2021-12-21 17:51:06 -05:00
Laura Pacilio caf0bdbe8d fix push 2021-12-21 17:39:30 -05:00
Laura Pacilio 9022b23d57 Fixing references again 2021-12-21 17:37:35 -05:00
Laura Pacilio 3adcc0158c Add cli integration to command pages 2021-12-21 17:19:05 -05:00
Laura Pacilio f55af42086 Update module sources page 2021-12-21 17:10:29 -05:00
Laura Pacilio 04fb42cb05 Update push CLI command page 2021-12-21 17:05:09 -05:00
Laura Pacilio 2a530639f8 Tweaks 2021-12-20 16:01:03 -05:00
Laura Pacilio 410e45673d Update taint command page to make alternative clearer 2021-12-20 15:43:31 -05:00
Dylan Staley 8b6522169f
Merge pull request #30191 from hashicorp/ds.make-website
Update make website workflow
2021-12-20 11:10:59 -08:00
Martin Atkins 23395a1022 providercache: Discard lock entries for unused providers
Previously we would only ever add new lock entries or update existing
ones. However, it's possible that over time a module may _cease_ using
a particular provider, at which point we ought to remove it from the lock
file so that operations won't fail when seeing that the provider cache
directory is inconsistent with the lock file.

Now the provider installer (EnsureProviderVersions) will remove any lock
file entries that relate to providers not included in the given
requirements, which therefore makes the resulting lock file properly match
the set of packages the installer wrote into the cache.

This does potentially mean that someone could inadvertently defeat the
lock by removing a provider dependency, running "terraform init", then
undoing that removal, and finally running "terraform init" again. However,
that seems relatively unlikely compared to the likelihood of removing
a provider and keeping it removed, and in the event it _did_ happen the
changes to the lock entry for that provider would be visible in the diff
of the provider lock file as usual, and so could be noticed in code
review just as for any other change to dependencies.
2021-12-17 15:30:21 -08:00
Dylan Staley a086f0c1a5 update make website workflow 2021-12-16 16:10:17 -08:00
Dylan Staley 21cbb5b392 migrate docs to mdx 2021-12-14 18:41:17 -08:00
Patrick Decat 6530055d18
website: Refactoring "Renaming a Module Call" should include a moved block 2021-12-09 14:54:19 -08:00
Laura Pacilio 7ae574ba6a
Merge pull request #30082 from c00k133/docs-vars-typo
Docs: Change misspelling of variable in documentation
2021-12-09 16:35:50 -05:00
Marcus Way b202eefc7b
Update docs to use `assume_role` block
I'm guessing this document is just out of date, but I got an error when configuring `assume_role` as an argument and had to add an `assume_role` block
2021-12-08 19:33:17 -05:00
Laura Pacilio 168c2885e3 Fix link text 2021-12-08 18:03:26 -05:00
Laura Pacilio 22d80df0ba Fix extra space in link 2021-12-08 18:01:48 -05:00
Laura Pacilio 2edd9f4e10 Update broken links 2021-12-08 17:53:18 -05:00
Martin Atkins 533a29edee website: Shorter heading for the nullable = false variable argument
This makes it match some incoming links we have elsewhere, but also it
makes the heading a bit more consice because "module" isn't really adding
anything here anyway: input variables are _always_ in modules.
2021-12-08 14:08:42 -08:00
Martin Atkins f95dcfe90a website: Fix link from remote backend page to the terraform.workspace docs 2021-12-08 14:08:42 -08:00
Martin Atkins 2cef923495 website: Correct navbar link to the "Refactoring" page
We late-reorganized this into the "Module Development" subsection, but
forgot to update the actual link in the navbar, so it was still linking
to its old location.
2021-12-08 14:08:42 -08:00
Chris Arcand 81136ce5e1
Merge pull request #30102 from hashicorp/tfc-integration-docs-again
Add Terraform Cloud integration docs
2021-12-08 13:20:20 -06:00
Laura Pacilio 70740e9493 Add tutorial to moving resources page 2021-12-08 14:13:47 -05:00
Laura Pacilio 91755d380f udpate to migrating page 2021-12-08 14:01:58 -05:00
Laura Pacilio 0bd3491ef8 Fix typo and update note 2021-12-08 13:55:45 -05:00
Laura Pacilio d0cb88f091 Updates to TFC page in Language 2021-12-08 13:49:58 -05:00
Laura Pacilio ab23ecb210 Change "see" to "refer to" 2021-12-08 13:47:42 -05:00
Laura Pacilio 829e9b4842 Update settings page 2021-12-08 13:45:14 -05:00
Laura Pacilio 502ec81ae2 Update initializing page 2021-12-08 13:37:22 -05:00
Laura Pacilio c713815e33 Add learn callout to usiing TFC index page 2021-12-08 13:09:12 -05:00
Laura Pacilio c17317ded4
Update website/docs/cli/cloud/index.html.md
Co-authored-by: Judith Malnick <judith.patudith@gmail.com>
2021-12-08 13:05:24 -05:00
Judith Malnick d82211ad7b
Keep version note, include introduction and enterprise versioning 2021-12-08 09:49:12 -08:00
Judith Malnick 29b71d873f
Correct bullet
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-12-08 09:48:23 -08:00
Judith Malnick 57cc74ddc4
Correct bullet and break up sentence
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-12-08 09:48:01 -08:00
Judith Malnick 57a27cd1dc
Add intro text to migrating section
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-12-08 09:46:47 -08:00
Judith Malnick 5897c9590c
Clarify background on unique names in TFC 2021-12-08 09:45:18 -08:00
Judith Malnick 310368d464
Move version info to one note 2021-12-08 09:44:32 -08:00
Judith Malnick f514f8eb30
Apply suggestions from code review
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-12-08 09:43:18 -08:00
Martin Atkins 5090462001 website: Terraform v1.1 upgrade guide
Since this is only a minor release there isn't any super-significant
upgrade guide content this time, but I've used this page to elaborate on
some of the upgrade notes already recorded in the Terraform Changelog, to
give additional context if needed to the hopefully-small number of users
that these changes will directly effect during upgrading.
2021-12-08 09:22:34 -08:00
Chris Arcand 099c7269e4 Add Terraform Cloud integration docs 2021-12-07 16:41:48 -06:00
Chris Arcand b80e98ab47 Misc doc edits referencing state/settings 2021-12-07 16:29:51 -06:00
Chris Arcand f521ba6cd7 Remove 'enhanced' backend type distinction
As explained in the changes: The 'enhanced' backend terminology, which
only truly pertains to the 'remote' backend with a single API (Terraform
Cloud/Enterprise's), has been found to be a confusing vestige which need
only be explained in the context of the 'remote' backend.

These changes reorient the explanation(s) of backends to pertain more
directly to their primary purpose, which is storage of state snapshots
(and not implementing operations).

That Terraform operations are still _implemented_ by the literal
`Backend` and `Enhanced` interfaces is inconsequential a user of
Terraform, an internal detail.
2021-12-07 16:29:51 -06:00
Laura Pacilio 529a2c34df Update note and add learn call out 2021-12-07 17:09:13 -05:00
Laura Pacilio fc7358611c
Merge pull request #29931 from alekssaul/patch-1
Website/Docs: debian install - run apt update first
2021-12-06 11:06:13 -05:00
Aleks Saul 4f634bf8db Website/Docs: debian install - run apt update first
Apologies for not creating an issue first but it seemed like a simple docs change. 

`apt install terraform` requires the  `apt update` before terraform can be installed.
2021-12-06 08:02:40 -05:00
Ted Behling 16800d1305
Merge pull request #30046 from hashicorp/tbehling/docs-apt-repos
Docs: Add newer Debian & Ubuntu versions to repo list
2021-12-03 12:19:43 -05:00
Axel Neergaard 7756023564
Docs: Change misspelling of variable in documentation
The variable example for `.tfvars` include a spelling error making the `terraform` and `hcl` examples mismatch.
2021-12-03 18:02:31 +01:00
Laura Pacilio 01dbfd2d30
Merge pull request #30028 from multani/patch-1
Improve `.terraformignore` doc formatting
2021-12-03 11:06:32 -05:00
Ted Behling 6a454f11a7 Add newer Debian & Ubuntu versions to repo list
The HashiCorp APT server supports several distro releases that were not in this list,
leading to a false impression that they aren't supported.

Note, Ubuntu has a new release twice a year, so periodic maintenance
is needed here.
2021-11-29 17:03:58 -05:00
Daniel Murphy fba26b10ee
Fix example for values-representation in docs for JSON Format internals
The `root_module.resources[].sensitive_values` key in the example output was incorrectly named and clashed with the regular `root_module.resources[].values` key.
2021-11-26 16:57:48 +00:00
Jonathan Ballet ecc8bcfe5b
Improve `.terraformignore` doc formatting
This helps to distinguish what is a `/` (as a directory separator)
from a "/" (as in "his/her").
2021-11-25 16:35:03 +01:00
Dylan Staley 0e48f58688 Revert "migrate docs to mdx"
This reverts commit 3cb12b5a52.
2021-11-22 15:57:25 -08:00
Dylan Staley 3cb12b5a52 migrate docs to mdx 2021-11-22 15:47:36 -08:00
Tom Harvey 890cabe442
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:39 +01:00
Tom Harvey b3645068ef
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:35 +01:00
Tom Harvey d81e93cc7d
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:27:05 +01:00
Tom Harvey d5404b6f33
Update website/docs/language/settings/backends/azurerm.html.md
Co-authored-by: Tom Bamford <tbamford@hashicorp.com>
2021-11-17 20:26:58 +01:00
tombuildsstuff 1d9f7f19fc website: updating the docs for the Azure backend to highlight the `use_microsoft_graph` field 2021-11-17 18:54:02 +01:00
Laura Pacilio 7e41803418
Merge pull request #29891 from hashicorp/update-for-each-example
Add cidr block output example to setproduct function page
2021-11-15 11:17:27 -05:00
Laura Pacilio bd64d07e6b Apply suggestions from code review 2021-11-15 10:49:37 -05:00
Krista LaFentres a62cff939e Update documentation for state mv command to clarify use of backup and backup-out options 2021-11-09 13:09:36 -06:00
Laura Pacilio b838a93023 Add cidr block output example to setproduct function page 2021-11-05 10:51:59 -04:00
AJ Jordan 8367c049c8
Fix typo in 0.13 upgrade guide 2021-11-04 16:19:35 -04:00
xiaozhu36 e0a2716601 backend/oss: Removes the ConflictWith tag which on the attributes assume_role* to fix the incompatible error 2021-11-03 11:17:35 +08:00
James Bardin 834f61cd54
Merge pull request #29841 from xiaozhu36/xiaozhu
backend/oss: Supports the new attribute sts_endpoint
2021-11-01 15:31:51 -04:00
James Bardin 8b53637230
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:51 -04:00
James Bardin 4f88445d05
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:43 -04:00
James Bardin 2195d7a45f
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:32 -04:00
James Bardin 46bbe66cd0
Update website/docs/language/values/variables.html.md
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 15:17:21 -04:00
James Bardin 03ed766454 nullable doc update 2021-11-01 14:30:25 -04:00
James Bardin 6a1afd2dc3 nullable variable docs
Add `nullable` to the variable documentation.
Remove "module" from the "null means omission" part of the null type
documentation.
2021-11-01 13:25:25 -04:00
Martin Atkins 14a8668486 website: "Refactoring" documentation firmer advice about removing moved blocks
Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-11-01 08:47:17 -07:00
Martin Atkins 86e5aacacd website: Documentation about "moved" blocks
This is documentation for the first set of refactoring-related features,
all based on the new "moved" blocks in the Terraform language.

I've named the documentation section "refactoring" because in previous
discussions with users that seems to be the term they use to describe the
underlying need.

"moved" blocks are our first language feature intended to meet that need,
although it probably won't be the last as we consider other requirements
in later releases. My intent here is that once we've published this it
should eventually end up being the first result for a web search for the
topic of Terraform refactoring.
2021-11-01 08:47:17 -07:00
xiaozhu36 5d19a34f88 backend/oss: Supports the new attribute sts_endpoint 2021-11-01 22:52:45 +08:00
James Bardin 2ebdc099ac
Merge pull request #29307 from hayorov/main
Flatten `assume_role` block for OSS backend
2021-11-01 09:18:25 -04:00
Laura Pacilio 0ef4fe0aab
Merge pull request #29691 from ramj9/patch-1
replace an with a
2021-10-26 09:49:46 -04:00
Krista LaFentres 1f08f7dba8 Clarify the way the trim() function works and add some more examples 2021-10-25 14:13:15 -05:00
Martin Atkins 5b266dd5ca command: Remove the experimental "terraform add" command
We introduced this experiment to gather feedback, and the feedback we saw
led to us deciding to do another round of design work before we move
forward with something to meet this use-case.

In addition to being experimental, this has only been included in alpha
releases so far, and so on both counts it is not protected by the
Terraform v1.0 Compatibility Promises.
2021-10-20 06:42:47 -07:00
Alex Khaerov 14f366dbf4
Update documentation 2021-10-18 12:54:40 +08:00