Document managing users, roles and accesslists through IaC #36622

hugoShaka · 2024-01-12T15:37:37Z

Closes #23097

This PR adds the following pages:

Document the different user types in the reference
Create a common IaC guide creating users and roles for all 3 IaC methods: tctl, terraform, operator
Create a common IaC guide creating Access Lists for all 3 IaC methods

Requires a tctl containing those fixes: #36572

github-actions · 2024-01-12T15:44:51Z

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

github-actions · 2024-01-12T15:54:40Z

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

ptgott · 2024-01-22T20:48:01Z

I owe you a review of this. I'll make time to provide one this week!

r0mant

A few comments but overall lgtm.

docs/config.json

docs/pages/includes/diagnostics/kubernetes-operator-troubleshooting.mdx

docs/pages/management/dynamic-resources/access-list.mdx

docs/pages/reference/user-types.mdx

ptgott

Thanks for this change! We have how-to instructions throughout the docs for creating users and roles with tctl, so it's nice to also have how-to instructions for other client tools as tabbed instructions.

docs/config.json

docs/pages/management/dynamic-resources.mdx

docs/pages/management/dynamic-resources/access-list.mdx

ptgott

Going to review the "User and Role" and "User Types" pages later this week.

docs/pages/management/dynamic-resources/access-list.mdx

docs/pages/management/dynamic-resources/teleport-operator-helm.mdx

docs/pages/management/dynamic-resources/teleport-operator.mdx

ptgott

I'll review the "User Types" guide next week

docs/pages/management/dynamic-resources.mdx

docs/pages/management/dynamic-resources/user-and-role.mdx

docs/pages/reference/user-types.mdx

ptgott · 2024-01-30T22:28:28Z

docs/pages/reference/user-types.mdx

+
+## Local Users
+
+Local users are created directly in Teleport. They are not coming from an


I would expand on what "directly" means here, e.g., talking about the Auth Service backend.

Also, should we mention that local users are dynamic resources and link to the relevant docs on dynamic resources?

I removed "directly". Both local and non-local are dynamic resources and living in the Teleport backend. From a technical pov, the implementation is identical.

docs/pages/reference/user-types.mdx

github-actions · 2024-02-02T16:42:33Z

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

github-actions · 2024-02-02T16:43:43Z

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

github-actions · 2024-02-02T16:46:03Z

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

hugoShaka · 2024-02-02T21:44:59Z

@ptgott I addressed most comments and responded to a couple, the PR is ready for another review

github-actions · 2024-02-02T21:48:37Z

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

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

github-actions · 2024-02-13T19:51:43Z

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

public-teleport-github-review-bot · 2024-02-13T20:16:49Z

@hugoShaka See the table below for backport results.

Branch	Result
branch/v15	Failed

* Document managing users, roles and accesslists through IaC * reformat docs/config.json * address feedback * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com> * align label names * address feedback * update teleportrole version --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

…38177) * Document managing users, roles and accesslists through IaC * reformat docs/config.json * address feedback * Apply suggestions from code review * Apply suggestions from code review * align label names * address feedback * update teleportrole version --------- Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

hugoShaka added documentation tctl tctl - Teleport admin tool kube-operator Issues related to Kube Operator terraform Legacy Terraform label no-changelog Indicates that a PR does not require a changelog entry labels Jan 12, 2024

hugoShaka requested review from r0mant and ptgott January 12, 2024 15:37

hugoShaka temporarily deployed to vercel January 12, 2024 15:37 — with GitHub Actions Inactive

github-actions bot added the size/lg label Jan 12, 2024

github-actions bot requested review from ibeckermayer, nklaassen, xinding33 and zmb3 January 12, 2024 15:38

hugoShaka temporarily deployed to vercel January 12, 2024 15:48 — with GitHub Actions Inactive

r0mant approved these changes Jan 23, 2024

View reviewed changes

ptgott reviewed Jan 24, 2024

View reviewed changes

benarent reviewed Jan 25, 2024

View reviewed changes

docs/pages/management/dynamic-resources/teleport-operator.mdx Outdated Show resolved Hide resolved

ptgott reviewed Jan 26, 2024

View reviewed changes

ptgott reviewed Jan 30, 2024

View reviewed changes

hugoShaka force-pushed the hugo/iac-guides branch from 7c53df8 to 0b2dc27 Compare February 2, 2024 16:37

hugoShaka temporarily deployed to vercel February 2, 2024 16:37 — with GitHub Actions Inactive

hugoShaka added the backport/branch/v15 label Feb 2, 2024

hugoShaka temporarily deployed to vercel February 2, 2024 16:38 — with GitHub Actions Inactive

hugoShaka temporarily deployed to vercel February 2, 2024 16:39 — with GitHub Actions Inactive

hugoShaka temporarily deployed to vercel February 2, 2024 21:39 — with GitHub Actions Inactive

hugoShaka requested a review from ptgott February 2, 2024 21:44

ptgott approved these changes Feb 6, 2024

View reviewed changes

public-teleport-github-review-bot bot removed request for zmb3, ibeckermayer, nklaassen and xinding33 February 6, 2024 23:04

hugoShaka and others added 8 commits February 13, 2024 14:43

Document managing users, roles and accesslists through IaC

93a6bfa

reformat docs/config.json

9ae3baa

address feedback

becce18

Apply suggestions from code review

a5b8bcd

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

Apply suggestions from code review

70f834a

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

align label names

6b6c939

address feedback

0ebbe4f

update teleportrole version

ee67fc7

hugoShaka force-pushed the hugo/iac-guides branch from 73de16d to ee67fc7 Compare February 13, 2024 19:45

hugoShaka temporarily deployed to vercel February 13, 2024 19:45 — with GitHub Actions Inactive

hugoShaka added this pull request to the merge queue Feb 13, 2024

Merged via the queue into master with commit 90c5ea6 Feb 13, 2024
41 checks passed

hugoShaka deleted the hugo/iac-guides branch February 13, 2024 20:15

hugoShaka mentioned this pull request Feb 13, 2024

[v15] Document managing users, roles and accesslists through IaC #38177

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document managing users, roles and accesslists through IaC #36622

Document managing users, roles and accesslists through IaC #36622

hugoShaka commented Jan 12, 2024 •

edited by ptgott

github-actions bot commented Jan 12, 2024

github-actions bot commented Jan 12, 2024

ptgott commented Jan 22, 2024

r0mant left a comment

ptgott left a comment

ptgott left a comment

ptgott left a comment

ptgott Jan 30, 2024

hugoShaka Feb 2, 2024

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

hugoShaka commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 13, 2024

public-teleport-github-review-bot bot commented Feb 13, 2024


		## Local Users

		Local users are created directly in Teleport. They are not coming from an

Document managing users, roles and accesslists through IaC #36622

Document managing users, roles and accesslists through IaC #36622

Conversation

hugoShaka commented Jan 12, 2024 • edited by ptgott

github-actions bot commented Jan 12, 2024

github-actions bot commented Jan 12, 2024

ptgott commented Jan 22, 2024

r0mant left a comment

Choose a reason for hiding this comment

ptgott left a comment

Choose a reason for hiding this comment

ptgott left a comment

Choose a reason for hiding this comment

ptgott left a comment

Choose a reason for hiding this comment

ptgott Jan 30, 2024

Choose a reason for hiding this comment

hugoShaka Feb 2, 2024

Choose a reason for hiding this comment

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

hugoShaka commented Feb 2, 2024

github-actions bot commented Feb 2, 2024

github-actions bot commented Feb 13, 2024

public-teleport-github-review-bot bot commented Feb 13, 2024

hugoShaka commented Jan 12, 2024 •

edited by ptgott