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

Add --invite and --reason to tsh ssh #42325

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

zmb3
Copy link
Collaborator

@zmb3 zmb3 commented Jun 3, 2024

Move --reason and --invite to tsh ssh

These flags are part of the moderated sessions feature and are
used to update the session tracker resource. As mentioned in the
RFD, they were supposed to be added to tsh kube exec and tsh ssh.

While tsh kube exec works as intended, for SSH we mistakenly added
these flags to tsh join. As a result, these flags were effectively
no-ops for SSH sessions.

Additionally, the environment variable used to propagate session
invite information was incorrect named "JOIN_MODE" presumably due
to a copy-paste error. This has been fixed, but we will continue
to check the old env var for 1 major release to maintain backwards
compatibility.

Closes #42255

@github-actions github-actions bot added documentation kubernetes-access rfd Request for Discussion size/sm tsh tsh - Teleport's command line tool for logging into nodes running Teleport. labels Jun 3, 2024
Copy link

github-actions bot commented Jun 3, 2024

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.

@zmb3 zmb3 force-pushed the zmb3/remove-moderated-session-invite branch from a73162f to 54f26f2 Compare June 3, 2024 19:42
Copy link

github-actions bot commented Jun 3, 2024

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

Copy link
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

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

Approving the docs side

Note that you can share terminal sessions using any Teleport edition. However, you must
have Teleport Enterprise or Teleport Enterprise Cloud if you want to require active
Note that you can share terminal sessions using any Teleport edition. However, you must
have Teleport Enterprise or Teleport Enterprise Cloud if you want to require active
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
have Teleport Enterprise or Teleport Enterprise Cloud if you want to require active
have Teleport Enterprise if you want to require active

Fixing linter warning

Copy link

github-actions bot commented Jun 3, 2024

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

@zmb3 zmb3 marked this pull request as draft June 3, 2024 22:02
@zmb3 zmb3 force-pushed the zmb3/remove-moderated-session-invite branch from 54f26f2 to 867f950 Compare June 3, 2024 23:33
Copy link

github-actions bot commented Jun 3, 2024

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

@zmb3 zmb3 changed the title Remove the --invite flag for tsh join Add --invite and --reason to tsh ssh Jun 3, 2024
@zmb3 zmb3 marked this pull request as ready for review June 3, 2024 23:40
@github-actions github-actions bot requested review from Joerger and ptgott June 3, 2024 23:40
These flags are part of the moderated sessions feature and are
used to update the session tracker resource. As mentioned in the
RFD, they were supposed to be added to `tsh kube exec` and `tsh ssh`.

While `tsh kube exec` works as intended, for SSH we mistakenly added
these flags to `tsh join`. As a result, these flags were effectively
no-ops for SSH sessions.

Additionally, the environment variable used to propagate session
invite information was incorrect named "JOIN_MODE" presumably due
to a copy-paste error. This has been fixed, but we will continue
to check the old env var for 1 major release to maintain backwards
compatibility.

Closes #42255
@zmb3 zmb3 force-pushed the zmb3/remove-moderated-session-invite branch from 867f950 to 7f3367e Compare June 4, 2024 01:14
@zmb3 zmb3 enabled auto-merge June 4, 2024 01:14
Copy link

github-actions bot commented Jun 4, 2024

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

@zmb3 zmb3 added this pull request to the merge queue Jun 4, 2024
Merged via the queue into master with commit d18ea81 Jun 4, 2024
41 checks passed
@zmb3 zmb3 deleted the zmb3/remove-moderated-session-invite branch June 4, 2024 01:50
@public-teleport-github-review-bot

@zmb3 See the table below for backport results.

Branch Result
branch/v16 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/branch/v16 documentation kubernetes-access moderated-sessions no-changelog Indicates that a PR does not require a changelog entry rfd Request for Discussion size/sm tsh tsh - Teleport's command line tool for logging into nodes running Teleport.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how the --invite flag can be used to integrate with other tools
3 participants