[v16] Add a two-part Terraform starter guide #46260
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes #41055 Add a learning series for users who wants to get started with managing Teleport resources using Terraform. The guide takes the user through some fundamental cluster setup tasks: deploying Agents, enrolling resources, adding labels, configuring roles, and setting up SSO. The series includes two guides: - Part One: Enrolling resources - Part Two: Configuring RBAC Part One of the series is based on the "Deploy Agents with Terraform" guide. This change adds instructions to the guide to label infrastructure resources so the user can access those resources with the roles configured in Part Two. Other changes: - Rename `agent-pool-terraform` to `terraform-starter`. - Rename the "Dynamic Resources" guide to be more explicitly about Infrastructure as Code. Organize this section into subsections to make room for the new starter guide. - Edit the Further Reading discussion in Part One. Move the static resource discussion to Further Reading because, otherwise, there is too much explanatory text between instructions. Also mention auto-discovery.
- Fix link syntax. - Set expectations that the child modules downloaded in the two guides are examples. - Remove diagram with outdated logo. - Use purpose-oriented names for TF files instead of `main.tf` - Use `tctl terraform env` to get credentials
Responds to hugoShaka feedback. Resources that are not SSH servers registered via the SSH Service have some complexities that don't make sense to cover in this guide. Instead, for simplicity, the guide has the user deploy SSH Service instances, then includes the possibility of enrolling other kinds of resources in a "Next steps" section. Changes: - Remove the `agent_roles` input in the `terraform-starter/agent-installation` module. - Only deploy a token for the Node role, and configure the Agents deployed by the module to only enable the SSH Service. - Add an agent_labels input to the `agent-installation` module. - Move non-server deployment instructions to "Next steps".
Note that you can skip the SSO step in the RBAC guide. Include links to relevant docs.
ptgott
added
the
no-changelog
github-actions
bot
requested review from
bernardjkim,
hugoShaka,
mmcallister and
thedevelopnik
|
🤖 Vercel preview here: https://docs-qarucg2dj-goteleport.vercel.app/docs/ver/preview |
hugoShaka
approved these changes
Sep 4, 2024
bernardjkim
approved these changes
Sep 5, 2024
|
Hi @mmcallister, would you have time to give this one a look? Thanks! |
mmcallister
approved these changes
Sep 5, 2024
public-teleport-github-review-bot
bot
removed the request for review
from thedevelopnik
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport #44834 to branch/v16