docs: rbac getting started guide #48029
Conversation
mmcallister
added
no-changelog
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
🤖 Vercel preview here: https://docs-e6vl89m1b-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-1jx2jhdr5-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-ngh663832-goteleport.vercel.app/docs/ver/preview |
|
@ptgott could you have a look at this again when you have time? thank you! |
Co-authored-by: Paul Gottschling <[email protected]>
Co-authored-by: Paul Gottschling <[email protected]>
Co-authored-by: Paul Gottschling <[email protected]>
|
🤖 Vercel preview here: https://docs-adtlgwln7-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-mfeii42b3-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-ijjmccb0v-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-dkwituih5-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-onobql29z-goteleport.vercel.app/docs/ver/preview |
|
@ptgott could you have another look when you have some bandwidth? Ty! |
|
Hi @mmcallister, what do you think of the comments I left in this thread? |
|
🤖 Vercel preview here: https://docs-bb5rm7y6t-goteleport.vercel.app/docs/ver/preview |
Grazie @ptgott ! Ok, here's another go. I've used some of the other guides and related blog post for inspiration, e.g. https://goteleport.com/docs/connect-your-client/tsh/, https://goteleport.com/learn/what-is-rbac. |
* Edit the Access Controls getting started guide
1. Edit the introduction.
- Remove unnecessary sentences
- Move the "What is RBAC" text to the introduction so we describe RBAC
before saying that this guide shows you how to use it.
2. Move the outline of RBAC components into a "How it works" section.
This follows the structure of other how-to guides and adds some
context by using prose.
3. Change the step-by-step instructions.
- Make these first in the guide to keep with the conventions for our
step-by-step guides.
- Add steps to enroll two servers as Docker containers in order to
demonstrate RBAC.
4. Add conceptual sections under the step-by-step instructions in a
"Next steps" section. This follows the convention for our how-to
guides.
- Reformat "Maintaining your labeling strategy" to make it more
compact.
- Edit style in the use cases section to use headings and add a short
introduction to each code block.
5. Remove the per-resource RBAC section. This section combines Database
Access Controls and Kubernetes per-resource RBAC. We use
"per-resource RBAC" to refer to Kubernetes resource RBAC. Instead,
add a section that links to RBAC-related guides for each kind of
resource.
* Apply suggestions from code review
Co-authored-by: marie <[email protected]>
---------
Co-authored-by: marie <[email protected]>
| :Note: | ||
| Please reference [Setting Up Teleport Access Controls for Kubernetes](../../enroll-resources/kubernetes-access/manage-access.mdx) before proceeding, if you have not done so already. |
There was a problem hiding this comment.
| :Note: | |
| Please reference [Setting Up Teleport Access Controls for Kubernetes](../../enroll-resources/kubernetes-access/manage-access.mdx) before proceeding, if you have not done so already. | |
| <Notice type="tip"> | |
| Reference [Setting Up Teleport Access Controls for Kubernetes](../../enroll-resources/kubernetes-access/manage-access.mdx) before proceeding, if you have not done so already. | |
| </Notice> |
- Using our docs engine syntax to create a notice
- Removing "Please", which I don't think we need in technical writing
|
|
||
| Below is an example of a role that provides developers with access to only the dev namespace: | ||
|
|
||
| ```code |
There was a problem hiding this comment.
| ```code | |
| ```yaml |
There was a problem hiding this comment.
We should use yaml for other YAML examples as well so syntax highlighting works.
|
🤖 Vercel preview here: https://docs-7fuzm6ux5-goteleport.vercel.app/docs/ver/preview |
Setting up a new PR from rbac guide issue 46417.
Discuss core concepts of user and role #15156, provide simple rbac starter examples #39241.
Revising existing content, adding an introduction and basics that were missing in the original and how-to guide for setting up RBAC, with additional examples for kubernetes
Closes #40009
Closes #39241