From 4e16b071e6d41a23b39652dc89f17193d927fa98 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 8 Aug 2024 13:33:22 -0400 Subject: [PATCH] Fix OpenSSH guide sidebar highlighting Backports #45236 Currently, the agentless OpenSSH guide does not appear on the sidebar. This is because the sidebar generator expects menu pages to be named after their corresponding subdirectory and to exist at either (a) the same level as the subdirectory or (b) within the subdirectory. Since a page exists at both locations called `openssh.mdx`, the sidebar generator only shows one of these. This change edits the OpenSSH guide to be called `openssh-agentless.mdx` so it appears on the sidebar. --- CHANGELOG.md | 4 ++-- docs/pages/admin-guides/management/operations/tls-routing.mdx | 2 +- docs/pages/connect-your-client/putty-winscp.mdx | 2 +- docs/pages/enroll-resources/server-access/guides.mdx | 2 +- docs/pages/enroll-resources/server-access/introduction.mdx | 2 +- docs/pages/enroll-resources/server-access/openssh.mdx | 2 +- .../openssh/{openssh.mdx => openssh-agentless.mdx} | 0 .../server-access/openssh/openssh-manual-install.mdx | 2 +- docs/pages/faq.mdx | 2 +- docs/pages/includes/edition-comparison.mdx | 2 +- docs/pages/reference/architecture/agents.mdx | 2 +- docs/pages/reference/architecture/tls-routing.mdx | 2 +- docs/pages/reference/cli/tsh.mdx | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) rename docs/pages/enroll-resources/server-access/openssh/{openssh.mdx => openssh-agentless.mdx} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 28d79d9e27fec..a89502966499e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1669,7 +1669,7 @@ Teleport 14 before upgrading. #### SSH node open dial no longer supported Teleport 14 no longer allows connecting to OpenSSH servers not registered with -the cluster. Follow the updated agentless OpenSSH integration [guide](docs/pages/enroll-resources/server-access/openssh/openssh.mdx) +the cluster. Follow the updated agentless OpenSSH integration [guide](docs/pages/enroll-resources/server-access/openssh/openssh-agentless.mdx) to register your OpenSSH nodes in the cluster’s inventory. You can set `TELEPORT_UNSTABLE_UNLISTED_AGENT_DIALING=yes` environment variable @@ -2499,7 +2499,7 @@ This will allow users to view the OpenSSH nodes in Web UI and using `tsh ls` and use RBAC to control access to them. See the updated [OpenSSH integration -guide](docs/pages/enroll-resources/server-access/openssh/openssh.mdx). +guide](docs/pages/enroll-resources/server-access/openssh/openssh-agentless.mdx). ### Cross-cluster search for Teleport Connect diff --git a/docs/pages/admin-guides/management/operations/tls-routing.mdx b/docs/pages/admin-guides/management/operations/tls-routing.mdx index ae75fb669337f..63ae3fd4b0eae 100644 --- a/docs/pages/admin-guides/management/operations/tls-routing.mdx +++ b/docs/pages/admin-guides/management/operations/tls-routing.mdx @@ -106,7 +106,7 @@ to connect to nodes within your Teleport cluster, you need to regenerate the config. Run `tsh config` command again so it generates SSH config compatible with SSH -routing setup. See our [OpenSSH guide](../../../enroll-resources/server-access/openssh/openssh.mdx) +routing setup. See our [OpenSSH guide](../../../enroll-resources/server-access/openssh/openssh-agentless.mdx) docs for reference. ## Step 7/7. Disable legacy listeners diff --git a/docs/pages/connect-your-client/putty-winscp.mdx b/docs/pages/connect-your-client/putty-winscp.mdx index a001850911334..bf221422b9afe 100644 --- a/docs/pages/connect-your-client/putty-winscp.mdx +++ b/docs/pages/connect-your-client/putty-winscp.mdx @@ -79,7 +79,7 @@ Added PuTTY session for ubuntu@ip-172-31-30-140 [proxy:teleport.example.com] If you don't provide a login to this command, your local Windows username is used instead. If you are adding a session for a registered OpenSSH node within your cluster (added with -[`teleport join openssh`](../enroll-resources/server-access/openssh/openssh.mdx)), you must specify the `sshd` port +[`teleport join openssh`](../enroll-resources/server-access/openssh/openssh-agentless.mdx)), you must specify the `sshd` port (usually 22) when adding a session with `tsh puttyconfig`: ```bash diff --git a/docs/pages/enroll-resources/server-access/guides.mdx b/docs/pages/enroll-resources/server-access/guides.mdx index f55abac09f6ff..794e1de4d5990 100644 --- a/docs/pages/enroll-resources/server-access/guides.mdx +++ b/docs/pages/enroll-resources/server-access/guides.mdx @@ -5,7 +5,7 @@ layout: tocless-doc --- - [Using Teleport with PAM](./guides/ssh-pam.mdx): How to configure Teleport SSH with PAM (Pluggable Authentication Modules). -- [Agentless OpenSSH Integration](./openssh/openssh.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`. +- [Agentless OpenSSH Integration](openssh/openssh-agentless.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`. - [Agentless OpenSSH Integration (Manual Installation)](./openssh/openssh-manual-install.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd` that can't run `teleport`. - [Recording Proxy Mode](./guides/recording-proxy-mode.mdx): How to use Teleport Recording Proxy Mode to capture activity on OpenSSH servers. diff --git a/docs/pages/enroll-resources/server-access/introduction.mdx b/docs/pages/enroll-resources/server-access/introduction.mdx index 649f251a77cbd..65e37b0b981ae 100644 --- a/docs/pages/enroll-resources/server-access/introduction.mdx +++ b/docs/pages/enroll-resources/server-access/introduction.mdx @@ -31,7 +31,7 @@ services. ## Enrolling OpenSSH servers You can protect OpenSSH servers with Teleport, which makes it easier to protect -legacy infrastructure, using an [agentless architecture](./openssh/openssh.mdx). +legacy infrastructure, using an [agentless architecture](openssh/openssh-agentless.mdx). Read the [Teleport OpenSSH guides](./openssh.mdx) to learn more. ## Guides diff --git a/docs/pages/enroll-resources/server-access/openssh.mdx b/docs/pages/enroll-resources/server-access/openssh.mdx index b527979d66d6c..e7632cfd9b097 100644 --- a/docs/pages/enroll-resources/server-access/openssh.mdx +++ b/docs/pages/enroll-resources/server-access/openssh.mdx @@ -4,6 +4,6 @@ description: Teleport Agentless OpenSSH integration guides. layout: tocless-doc --- -- [Agentless OpenSSH Integration](./openssh/openssh.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`. +- [Agentless OpenSSH Integration](openssh/openssh-agentless.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd`. - [Agentless OpenSSH Integration (Manual Installation)](./openssh/openssh-manual-install.mdx): How to use Teleport in agentless mode on systems with OpenSSH and `sshd` that can't run `teleport`. diff --git a/docs/pages/enroll-resources/server-access/openssh/openssh.mdx b/docs/pages/enroll-resources/server-access/openssh/openssh-agentless.mdx similarity index 100% rename from docs/pages/enroll-resources/server-access/openssh/openssh.mdx rename to docs/pages/enroll-resources/server-access/openssh/openssh-agentless.mdx diff --git a/docs/pages/enroll-resources/server-access/openssh/openssh-manual-install.mdx b/docs/pages/enroll-resources/server-access/openssh/openssh-manual-install.mdx index 4b7399f473f4e..eb1f20f511a0a 100644 --- a/docs/pages/enroll-resources/server-access/openssh/openssh-manual-install.mdx +++ b/docs/pages/enroll-resources/server-access/openssh/openssh-manual-install.mdx @@ -35,7 +35,7 @@ In this setup, the Teleport SSH Service performs RBAC checks as well as audits a This guide shows you how to register an OpenSSH node by creating a node resource and configuring OpenSSH to trust the Teleport CA. If you can copy the `teleport` binary onto your OpenSSH node and execute it however, you can follow - the [standard registration guide](openssh.mdx) instead, which has fewer steps. + the [standard registration guide](openssh-agentless.mdx) instead, which has fewer steps. Teleport is able to perform many of the steps we show in this guide automatically. diff --git a/docs/pages/faq.mdx b/docs/pages/faq.mdx index f46afb8b02bb9..d68dda8389388 100644 --- a/docs/pages/faq.mdx +++ b/docs/pages/faq.mdx @@ -29,7 +29,7 @@ functionality without a net addition of an agent on your system. ## Can I use OpenSSH with a Teleport cluster? Yes, this question comes up often and is related to the previous one. Take a -look at [Using OpenSSH Guide](./enroll-resources/server-access/openssh/openssh.mdx). +look at [Using OpenSSH Guide](enroll-resources/server-access/openssh/openssh-agentless.mdx). ## Can I connect to nodes behind a firewall? diff --git a/docs/pages/includes/edition-comparison.mdx b/docs/pages/includes/edition-comparison.mdx index 97ae106ca429c..0b47657b0c5f4 100644 --- a/docs/pages/includes/edition-comparison.mdx +++ b/docs/pages/includes/edition-comparison.mdx @@ -44,7 +44,7 @@ _Available as an add-on to Teleport Enterprise_ ||Community Edition|Enterprise|Cloud| |---|---|---|---| -|Agentless Integration with [OpenSSH Servers](../enroll-resources/server-access/openssh/openssh.mdx)|✔|✔|✔| +|Agentless Integration with [OpenSSH Servers](../enroll-resources/server-access/openssh/openssh-agentless.mdx)|✔|✔|✔| |[Application Access](../enroll-resources/application-access/getting-started.mdx)|✔|✔|✔| |[Database Access](../enroll-resources/database-access/getting-started.mdx)|✔|✔|✔| |[Desktop Access](../enroll-resources/desktop-access/introduction.mdx)|✔|✔|✔| diff --git a/docs/pages/reference/architecture/agents.mdx b/docs/pages/reference/architecture/agents.mdx index b8b6a495811e2..0cd4dff2f063e 100644 --- a/docs/pages/reference/architecture/agents.mdx +++ b/docs/pages/reference/architecture/agents.mdx @@ -252,7 +252,7 @@ CLI: |`tsh proxy aws`|[AWS SDK applications](../../enroll-resources/application-access/cloud-apis/aws-console.mdx)| |`tsh proxy azure`|[Azure SDK applications](../../enroll-resources/application-access/cloud-apis/azure.mdx)| |`tsh proxy gcloud`|[Google Cloud SDK applications](../../enroll-resources/application-access/cloud-apis/google-cloud.mdx)| -|`tsh proxy ssh`|[OpenSSH client traffic](../../enroll-resources/server-access/openssh/openssh.mdx)| +|`tsh proxy ssh`|[OpenSSH client traffic](../../enroll-resources/server-access/openssh/openssh-agentless.mdx)| |`tsh proxy db`|[Native database clients](../../connect-your-client/gui-clients.mdx)| |`tsh proxy kube`|[Kubernetes clusters behind L7 load balancers](tls-routing.mdx#kubernetes)| diff --git a/docs/pages/reference/architecture/tls-routing.mdx b/docs/pages/reference/architecture/tls-routing.mdx index f79107e1009eb..3f72a91f45a91 100644 --- a/docs/pages/reference/architecture/tls-routing.mdx +++ b/docs/pages/reference/architecture/tls-routing.mdx @@ -77,7 +77,7 @@ which can be used as a `ProxyCommand`. Similarly to `tsh ssh`, `tsh proxy ssh` establishes a TLS tunnel to Teleport proxy with `teleport-proxy-ssh` ALPN protocol, which `ssh` then connects over. -See the [OpenSSH client](../../enroll-resources/server-access/openssh/openssh.mdx) guide for details on +See the [OpenSSH client](../../enroll-resources/server-access/openssh/openssh-agentless.mdx) guide for details on how it's configured. ## Reverse tunnels diff --git a/docs/pages/reference/cli/tsh.mdx b/docs/pages/reference/cli/tsh.mdx index ff488fa0f71b9..f3b18116fe51c 100644 --- a/docs/pages/reference/cli/tsh.mdx +++ b/docs/pages/reference/cli/tsh.mdx @@ -749,7 +749,7 @@ $ gsutil ls Start a local TLS proxy for `ssh` connections when using Teleport in TLS Routing mode. This is typically used as part of the SSH client configuration to use `ssh` as a client -through Teleport. See the [OpenSSH Guide](../../enroll-resources/server-access/openssh/openssh.mdx) guide +through Teleport. See the [OpenSSH Guide](../../enroll-resources/server-access/openssh/openssh-agentless.mdx) guide on configuring OpenSSH servers and clients. The `tsh config` output will include `tsh proxy ssh` within a `ProxyCommand` directive.