Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix host user creation mode docs #38366

Merged
merged 5 commits into from
Feb 23, 2024
Merged

Fix host user creation mode docs #38366

merged 5 commits into from
Feb 23, 2024

Conversation

atburke
Copy link
Contributor

@atburke atburke commented Feb 17, 2024

This change fixes a few issues in the host user creation mode docs:

  • Removed deprecated drop mode
  • Emphasized recommendation for keep mode

Copy link

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

Comment on lines 30 to 35

First, create a role with `create_host_user_mode` set to `drop`, `insecure-drop`, or `keep`.
First, create a role with `create_host_user_mode` set to `keep` or `insecure-drop`.

- `keep` will create permanent users on the host at login time. This is the
recommended host user creation mode.
- `insecure-drop` will create transient users that are deleted once the session ends.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we even present the option of insecure-drop if we want keep to be the default option for 99% of use cases?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe not, although a reader might be confused as to why create_host_user_mode exists but can only take one value.

Copy link

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

@rosstimothy rosstimothy self-requested a review February 21, 2024 18:04
Copy link

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

Merged via the queue into master with commit 122b5a7 Feb 23, 2024
35 checks passed
@atburke atburke deleted the atburke/host-user-docs-fixes branch February 23, 2024 17:13
@public-teleport-github-review-bot

@atburke See the table below for backport results.

Branch Result
branch/v15 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/branch/v15 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants