Skip to content

[docs] Teleport Connect Kube gateway v14 update#30460

Merged
greedy52 merged 2 commits intomasterfrom
STeve/26836_kube_gateway_docs
Aug 17, 2023
Merged

[docs] Teleport Connect Kube gateway v14 update#30460
greedy52 merged 2 commits intomasterfrom
STeve/26836_kube_gateway_docs

Conversation

@greedy52
Copy link
Copy Markdown
Contributor

@greedy52 greedy52 commented Aug 14, 2023

@greedy52 greedy52 added documentation teleport-connect Issues related to Teleport Connect. labels Aug 14, 2023
@greedy52 greedy52 requested review from gzdunek and ravicious August 14, 2023 19:10
Copy link
Copy Markdown
Member

@ravicious ravicious left a comment

Choose a reason for hiding this comment

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

The changes to the docs address the change in the underlying implementation well. I added a couple of suggestions on how to make the docs even more clear.

Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment thread docs/pages/connect-your-client/teleport-connect.mdx Outdated
Comment on lines +99 to +101
A new local terminal tab will open with a new connection to the specified
cluster, and the terminal will be preconfigured with the `$KUBECONFIG`
environment variable pointing to a configuration for this specified cluster. Any
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
A new local terminal tab will open with a new connection to the specified
cluster, and the terminal will be preconfigured with the `$KUBECONFIG`
environment variable pointing to a configuration for this specified cluster. Any
A new local terminal tab will open with the `$KUBECONFIG`
environment variable pointing to a configuration for this specified cluster. Any

I'm not sure if it's worth mentioning the connection. For database gateways, we use the gateway tab to represent that "connection", we say "Database Connection" at the top of the tab. For kube gateways, such tab doesn't exist, you jump into the terminal directly.

In that case, from the user's point of view there's no "connection". But also the concept of a connection itself doesn't help the user with understanding how this feature works. If anything, we could mention that this is the equivalent of running tsh proxy kube, but I don't think it's absolutely necessary.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I removed reference to connection and rewrote the last paragraph a little bit. Not sure if it's clear enough or anything is missing. Could you take another look? Thanks!

@greedy52 greedy52 added this pull request to the merge queue Aug 17, 2023
Merged via the queue into master with commit f06ffe8 Aug 17, 2023
@greedy52 greedy52 deleted the STeve/26836_kube_gateway_docs branch August 17, 2023 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation size/sm teleport-connect Issues related to Teleport Connect.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TLS Routing behind ALB: Teleport Connect Kube Proxy Support

3 participants