Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor agent architecture guides into one (#41009)
* Refactor agent architecture guides into one See #37558 The Teleport documentation has two guides that explain the architecture of Teleport agents: - The Database Access Architecture guide (`docs/pages/database-access/architecture.mdx`) - The SSH Nodes guide (`docs/pages/architecture/nodes.mdx`) While these guides are framed around describing the architecture of specific agent services, most of the information in these guides applies to Teleport agents in general. This change refactors these two guides into a single Teleport agent architecture guide that applies to all agent services. Where agents differ, the guide users tables to explain differences. It also links to more specific guides where applicable. As an alternative, we could create a separate architecture guide for each agent service. This change avoids this approach because: - The purpose of this change is to refactor existing information for discoverability, and adds minimal new information. - Agent services differ substantially in how they proxy traffic to specific resources. As of #40115, we expect how-to guides to contain a "How it works" section to explain the architecture of enrolling a specific resource (#39979 includes an example that edits database guides). This approach is cleaner than using a single guide to describe the architecture of connecting to every single resource an agent can proxy. - The convention of having a separate `[Resource] Access` section of the docs per agent service reflects legacy messaging that we are moving away from. More specific changes: - Remove `docs/pages/database-access/architecture`. - Combine information from the Database Architecture and SSH Nodes guides into an Agent Architecture guide in `docs/pages/architecture/agents.mdx`. - Move session secording information from the SSH Nodes guide to the Session Recording architecture guide, where it is more appropriate. - Remove "Cluster State" from the SSH Nodes guide, since this information is present in the backends reference. - Briefly document direct dial mode for agents, but frame the new guide around the assumption that users will/should enroll agents via the Teleport Proxy Service. - Add a new architecture diagram and moves the original one to the Database Access Introduction page. * Respond to greedy52 feedback - Edit list of database protocols. - Note additional commands that retreive certificates. - Add information re: `tsh apps login` to the client cert table. - Fix Desktop Service introduction mistake. - Mention the Discovery Service after the list of agent services. - List the Discovery Service as one that does not require a reverse tunnel. - Mention HTTP apps in the local proxy table. * Partially respond to feedback - Use a clearer first paragraph and replace "proxy" where possible when talking about agents. - Use more accurate column heading in service table. - Clarify where agents can run and their relationship to services. - Other accuracy/clarity fixes, including incorporating suggested wording. - Describe example agent-to-resource authentication methods for resources besides databases. - Mention Teleport Connect. - Remove the mention of agent ping message payloads. * Edit the agent architecture guide Flatten the heading structure, organizing the guide according to connections between components, merging the "Retrieving credentials" sections into sections related to communication between components. Also clarify the process in which the Proxy Service forwards traffic to an agent over a reverse tunnel. * Edit the intro paragraph * Fix spelling * Fix linter errors - Update link target paths - Add the "Cluster state" H2 from the original "Nodes" architecture guide to the Backend Reference so the latter doesn't need to link to a missing section.
- Loading branch information