Machine ID: Documentation for Terraform Cloud joining#45806
Machine ID: Documentation for Terraform Cloud joining#45806timothyb89 merged 15 commits intomasterfrom
Conversation
|
Looks like #44954 already refactored the docs! I'll adjust here. |
Also added a troubleshooting section
|
🤖 Vercel preview here: https://docs-q6xizadzj-goteleport.vercel.app/docs/ver/preview |
github-actions
Bot
requested review from
mmcallister,
ptgott,
r0mant,
xinding33 and
zmb3
|
In light of #44954 already refactoring the Terraform docs, I'll rework this and probably move it into the Admin Guides / IaC / Terraform section now that we have a nice organizational structure to work with. |
…m-cloud-joining-docs
This moves the Terraform Cloud docs to the new Terraform Provider section, and rewrites some things to account for the new changes in other terraform provider pages, e.g. the new builtin `terraform-provider` role.
|
🤖 Vercel preview here: https://docs-3fjbt4qtm-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-81nnfmqqt-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-oz0awiec9-goteleport.vercel.app/docs/ver/preview |
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
timothyb89
added
the
no-changelog
There was a problem hiding this comment.
I'd pop this into https://goteleport.com/docs/reference/join-methods/ as well for completeness.
There was a problem hiding this comment.
Good catch, missed that reference.
|
|
||
| To start, the Teleport Auth Service needs to be configured to accept join | ||
| requests from Terraform Cloud runs. We'll do this by creating | ||
| [a bot](../../../reference/architecture/machine-id-architecture.mdx#what-is-a-bot) |
There was a problem hiding this comment.
Since this link isn't required to complete Step 1, I would move it to a "Further reading" section or delete it (per the style guide: https://github.com/gravitational/docs/blob/main/docs-contributors/style-guide.md#using-links-admonishments-and-details-in-how-to-guides).
There was a problem hiding this comment.
Fair enough, I'll remove it. The inner workings are mostly irrelevant now that all the Machine ID-y internals are built in to the Terraform Provider.
public-teleport-github-review-bot
Bot
removed request for
mmcallister,
r0mant,
xinding33 and
zmb3
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
|
🤖 Vercel preview here: https://docs-gzntdqkfk-goteleport.vercel.app/docs/ver/preview |
…gravitational/teleport into timothyb89/terraform-cloud-joining-docs
…m-cloud-joining-docs
|
🤖 Vercel preview here: https://docs-dg7bv7402-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-npz4uxgtr-goteleport.vercel.app/docs/ver/preview |
* Machine ID: Documentation for Terraform Cloud joining * Various verbiage changes; include Terraform Enterprise Also added a troubleshooting section * Link to new guide from existing terraform provider page * Move to the new Terraform Provider section This moves the Terraform Cloud docs to the new Terraform Provider section, and rewrites some things to account for the new changes in other terraform provider pages, e.g. the new builtin `terraform-provider` role. * Fix docs lints * Fix more docs lints * Fix docs lints * Fix even more docs lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address review feedback: include in join method reference, add links * Fix codeblock spacing * Fix broken heading link --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Machine ID: Documentation for Terraform Cloud joining (#45806) * Machine ID: Documentation for Terraform Cloud joining * Various verbiage changes; include Terraform Enterprise Also added a troubleshooting section * Link to new guide from existing terraform provider page * Move to the new Terraform Provider section This moves the Terraform Cloud docs to the new Terraform Provider section, and rewrites some things to account for the new changes in other terraform provider pages, e.g. the new builtin `terraform-provider` role. * Fix docs lints * Fix more docs lints * Fix docs lints * Fix even more docs lints * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Address review feedback: include in join method reference, add links * Fix codeblock spacing * Fix broken heading link --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Update Terraform Cloud joining minimum version (#46579) * Update Terraform Cloud joining minimum version This updates the minimum required Teleport version for TF Cloud joining, and adds a note about Enterprise joining being in Preview. * Remove preview note per feedback * Fix example token in the Terraform Cloud joining docs (#46693) The `terraform` provision token field was renamed to `terraform_cloud` and this change was not reflected in the docs. --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
3 participants
This adds documentation for the new
terraform_cloudjoin method.Note: Hold off on merging this until #46051 is merged, as well as the (not yet written) PR to make public Terraform Cloud joining available in OSS.