Documentation for ssh_port_forwarding role option
#50361
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eriktate
added
documentation
no-changelog
github-actions
bot
requested review from
bernardjkim,
hugoShaka,
Joerger,
marcoandredinis,
mmcallister,
ptgott,
r0mant,
rosstimothy,
tigrato,
xinding33 and
zmb3
eriktate
commented
Dec 17, 2024
Comment on lines
+93
to
+97
| ssh_port_forwarding: | ||
| remote: | ||
| enabled: true | ||
| local: | ||
| enabled: true |
There was a problem hiding this comment.
These RFD edits probably weren't necessary, but I figured it doesn't hurt to keep example configurations accurate
eriktate
force-pushed
the
eriktate/docs/ssh-port-forwarding
branch
from
cd4d28b to
2eacd8c
Compare
eriktate
force-pushed
the
eriktate/docs/ssh-port-forwarding
branch
from
2eacd8c to
f5e80bb
Compare
|
🤖 Vercel preview here: https://docs-3yd3pybxj-goteleport.vercel.app/docs |
|
🤖 Vercel preview here: https://docs-ejdwth8s8-goteleport.vercel.app/docs |
ptgott
approved these changes
Dec 18, 2024
| # port_forwarding controls whether TCP port forwarding is allowed for SSH | ||
| port_forwarding: true | ||
| # ssh_port_forwarding controls which TCP port forwarding modes are allowed over SSH. This replaces | ||
| # the now deprecated port_forwarding field which did not differentiate between remote and local |
There was a problem hiding this comment.
Suggested change
| # the now deprecated port_forwarding field which did not differentiate between remote and local | |
| # the deprecated port_forwarding field, which did not differentiate between remote and local |
- removing "now", since the docs are assumed to be up to date as of the present
- adding a comma before "which"
docs/pages/includes/role-spec.mdx
Outdated
| # port_forwarding controls whether TCP port forwarding is allowed for SSH | ||
| port_forwarding: true | ||
| # ssh_port_forwarding controls which TCP port forwarding modes are allowed over SSH. This replaces | ||
| # the now deprecated port_forwarding field which did not differentiate between remote and local |
There was a problem hiding this comment.
Suggested change
| # the now deprecated port_forwarding field which did not differentiate between remote and local | |
| # the deprecated port_forwarding field, which did not differentiate between remote and local |
docs/pages/includes/role-spec.mdx
Outdated
| # the now deprecated port_forwarding field which did not differentiate between remote and local | ||
| # port forwarding modes. If you have any existing roles that allow forwarding by enabling the | ||
| # legacy port_forwarding field then the forwarding controls configured in ssh_port_forwarding will be | ||
| # effectively ignored. |
There was a problem hiding this comment.
Do we need "effectively" here? If "effectively ignored" this means the same thing as "ignored", I would remove "effectively" to make this clearer.
rosstimothy
approved these changes
Dec 18, 2024
public-teleport-github-review-bot
bot
removed request for
r0mant,
marcoandredinis,
tigrato and
mmcallister
public-teleport-github-review-bot
bot
removed request for
zmb3,
bernardjkim,
hugoShaka,
Joerger and
xinding33
eriktate
force-pushed
the
eriktate/docs/ssh-port-forwarding
branch
from
f5e80bb to
3957446
Compare
…orwarding and adding some additional context to the rbac reference
eriktate
force-pushed
the
eriktate/docs/ssh-port-forwarding
branch
from
3957446 to
e177ff6
Compare
|
🤖 Vercel preview here: https://docs-ix45oom5j-goteleport.vercel.app/docs |
|
🤖 Vercel preview here: https://docs-50seoyr14-goteleport.vercel.app/docs |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
mvbrock
pushed a commit
that referenced
this pull request
Dec 19, 2024
…orwarding and adding some additional context to the rbac reference (#50361)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR swaps occurrences of
port_forwardingwithssh_port_forwardingin our guides and references. We don't currently have a section dedicated to port forwarding that I was able to find, so I added some additional context about the legacy field to the rbac/role reference.I'm happy to add a separate paragraph about port forwarding access controls if that would be useful. I found myself essentially rewriting the note included in the rbac/role reference, though, and opted to leave that out for now.