Skip to content

Commit

Permalink
Prepare more Setup guides for Cloud users
Browse files Browse the repository at this point in the history
TLS Routing Migration

  Added a compatibility note for Cloud users. Unfortunately there is
  nothing else we can do until we can come up with a way to adjust
  the visibility of whole pages based on the scope picker.

Running Teleport on GCP and IBM Cloud

  Both of these guides assume throughout that you are deploying the
  Auth Service, Proxy Service, and Auth Service storage backend. There
  is very little relevant information for Cloud users.

  Since making these guides relevant for Cloud users would require
  research and rewriting, which is out of scope for issue #10633, this
  change adds a Notice component to these guides explaining their
  relevance.

Reducing the Blast Radius

  This guide already includes instructions for Cloud users. This
  change includes the tctl.mdx partial to ensure that Cloud users
  know to log in first before running tctl commands.

Resources reference

- Add Tabs in the introduction where guidance differs for Cloud and
  Self-Hosted users.

- Include the tctl.mdx partial in the Introduction so users know how
  to connect to their Teleport cluster in order to perform tctl
  commands.

- Edit the introductory sections of the post for clarity and style.

  Note that this change does not attempt to fill in missing dynamic
  resource types within the reference list, as this would be outside
  the time I allotted to work on issue #10633.

CLI reference

- Add instructions for Cloud users via a Notice above the roles table
  and tabbed instructions above the tctl section.
- Add an entry for the Windows Desktop Service in the roles table.
- Perform some light copy editing, e.g., removing somewhat confusing
  links from H4 headings and making minor style tweaks. A comprehensive
  refresh of the CLI reference is out of scope of my work on issue
  #10633.
  • Loading branch information
ptgott committed Apr 15, 2022
1 parent af0dcf7 commit f573656
Show file tree
Hide file tree
Showing 6 changed files with 186 additions and 90 deletions.
8 changes: 8 additions & 0 deletions docs/pages/setup/deployments/gcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ We've created this guide to give customers a high level overview of how to use T
on [Google Cloud](https://cloud.google.com/gcp/) (GCP). This guide provides a high level
introduction leading to a deep dive into how to setup and run Teleport in production.

<Notice type="warning" scope={["cloud"]}>

This guide shows you how to deploy the Auth Service and Proxy Service, which
Teleport Cloud manages for you. You can read this guide if you are interested in
learning about self-hosting Teleport on Google Cloud.

</Notice>

We have split this guide into:

- [Teleport on GCP FAQ](#teleport-on-gcp-faq)
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/setup/deployments/ibm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ We've created this guide to give customers a high level overview of how to use T
on the [IBM Cloud](https://www.ibm.com/cloud). This guide provides a high level
introduction leading to a deep dive into how to setup and run Teleport in production.

<Notice type="warning" scope={["cloud"]}>

This guide shows you how to deploy the Auth Service and Proxy Service, which
Teleport Cloud manages for you. You can read this guide if you are interested in
learning about self-hosting Teleport on IBM Cloud.

</Notice>

We have split this guide into:

- [Teleport on IBM FAQ](#teleport-on-ibm-cloud-faq)
Expand Down
10 changes: 9 additions & 1 deletion docs/pages/setup/operations/tls-routing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TLS Routing Migration
description: How to upgrade exising Teleport cluster to a single-port TLS routing mode
description: How to upgrade an existing Teleport cluster to single-port TLS routing mode
---

<Details
Expand All @@ -13,6 +13,14 @@ description: How to upgrade exising Teleport cluster to a single-port TLS routin
TLS routing is available starting from Teleport `8.0`.
</Details>

<Notice scope={["cloud"]} type="tip">

Teleport Cloud manages the Proxy Service's networking configuration for you. You
can read this guide for a better understanding of how the Teleport Proxy Service
works.

</Notice>

Starting from version `8.0` Teleport supports TLS routing. In this mode, all
client connections are wrapped in TLS and multiplexed on one Teleport proxy
port.
Expand Down
Loading

0 comments on commit f573656

Please sign in to comment.