Commit Graph

58 Commits

Author SHA1 Message Date
Dylan Staley
21cbb5b392 migrate docs to mdx 2021-12-14 18:41:17 -08: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
f95dcfe90a website: Fix link from remote backend page to the terraform.workspace docs 2021-12-08 14:08:42 -08:00
Laura Pacilio
0bd3491ef8 Fix typo and update note 2021-12-08 13:55:45 -05:00
Judith Malnick
d82211ad7b Keep version note, include introduction and enterprise versioning 2021-12-08 09:49:12 -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
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
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
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
xiaozhu36
5d19a34f88 backend/oss: Supports the new attribute sts_endpoint 2021-11-01 22:52:45 +08:00
Alex Khaerov
14f366dbf4 Update documentation 2021-10-18 12:54:40 +08:00
Alex Khaerov
de8810cdd9 Merge branch 'hashicorp:main' into main 2021-10-18 11:42:37 +08:00
Laura Pacilio
dcf2d3c1ef Merge pull request #29494 from magnetikonline/docs-s3-backend-dynamodb-partition-key
S3 backend documentation update - DynamoDB uses Partition keys, not primary keys - redux
2021-09-13 10:39:02 -04:00
Laura Pacilio
48768a0037 Merge pull request #29451 from kmadof/patch-1
Added required paramter `resource_group_name` for MSI
2021-09-09 14:54:17 -04:00
Peter Mescalchin
f238e9395a Quality of life: updated all AWS document links to https:// 2021-09-01 14:02:28 +10:00
Peter Mescalchin
110d482033 Update S3 backend documentation - DynamoDB uses Partition keys, not primary keys 2021-09-01 13:59:08 +10:00
Laura Pacilio
daad109067 Merge pull request #29063 from moskyb/s3-backend-kms-permissioning-note
Add a note to the docs on the S3 backend around permissions needed for encrypted state storage
2021-08-25 10:14:12 -04:00
Krzysztof Madej
49b31d005a Added required paramter resource_group_name for MSI
Without `resource_group_name` I had

> │ Error: Either an Access Key / SAS Token or the Resource Group for the Storage Account must be specified - or Azure AD Authentication must be enabled
2021-08-24 02:05:43 +02:00
Laura Pacilio
c1d16c7421 Merge pull request #29311 from NargiT/patch-1
fix syntax
2021-08-23 14:00:43 -04:00
moajo
b3e1a40499 Update website/docs/language/settings/backends/s3.html.md 2021-08-12 15:17:04 +09:00
Tigran Tch
0103f58297 fix syntax 2021-08-05 17:04:40 +02:00
Top
21a5103551 Update swift.html.md
Add note for Swauth v1.0 support
2021-08-05 08:32:40 +10:00
Alex Khaerov
9d5f1752c8 oss backend: flattern assume_role block 2021-08-03 14:26:15 +08:00
Laura Pacilio
b9c0cbb1fd Merge pull request #29117 from hashicorp/description-metadata-language-docs
Description metadata -  language docs
2021-07-21 16:30:05 -04:00
James Bardin
570b70b02f Merge pull request #28078 from jasons42/configure-etcdv3-client-max-request-size
Expose etcd client MaxCallSendMsgSize config
2021-07-20 15:49:14 -04:00
Jason Smith
5ff9b7626b Fix broken link
Fix website-link-check failing as https://coreos.com/etcd/ 301's to https://etcd.io/. Updated link to https://etcd.io/.
2021-07-20 14:04:49 -05:00
Jason Smith
162f853841 Document max_request_bytes config 2021-07-20 14:04:47 -05:00
Laura Pacilio
a780f625e9 Fix metadata description format on all pages 2021-07-19 12:11:10 -04:00
Laura Pacilio
b6b4340214 Add detail to backend overview page metadata 2021-07-16 17:08:24 -04:00
Rémi Lapeyre
4177bd98b9 Change wording for the skip_... options of the pg backend 2021-07-14 12:01:54 +02:00
Laura Pacilio
69ebfd6f03 Add/update description metadata on backend and state overview pages 2021-07-09 15:56:12 -04:00
Ben Moskovitz
21228e19df Fix broken links as pointed out by CI
See: https://app.circleci.com/pipelines/github/hashicorp/terraform/6853/workflows/cc37def1-6bf5-4f6c-89b1-10dfcc65ea5e/jobs/44887
2021-06-30 16:55:00 +12:00
Ben Moskovitz
d29cdccb5b Add a note to the docs on the S3 backend around permissions needed for encrypted state storage 2021-06-30 16:45:17 +12: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
James Bardin
51a171c7f4 pg requires PostgreSQL 10 2021-05-18 09:39:05 -04:00
Martin Atkins
0aa0e00fdc website: Backend docs link to new .gitignore anchor
The Git book seems to be using a different anchor format now, and so this
link was previously effectively linking to the page as a whole rather
than to the specific section we're trying to refer to.
2021-05-12 09:27:37 -07:00
Martin Atkins
874f1abb2b cli+website: -ignore-remote-version docs and other cleanup
We previously had only very short descriptions of what
-ignore-remote-version does due to having the documentation for it inline
on many different command pages and -help output.

Instead, we'll now centralize the documentation about this argument on
the remote backend page, and link to it or refer to it from all other
locations. This then allows us to spend more words on discussing what
Terraform normally does _without_ this option and warning about the
consequences of using it.

This continues earlier precedent for some local-backend-specific options
which we also don't recommend for typical use. While this does make these
options a little more "buried" than before, that feels justified given
that they are all "exceptional use only" sort of options where users ought
to learn about various caveats before using them.

While there I also took this opportunity to fix some earlier omissions
with the local-backend-specific options and a few other minor consistency
tweaks.
2021-05-12 09:27:37 -07:00
John Houston
fabdf0bea1 Add config_paths and drop KUBECONFIG env variable in kubernetes backend (#26997) 2021-04-20 10:05:45 -04:00
Matthew Frahry
15779013da backend/azurerm: Bug fixes and updated dependencies #28181 2021-03-26 14:07:56 -07:00
Martin Atkins
6f35c2847b command: Reorganize docs of the local backend's legacy CLI options
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.
2021-03-25 13:56:48 -07:00