Clarify RBAC in Kubernetes access Getting Started guide #36026
Labels
Comments
ptgott
added a commit
that referenced
this issue
Mar 1, 2024
Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output.
github-merge-queue bot
pushed a commit
that referenced
this issue
Mar 1, 2024
* Simplify and fix Kubernetes Getting Started guide Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output. * Add context between instructions Responds to tigrato feedback * Fix misspellings
github-actions bot
pushed a commit
that referenced
this issue
Mar 1, 2024
Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output.
github-actions bot
pushed a commit
that referenced
this issue
Mar 1, 2024
Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output.
github-merge-queue bot
pushed a commit
that referenced
this issue
Mar 1, 2024
* Simplify and fix Kubernetes Getting Started guide Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output. * Add context between instructions Responds to tigrato feedback * Fix misspellings
github-merge-queue bot
pushed a commit
that referenced
this issue
Mar 1, 2024
* Simplify and fix Kubernetes Getting Started guide Fixes #36026 - **Remove `kubernetes_users` in the example role**. Teleport impersonates a user with the Teleport user's name if the user has no `kubernetes_users` values, so don't provide one in this guide. - **Remove the step to choose manual or guided enrollment**. The rest of the guide only shows the guided enrollment, making Step 1 redundant. - **Reorder sections.** Move the step to create RBAC resources first. This way, we can refer to the Kubernetes RBAC resources we created earlier when connecting to the cluster. - **Condense redundant steps re: testing the connection:** There are two separate steps that test access to the cluster. Condense these instructions to simplify the guide. - **Edit the "Set up and test access" section:** Include steps that more closely resemble the flow of the guide, including the namespace and groups to include in the "Test Connection" view. - **Have the user fetch pods in the `teleport-agent` namespace**, since we created the namespace in the guide and can guarantee the output. * Add context between instructions Responds to tigrato feedback * Fix misspellings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Applies To
docs/pages/kubernetes-access/getting-started.mdxDetails
See this comment for context: #35804 (comment)
The
kubernetes_usersfield has some complexities that the instructions in this guide overlook in the example role it tells users to create.How will we know this is resolved?
The Kubernetes access Getting Started guide incorporates the complexities described in the comment linked to above.
Related Issues
kubernetes_usersrole field in docs #18495The text was updated successfully, but these errors were encountered: