Commit Graph

185 Commits

Author SHA1 Message Date
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 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
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
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 0ef4fe0aab
Merge pull request #29691 from ramj9/patch-1
replace an with a
2021-10-26 09:49:46 -04: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
Alisdair McDiarmid b9f3dab035 json-output: Release format version 1.0 2021-10-06 11:13:06 -04:00
Ram 45dab1b956
replace an with a 2021-10-02 17:15:51 +08:00
Alisdair McDiarmid cd29c3e5fd
Revert "json-output: Release format version 1.0" 2021-09-09 11:25:35 -04:00
Alisdair McDiarmid b60f201eed json-output: Release format version 1.0 2021-09-01 15:15:18 -04:00
Martin Atkins 43d753e727 command: "terraform add" is experimental
We're aware of several quirks of this command's current design, which
result from some existing architectural limitations that we can't address
immediately.

However, we do still want to make this command available in its current
capacity as an incremental improvement, so as a compromise we'll document
it as experimental. Our intent here is to exclude it from the
Terraform 1.0 Compatibility Promises so that we can have the space to
continue to improve the design as other parts of the overall Terraform
system gain new capabilities.

We don't currently have any concrete plan for this command to be
stabilized and subject to compatibility promises. That decision will
follow from ongoing discussions with other teams whose systems may need to
change in order to support the final design of "terraform add".
2021-08-19 09:27:30 -07:00
Laura Pacilio 9dde62ef5d
Merge pull request #29257 from robe007/patch-1
Remove repeated word 'the' in some lines.
2021-08-18 18:15:09 -04:00
Laura Pacilio 5b07bb7040
Merge pull request #29216 from hashicorp/laura-description-metadata-cli
Laura description metadata cli
2021-07-30 14:49:36 -04:00
Laura Pacilio 31af9adc00 Make all sentences start with caps + additional tweak wording edits 2021-07-30 14:44:17 -04:00
Laura Pacilio 845470617d Address PR comments for manipulating state index 2021-07-30 14:25:01 -04:00
Laura Pacilio 2034c17948 Address PR comments on inspect index page 2021-07-30 14:22:16 -04:00
Laura Pacilio 0abd79c9b4 Address PR comments on workspace command index page 2021-07-30 14:19:14 -04:00
Laura Pacilio 18a3143495 Address PR comments for init page 2021-07-30 14:15:46 -04:00
Laura Pacilio e94bf7bc16 Address PR comments for cli index page 2021-07-30 14:13:04 -04:00
Laura Pacilio 342335003d
Update website/docs/cli/commands/import.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:10:32 -04:00
Laura Pacilio 507ad21a91
Update website/docs/cli/import/index.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:05:06 -04:00
Laura Pacilio fb6ff1f440
Update website/docs/cli/state/inspect.html.md
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-07-30 14:04:39 -04:00
Laura Pacilio f2552e502a Update metadata on graph command page 2021-07-30 11:21:10 -04:00
Laura Pacilio 58bc29b61b update metadata on get command page 2021-07-30 11:19:44 -04:00
Laura Pacilio fef4ccb795 Update metadta on force-unlock command page 2021-07-30 11:18:58 -04:00
Laura Pacilio e326a7b1a5 Update metadata on providers command page 2021-07-30 11:17:17 -04:00
Laura Pacilio 7105ed7a1e Update metadata on version command page 2021-07-30 11:16:08 -04:00
Laura Pacilio 5a6d2e42ef Update metadata on init command page 2021-07-30 11:14:37 -04:00
Laura Pacilio 2ba0dcb8c8 Update metadata on provisioning infrastructure index page 2021-07-30 11:08:48 -04:00
Laura Pacilio 9903913797 Remove back ticks from run index page 2021-07-30 11:08:02 -04:00
Laura Pacilio 5387f248c9 Remove back ticks from workspace index page 2021-07-30 11:06:00 -04:00
Laura Pacilio 99cc8c02c6 Remove back ticks from plan command page 2021-07-30 11:05:19 -04:00
Laura Pacilio a5e98df339 Remove back ticks from CLI commands index page 2021-07-30 11:04:30 -04:00
Laura Pacilio 1419315f3a Remove back ticks from terraform import page 2021-07-30 11:03:03 -04:00
Laura Pacilio 294a1fdd2c Remove back ticks from terraform fmt page 2021-07-30 11:02:31 -04:00
Laura Pacilio 706611e2c8 Remove back ticks from env command page 2021-07-30 11:02:03 -04:00
Laura Pacilio 661b7703ea Remove back ticks from destroy command page 2021-07-30 11:01:28 -04:00
Laura Pacilio d081fe41a4 Remove back ticks from console command page 2021-07-30 11:01:00 -04:00
Laura Pacilio e7a8595e1d Remove back ticks from apply command page 2021-07-30 11:00:23 -04:00
Laura Pacilio 4e40ce13db Remove back ticks from auth index page 2021-07-30 10:59:45 -04:00
robe007 880f846f43
Remove repeated word 'the' in some lines. 2021-07-28 07:40:07 -06:00
Neeraj Kumar 6b0be752bf
Updated line width 2021-07-24 06:58:04 +05:30
Neeraj Kumar 21136cf2fe
Conciseness and fixed some typos in apt.html.md
As discussed with Laura, submitting this PR.
2021-07-24 06:54:44 +05:30
Laura Pacilio f590c0f5bc Update metadata for fmt command 2021-07-23 16:35:07 -04:00
Laura Pacilio 5046e38228 Update metadata for env command 2021-07-23 16:33:37 -04:00
Laura Pacilio 027dbe40cd Update metadata for console command 2021-07-23 16:31:43 -04:00
Laura Pacilio ae2ff87598 Updates to page metadata for plan, apply, import, and destroy 2021-07-23 16:30:11 -04:00
Laura Pacilio dc0dd75b60 Update description metadata for import command 2021-07-23 16:28:11 -04:00
Laura Pacilio 2233ef1782 Update description metadata for apply command 2021-07-23 16:26:29 -04:00
Laura Pacilio f0796733c7 Update page metadata for plan command 2021-07-23 16:23:52 -04:00
Laura Pacilio 8141af7632 Update description medata on plugin signing page 2021-07-23 16:17:47 -04:00
Laura Pacilio 18b7b4012c Add metadata description to cli configuration file page 2021-07-23 16:15:14 -04:00
Laura Pacilio 03e1818c74 Add description to environment variables page 2021-07-23 16:10:12 -04:00
Laura Pacilio 5399376263 Add description to cli configuration overview page 2021-07-23 16:06:43 -04:00
Laura Pacilio 749d5ce98f Add metadata to managing plugins overview page 2021-07-23 16:04:12 -04:00
Laura Pacilio 2ef32997ab Add metadata to workspace subcommand overview page 2021-07-23 15:57:48 -04:00
Laura Pacilio e432d85c5c Add description metadata to managing workspaces overview page 2021-07-23 15:55:23 -04:00
Laura Pacilio 585b609fff Add page metadata to state recovery page 2021-07-23 15:47:49 -04:00
Laura Pacilio a8ffd119aa Add page metadata to moving resources overview 2021-07-23 14:53:20 -04:00
Laura Pacilio 46b56f4540 Add page metadata to taint overview page 2021-07-23 14:44:21 -04:00
Laura Pacilio d41ee62785 update state overview page metadata 2021-07-23 14:43:55 -04:00
Laura Pacilio 72181dfc1c Add description metadata to inspecting state overview page 2021-07-23 14:38:23 -04:00
Laura Pacilio 733655ef03 Add description metadata to manipulating state overview page 2021-07-23 14:30:01 -04:00
Laura Pacilio a8b8f4c103 Update metadata on import overview page 2021-07-23 14:25:58 -04:00
Laura Pacilio b37eab6151 Update metadata on inspecting infrastructure home page 2021-07-23 14:21:14 -04:00
Neeraj Kumar 2b3d6f9929
Minor typo in apt.html.md
As part of this PR, just wanted to have this typo fixed to have a better sense of the sentence.

`apt-add-repository` usually automatically runs `apt update` as part of its work in order to fetch the new package indices, but if it does not, then you will need to do so manually before the packages will be available.


Also, I wanted to rephrase the sentence as below(less wording and more clarity- let me know if this is okay and I can raise a new pull request):


`apt-add-repository` usually automatically runs `apt update` as part of its work to fetch the new package indices, but if it does not, you will need to manually do so before the packages will be available.
2021-07-23 08:13:39 +05:30
Laura Pacilio f465294ddd Add metadata to Inspecting Infrastructure overview page 2021-07-21 17:42:57 -04:00
Laura Pacilio 6f7056ea83 Add metadata to Writing and Modifying Code overview page 2021-07-21 17:37:54 -04:00
Laura Pacilio 5f0a4a080d Add metadata to provisioning infrastructure overview page 2021-07-21 17:35:13 -04:00
Laura Pacilio 1243ae832e Add metadata to authentication overview page 2021-07-21 17:29:25 -04:00
Laura Pacilio 1c2559f7f1 Add metadata to initializing working directories overview page 2021-07-21 17:25:15 -04:00
Laura Pacilio b18298cdc4 Add metadata to basic cli features page 2021-07-21 17:21:25 -04:00
Laura Pacilio 591bc1e1d9 Add metadata to CLI overview page 2021-07-21 17:15:02 -04:00
James Bardin 15f99bc445
Merge pull request #29081 from amccaskill/patch-1
error_count
2021-07-21 10:15:36 -04:00
Kristin Laemmert 563f1436eb
various docs updates (#29018)
* website/docs: add sensitivity warning to output documentation

fixes #28005

* website/docs: add note about ** to fileset documentation

closes #24220

* website/docs: add note that `dynamic` expressions aren't included in json config output

closes #28346

* website: the provider installer isn't necessarily concurrency safe

closes #28367
2021-07-15 12:22:17 -04:00
Russell Rollins 3174dfd63f Adds anchor for TF_CLI_ARGS. 2021-07-14 14:08:52 -04:00
Nick Fagerlund 0e004f2377
website: remove legacy provider docs index (#29134)
* website: Update or remove references to legacy provider docs

We've finally evicted the last of the legacy provider docs from terraform.io!
Let's celebrate by purging all memory of them.

The 0.11 docs are now so thoroughly legacy that I don't believe they need a new
destination for their provider links, so I just removed those.

* website: remove old provider docs index

This will require a redirect in the terraform-website repo.

* Apply suggestions from code review

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>

Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com>
2021-07-09 14:44:58 -07:00
ritsok 595646916f Link refresh tutorial from plan and refresh docs pages 2021-07-06 15:52:16 -04:00
Adrian 54a09b059f
error_count
# shouldn't it be true if the error count is zero

error_count (number): A zero or positive whole number giving the count of errors Terraform detected. If valid is 'true' then error_count will always be zero, because it is the presence of errors that indicates that a configuration is invalid.
2021-07-01 19:22:13 -04:00
Laura Pacilio a7e24c384b
Merge pull request #28842 from iaoiui/patch-1
remove extra "be"
2021-06-30 08:52:51 -04:00
Laura Pacilio f9ec36383d
Merge pull request #29011 from vlad-ro/patch-1
Add back missing closing quote character
2021-06-30 08:51:47 -04:00
Martin Atkins a945b379d8 website: Explicit examples of -var escaping in various shells
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.
2021-06-22 14:10:04 -07:00
Vlad Romanenko d4d56a96b1
Add back missing closing quote character 2021-06-22 15:20:31 +01:00
Radek Simko bb868606ea
docs: Document naming conventions for templates & backend configs (#28924)
* docs: Document naming conventions for templates & backend configs

* Update website/docs/cli/config/config-file.html.md

Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>

* Update website/docs/language/functions/templatefile.html.md

Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>

Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>
2021-06-18 17:20:00 +01:00
Kristin Laemmert 583859e510
commands: `terraform add` (#28874)
* command: new command, terraform add, generates resource templates

terraform add ADDRESS generates a resource configuration template with all required (and optionally optional) attributes set to null. This can optionally also pre-populate nonsesitive attributes with values from an existing resource of the same type in state (sensitive vals will be populated with null and a comment indicating sensitivity)

* website: terraform add documentation
2021-06-17 12:08:37 -04:00
Judith Malnick 044c439dbc
Gloss of top docs pages (#28891)
* 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: Tu Nguyen <im2nguyen@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2021-06-08 06:58:55 -07:00
iaoiui 176cfad1dd
remove extra "be" 2021-05-29 15:51:33 +09:00
Martin Atkins abf7f3416b website: "taint" command is deprecated from v0.15.2, not from v1.0.0
We got the replacement for this in earlier than anticipated, so these docs
were originally more pessimistic about when the alternative would be
available.
2021-05-26 10:16:38 -07:00
Martin Atkins 6d80088f51 website: More accurate release versions for new plan options
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.
2021-05-26 09:19:33 -07:00
Alisdair McDiarmid f9fc47c22e website: Add documentation for machine readable UI
Terraform 0.15.3 added support for a `-json` flag to the plan, apply,
and refresh commands, which renders the Terraform UI output in a
structured machine readable format. This commit adds documentation for
this interface.
2021-05-25 16:01:32 -04:00
Matthew Sanabria 1c3f4fe80f
Add examples to `terraform console` command (#28773)
These examples showcase come use cases for `terraform console`.
2021-05-25 10:06:23 -04:00
Matthew Sanabria a63ac81d0c
Example plugin location using XDG Base Directory (#28711)
The current documention was unclear about the full path of local mirrors
when using the XDG Base Directory Specification.

Also removed the trailing slashes for the other paths in this section.
2021-05-25 10:06:07 -04:00
Karol Szczepański f684f91f3f
website/docs(plan): fix minor typos (#28713) 2021-05-18 11:05:42 -04:00
James Bardin 1b48636b42 update init docs for -migrate-state 2021-05-17 12:41:54 -04:00
Nick Fagerlund 65f3ddec52 website: Make apply's usage of plan options harder to miss
- I'm using distinct subheaders and smaller paragraphs to try and make the info
  about apply's two modes more skimmable.

- I'm also adding a separate "Plan Options" subheader (and keeping the section
  tiny so it stays snugged up right next to the "Apply Options" one) to make it
  extra-clear that Hey, There's More Options, They're Over There.
2021-05-14 13:26:33 -07:00
Martin Atkins 3c8a4e6e05 command+backend/local: -refresh-only and drift detection
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.
2021-05-13 09:05:06 -07:00
Martin Atkins 42e0985839 command: use -lock=false consistently in -help output
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.
2021-05-12 09:27:37 -07:00
Martin Atkins ed121321c6 website: Revamp the "terraform state mv" page
My original motivation here was to add the previously-missing -dry-run
option to the list of options

However, while in the area I noticed that this command hasn't had a
documentation refresh for a while and so I took the opportunity to update
it to match with our current writing style and terminology used in other
parts of the documentation, and so I've rewritten prose elsewhere on the
page to hopefully give the same information in a way that fits in better
with concepts discussed elsewhere in the documentation, and also to try
to add some additional context to connect this information with what
we've described in other places.

This rewrite also drops the example of moving from one "state file" to
another, because that's a legacy usage pattern that isn't supported when
using remote backends, and we recommend most folks to use remote backends
so it's strange to show an example that therefore won't work for most
people. Rather than adding additional qualifiers to that example I chose
to just remove it altogether, because we've generally been working to
de-emphasize these legacy local backend command line options elsewhere in
the documentation.
2021-05-12 09:27:37 -07:00