Add a two-part Terraform starter guide #44834

ptgott · 2024-07-30T16:56:29Z

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.

github-actions · 2024-07-30T16:56:56Z

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 changelog: followed by the changelog entries for the PR.

github-actions · 2024-07-30T16:57:19Z

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 changelog: followed by the changelog entries for the PR.

github-actions · 2024-07-30T17:06:45Z

🤖 Vercel preview here: https://docs-fggtisa8u-goteleport.vercel.app/docs/ver/preview

github-actions · 2024-07-30T18:16:52Z

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 changelog: followed by the changelog entries for the PR.

github-actions · 2024-07-30T18:27:03Z

🤖 Vercel preview here: https://docs-mwdrvwpie-goteleport.vercel.app/docs/ver/preview

github-actions · 2024-07-31T21:04:32Z

🤖 Vercel preview here: https://docs-915b9z298-goteleport.vercel.app/docs/ver/preview

github-actions · 2024-08-01T14:35:54Z

🤖 Vercel preview here: https://docs-kvlytfpw1-goteleport.vercel.app/docs/ver/preview

ptgott · 2024-08-01T19:28:52Z

@mmcallister Just putting this on your radar for when you have time to take a look. Thanks!

mmcallister

Looks great!

docs/pages/management/infrastructure-as-code/terraform-starter.mdx

docs/pages/management/infrastructure-as-code/terraform-starter/enroll-resources.mdx

docs/pages/management/infrastructure-as-code/terraform-starter/rbac.mdx

ptgott · 2024-08-05T15:46:36Z

Feedback item TODOs:

Update the Agent guide diagram to not use the old logo (comment)
Accommodate Document the multiple Terraform provider setups #44954 (comment)
Fix agentless SSH server instructions (comment)
Fix Kubernetes Service instructions (comment)
Better accommodate the fact that the provider doesn't support Windows desktops and Kubernetes clusters (comment)

For the bottom three bullets, consider editing Part One to only explain how to enroll servers, mentioning the ability to enroll other resource kinds (and limitations for enrolling those resource kinds) in a "Further reading" section.

bernardjkim

Looks good to me. Just some terraform fmt indentation.

docs/pages/admin-guides/infrastructure-as-code/terraform-starter/enroll-resources.mdx

docs/pages/admin-guides/infrastructure-as-code/terraform-starter/rbac.mdx

github-actions · 2024-09-04T13:20:26Z

🤖 Vercel preview here: https://docs-ms5r5qqln-goteleport.vercel.app/docs/ver/preview

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.

github-actions · 2024-09-04T18:11:47Z

🤖 Vercel preview here: https://docs-p5157bcil-goteleport.vercel.app/docs/ver/preview

github-actions · 2024-09-04T20:19:15Z

🤖 Vercel preview here: https://docs-enh8mjc2h-goteleport.vercel.app/docs/ver/preview

public-teleport-github-review-bot · 2024-09-04T20:32:19Z

@ptgott See the table below for backport results.

Branch	Result
branch/v16	Create PR

ptgott temporarily deployed to vercel July 30, 2024 16:56 — with GitHub Actions Inactive

ptgott added the backport/branch/v16 label Jul 30, 2024

github-actions bot requested review from EdwardDowling, mmcallister, r0mant, ryanclark, xinding33 and zmb3 July 30, 2024 16:56

github-actions bot added documentation size/lg labels Jul 30, 2024

ptgott requested a review from stevenGravy July 30, 2024 17:21

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from 42593e8 to 61b7270 Compare July 30, 2024 18:16

ptgott temporarily deployed to vercel July 30, 2024 18:16 — with GitHub Actions Inactive

ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Jul 30, 2024

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from 61b7270 to 7e9add5 Compare July 31, 2024 20:54

ptgott temporarily deployed to vercel July 31, 2024 20:54 — with GitHub Actions Inactive

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from 7e9add5 to b866fc7 Compare August 1, 2024 14:25

ptgott temporarily deployed to vercel August 1, 2024 14:25 — with GitHub Actions Inactive

mmcallister approved these changes Aug 1, 2024

View reviewed changes

hugoShaka reviewed Aug 2, 2024

View reviewed changes

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from 5099436 to ec58c89 Compare August 6, 2024 19:19

hugoShaka approved these changes Sep 3, 2024

View reviewed changes

ptgott requested a review from bernardjkim September 3, 2024 20:54

bernardjkim approved these changes Sep 3, 2024

View reviewed changes

public-teleport-github-review-bot bot removed request for r0mant, zmb3, ryanclark, EdwardDowling, xinding33 and stevenGravy September 3, 2024 21:27

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from cb35ffb to 30938bb Compare September 4, 2024 13:09

ptgott enabled auto-merge September 4, 2024 13:09

ptgott temporarily deployed to vercel September 4, 2024 13:09 — with GitHub Actions Inactive

ptgott added 4 commits September 4, 2024 14:01

Respond to thedevelopnik feedback

c7c7f48

Note that you can skip the SSO step in the RBAC guide. Include links to relevant docs.

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from 30938bb to e2f89e5 Compare September 4, 2024 18:01

ptgott temporarily deployed to vercel September 4, 2024 18:01 — with GitHub Actions Inactive

Respond to bernardjkim feedback

a6888b2

ptgott force-pushed the paul.gottschling/2024-07-tf-rbac branch from e2f89e5 to a6888b2 Compare September 4, 2024 20:08

ptgott temporarily deployed to vercel September 4, 2024 20:08 — with GitHub Actions Inactive

ptgott added this pull request to the merge queue Sep 4, 2024

Merged via the queue into master with commit a513a50 Sep 4, 2024
42 checks passed

ptgott deleted the paul.gottschling/2024-07-tf-rbac branch September 4, 2024 20:31

ptgott mentioned this pull request Sep 4, 2024

[v16] Add a two-part Terraform starter guide #46260

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a two-part Terraform starter guide #44834

Add a two-part Terraform starter guide #44834

ptgott commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Aug 1, 2024

ptgott commented Aug 1, 2024

mmcallister left a comment

ptgott commented Aug 5, 2024 •

edited

Loading

bernardjkim left a comment

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

public-teleport-github-review-bot bot commented Sep 4, 2024

Add a two-part Terraform starter guide #44834

Add a two-part Terraform starter guide #44834

Conversation

ptgott commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 30, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Aug 1, 2024

ptgott commented Aug 1, 2024

mmcallister left a comment

Choose a reason for hiding this comment

ptgott commented Aug 5, 2024 • edited Loading

bernardjkim left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

public-teleport-github-review-bot bot commented Sep 4, 2024

ptgott commented Aug 5, 2024 •

edited

Loading