* Add a Configuring Teleport docs section
Make the how-to guides for managing Teleport resources with
Infrastructure as Code tools more prominent by placing them in a
Configuring Teleport section next to other foundational docs sections,
e.g., Installation and Upgrading. Frame the task of managing Teleport
with IaC as part of the broader task of configuring Teleport.
To do so, move the introduction of the "Static and Dynamic Resources"
page to a landing page for the new Configuration section. Move the
remaining part of that page to the References section, since it's an
advanced guide and more of a reference than a set of how-to
instructions.
This change also structures the Infrastructure as Code landing page into
a Configure Teleport landing page by including links to guides for
static as well as dynamic configuration. This adds clarity to the docs
since users won't immediately know that Teleport exposes these two
configuration variants.
* Update internal links
* Fix issues with the Configuring Teleport section
- Update the static/dynamic field table to use the correct field name,
`spec.mode`.
- Change "Managing Resources" to "Resource Guides" for clarity, since
all sections in Configuring Teleport would be about managing
resources.
- Reorder Configuration sidebar sections to move Resource Guides last
and tctl before Terraform and Kubernetes.
* Update Go version to v1.26.4
* Rm GO_VERSION from Makefile/Dockerfile and rely on go.mod to inform Go version. Update code to adhere to 1.26 deprecation/changes.
Signed-off-by: Chris Thach <chris.thach@goteleport.com>
* Bump e to 54d1d0cb67b71860b943de477b3146d32ccdd74a.
Signed-off-by: Chris Thach <chris.thach@goteleport.com>
---------
Signed-off-by: Chris Thach <chris.thach@goteleport.com>
Co-authored-by: teleport-renovate[bot] <275214890+teleport-renovate[bot]@users.noreply.github.com>
Co-authored-by: Chris Thach <chris.thach@goteleport.com>
* Remove redundant database configuration references
This:
1. Adds documentation for the mysql_server_version field of proxy_service
to the general config reference and improves formatting for a couple
of fields there.
2. Removes database config/resource references that are redundant due to
being covered by auto-generated docs or the more centralized teleport
config docs.
* Update docs redirects
* Update internal links pointing to deleted pages
* Update DatabaseSpecV3.Protocol comment with allowed database protocol types
- This PR is removing the old `db` resource reference.
- The new `db` resource reference is generated from the DatabaseV3
protobuf type.
- The old `db` resource reference defined the allowed values of the
protocol field, whereas this information is not in the `DatabaseV3` type.
- docs/pages/identity-security/session-summaries.mdx links to the `db`
resource reference, using it as a source of information on which values
are allowed for the protocol field.
Therefore, we must update the DatabaseV3 protobuf type with information
on which values are allowed for the protocol field.
Implements part of RFD 246
Help new users understand what is involved in deploying a Teleport
cluster by moving the self-hosting documentation into the Installation
section. This way, we can include all information related to running
Teleport processes in the same part of the docs.
Docs related to Teleport features but not first-time deployments do not
belong in the Installation section, so this change moves them into the
Management section instead:
- Configure Trusted Clusters
- TLS Routing Migration
- Guides in `zero-trust-access/deploy-a-cluster/reliability`
Also edit the Installation landing page to make self-hosting guidance
clearer. Merge the H2 sections re: self-hosting and cluster setup and
provide a clearer experience for users, with a table of cluster
components.
* Begin restructuring installation docs
See RFD 246
The documentation in the Installation section is currently organized by
platform while documentation for deploying Teleport components is
organized elsewhere. This creates confusion for users, who visit the
Installation docs far more often than any other section, missing
critical instructions.
This change modifies the Installation section to include four children:
- Deploying Teleport Agents
- Installing Teleport on a single machine
- Uninstalling Teleport
- An external link to the Download page, the fastest way to download
Teleport client tools.
Implementation details:
- Remove the `amazon-ec2.mdx` installation guide. This has to do with
cluster installation, not single-machine installation. Move AMI
information into the EC2 Terraform guides, which a separate change
will add to the Installation section. Also remove `helm.mdx` from the
single-machine section, where it does not belong. A separate change
will add our Helm guides to the Installation section.
- Move `amazon-ecs.mdx` to the `agents` directory. It's a guide for
deploying Teleport Agents.
- Remove `windows.mdx`, which only pertains to clients, in favor of
making the Download page more visible in the Installation section.
This change also adds some structural improvements to the `linux.mdx`
guide:
- Organize section introductiosn to create a clearer hierarchy between
more general and more specific information. Readers now read more general
information first.
- Move the item re: recommending Cloud to the top of the page.
- Rework the control plane section. Remove the tab for Teleport Cloud,
which is unnecessary since the section isn't for cloud customers. Add
stepped instructions to consolidate the text a bit.
- Include clearer branching in the TAR and package download section
between self-hosted and agent use cases. Move the branching between
FIPS and standard installations higher in the section for clarity.
* Fix links after reorganizing installation docs
* Clean up installation instructions
Responds to **GavinFrazar** feedback:
- Make the Installation section description more precise.
- Extract the Teleport AMI list into a partial.
* Fix clarity issues in the Installation section
- In the landing page, provide a clearer route for users interested in
self-hosting Teleport Community Edition.
- Restore the Windows guide so we have consistent installation
instructions for all supported platforms. Accordingly, update the
`docs/pages/installation/single-machine` landing page to indicate that
this section also pertains to client tools.
- Place the Amazon EC2 guide in the Single Machine subsection and
include the partial that lists AMIs. Replace the single H2 with an
Admonition for clarity. Fix redirects accordingly.
- Move "Downloads" to the end of the Installation sidebar section.
Clarify the purpose of the link.
- Include `fdpass-teleport` in the table of installed binaries.
- Use "control plane" instead of "cluster" to describe the Auth Service
and Proxy Service in the single-machine.mdx index page.
* Moved Device Trust from IG to ZTA
Changed all references with device trust to new links
Replaced tags and enterprise labels to reflect this transition
* fixed links on web UI
Closes#22580
Teleport Agent services allow you to achieve high availability in
roughly the same way, so this change combines the two existing agent HA
guides and adds mentions of the Desktop Service and Kubernetes Service.
It includes an architectural overview of agent high availability to help
administrators understand how an highly available agent deployment
works and plan their deployment.
Move the "separate replicas" subsection into a details box, since it's
more of an edge case of the static configuration topic than a topic of
equal weight to the static/dynamic examples.
Closes#58055
We include instructions throughout the how-to guides in the Teleport
docs for how to install and run Teleport as a systemd service.
The only content that the Run Teleport as a Daemon guides includes in
addition to what is already ubiquitous in the docs is a list of flags.
However, after we merge #62733, there will be a flag table in the
`teleport` CLI reference for the `teleport install systemd` command,
making this table unnecessary.
This change removes the unnecessary guide.
* Fix duplicate Access List Terraform guides
See #58607
There are two how-to guides to managing Access Lists with IaC. One
includes Operator and Terraform provider instructions, and one only
includes Terraform instructions. Since the Terraform-only guide gets
very little traffic, combine it with the broader guide. To do so, move
information from the Terraform-specific guide to the general "Access
Lists with IaC" guide if it is absent in the latter. This also has the
advantage of updating the Access Lists with IaC guide.
* Edit the Access Lists Terraform guide
- Move the guide to the Identity Governance section.
- Expand the introduction to static vs. default Access Lists.
* Move Access Lists TF guide to Managing Resources
While some features described in the Manaing Resources section are not
available in the Zero Trust Access product, keeping all how-to guides
for managing resources with IaC tools in this section will make it
easier to find a more discoverable location for this content in the
future, and for current users looking at these guides to find similiar
instructions.
Add a link from the Access Lists guide in the Identity Governance
section to the Managing Resources guide to make it more discoverable.
Reduce the number of items in the sidebar to create a clearer hierarchy
by taking the following steps:
- Move the HSM guide to the Private Keys subsection. It is another
option for the same configuration knob, so it belongs with the two
cloud-based KMS guides.
- Add a Reliability section, and add the Break-Glass Access, Proxy
Peering, and Backup/Restore guides to it.
The SSO documentation currently consists of:
- One long conceptual guide
- IdP-specific how-to guides
The conceptual guide holds a collection of topics with no unifying
theme besides Teleport's SSO support, making it difficult to discover
topics for readers who have not made their way through the entire guide.
This change aims to improve the discoverability of SSO topics by:
- Splitting the conceptual guide into multiple pages
- Moving IdP-specific guides into their own subsection
- Moving the Login Rules docs, which only make sense if a user is
setting up SSO, into the SSO section of the docs.
To split the main conceptual guide, this change:
- Turns the SSO for MFA section into a how-to guide. This mostly the
structure of a how-to guide, but we couldn't use this structure
because this text was a section of the conceptual SSO guide. By
splitting the SSO guide, we can make this a how-to guide.
- Move the "Changing callback address" section into a partial that we
can include in the IdP-specific how-to guides, since the level of detail within this
section is consistent with those guides.
- Move "Working with an external identity". This belongs in Role
Templates, and has the wrong level of detail for an overview of SSO.
To get this to work, add H3s to the interpolation section of the Role
Templates guide.
- Move all content re: configuring specific authentication connector
fields into the section index page for the IdP-specific guides.
- Remove the Troubleshooting section. This text is repeated using a
partial in every IdP-specific guide, and is the wrong level of detail
for a general overview.
- Move the Login Rules example to where we include other Login Rule
examples, in the Login Rules guide.
- Remove the tabbed examples of authentication connectors from the SSO
index page. There is not nearly enough context on this page to help a
reader make use of these examples. Instead, refer the reader to the
IdP-specific how-to guides.
- Move "multiple SSO provider" discussion to its own page.
Closes#57908
Move content out of the Admin Guides and Operations sections, which are
ambiguous. There is content throughout the docs on performing admin
tasks and operations on a cluster. Each guide in these sections has a
more thematically specific home in the docs with related guides in the
same subsection.
Reorganize the following guides:
| Guide | New Location | Reasoning |
|---------------------|--------------|------------------------------|
| AWS OIDC | Cloud APIs | Contains `integration` info |
| Backup/restore | Self-Hosting | Only for self-hosting |
| CA Rotation | Security | About securing a cluster |
| Datadog Integration | Diagnostics | About monitoring a cluster |
| GitHub integration | Cloud APIs | Contains `integration` info |
| Local Users | RBAC Intro | Beginner-level RBAC guide |
| Proxy Peering | Self-Hosting | Only for self-hosting |
| Scaling | Reference | Conceptual and re: deploying |
| Self-Signed Certs | Self-Hosting | Only for self-hosting |
| Troubleshooting | Diagnostics | Related to introspection |
| Trusted Clusters | Self-Hosting | Only for self-hosting |
| Uninstall Teleport | Installation | Relevant to installation |
Also shorten sidebar labels in order to reduce noise for readers. Remove
the `trusted-cluster-address-lookup.mdx` page, since we include the same
instructions in how-to guides throughout the docs, and this is too short
to be a guide of its own.
Move the daemon guide to the top level of Management, since the Admin
section is now gone. Unlike other guides in `management/admin`, this
guide does not have another more appropriate home.
Make it easier for readers to navigate this section by reducing noise in
the sidebar. This change modifies sidebar labels to reduce length,
remove repeated words, and add a more logical order.
This change also reorganizes some sections of the sidebar in order to
improve clarity and reduce the number of items in a given section:
- Move guides to enrolling specific databases to
`enroll-resources/database-access/enrollment`, and shorten individual
guide slugs since we don't need to include the substring `enroll-`.
- Move the Kubernetes application discovery reference to the Kubernetes
application discovery section. The reference is specific to Kubernetes
application discovery, and makes more sense in the Kubernetes
application discovery subsection.
- Remove the Server Access introduction page, since it is redundant with
the landing page.
- Replace the "Applications" section "Guides" with a "Configuration
Guides" section, which is more thematically specific.
- Move the Ansible guide from "Servers" to "User Guides". This doesn't
require tctl, and is for end-users who want to set up an Ansible
playbook using Teleport credentials. Rephrase a Troubleshooting item
that mentions `tctl` to indicate taht admins must complete the task.
Make the Zero Trust Access sidebar easier to navigate by reducing noise.
Shorten sidebar labels and add a more logical order based on how broadly
applicable a given guide is.
To limit the scope, this change does not address the Management
subsection, which will be reserved for a future change (see #57908).
This change does not modify the SSO or Login Rules sections, since
#61492 will complete that work instead.
Details:
- `/zero-trust-access/infrastructure-as-code/`: Put Managing Resources
first, since it includes beginner-level how-to instructions for all
three IaC tools we support.
- Move the Terraform resource import guide to the Terraform subsection.
It's only applicable to Terraform, and out of place in the Managing
Resources section, in which each page has to do with a single resource
type.
- Move the IdP Compromise guide. It belongs in the Security section.
Also rename the file to more accurately reflect the guide's content.
- Move the general HA guide into Deployment Guides, since that section
contains other architectural plans for deploying Teleport. The same
goes for the Multi-Region Blueprint guide and Proxy Service traffic
separation guide.
- Move the Argo CD guide to the Agents section, since it's a guide to
joining an agent, not deploying a Teleport cluster.
* Clarify the Identity Governance docs sidebar
Help readers form a mental model of the Identity Governance sidebar
section and find relevant content. Make the following changes:
1. Move the Access Request Plugins section into the Access Requests
section, ensuring that the top level of the Identity Governance
sidebar section is a list of features. Shorten legacy file names
beginning `ssh-approval`.
2. Move the use cases page first in the section, since it's a high-level
conceptual guide.
3. Rename sidebar entries to remove redundant words and use the same
grammatical form (e.g., using "-ing").
4. Add a subsection for IdP usage, allowing us to logically separate
guides in the IdP section on setting up the IdP and guides about
configuring the IdP to connect to external services.
* Improve the Identity Governance docs organization
- In the Access Requests section, move Automatic Reviews below
Role/Resource Requests. Also move Plugins before Configuration and
Teleport Community Edition, since these guides are for a broader range
of users.
- Fix the "Teleport Community Edition" label.
- Move "How to Build an Access Request Plugin" to the bottom of the
subsection.
- Move Notification Routing Rules to the top level of Access Requests
- Mention the Teleport IdP, and link to the Usage subsection, in the
introduction page for enrolling applications.
This commit updates the enroll Applications docs homepage with the new design. The introduction.mdx page is also being deleted because it's largely a page of links, the diagram is overly complicated, and the new page covers all the features and links. A redirect is added in config as well as files using that link.
Give the section a clearer hierarchy so users can form a mental model
and better understand how to navigate to their required content. Divide
the section into three subsections: Teleport clients, third-party
clients, and MCP clients.
While the MCP client guides could fit under the third-party client
section, we want to make the MCP content as prominent as possible.
In the third-party client section, include server access guides that are
user guides instead of admin guides. These guides predate our User
Guides section, but belong here instead of in Enroll Servers, since they
are relevant to end-users looking to access already enrolled resources,
rather than admins looking to enroll new resources.
The changes in #44327 moved all reference guides in the docs to a
dedicated sidebar section as part of an effort to simplify the left
navigation sidebar. This included moving reference guides from sidebar
sections related to enrolling Teleport resources into an Agent Services
subsection of the References section.
However, the Agent Services Reference section has become difficult to
find, and the docs are now organized according to Teleport product
rather than the purpose of each guide. This change returns these
reference guides to their feature-based organization.
Reduce repetitive words in sidebar entry labels in order to make the
sidebar easier to read. In some sidebar sections, we used repetitive
words to demarcate some parts of the sidebar from others. In these
cases, add a new docs subsection to provide a clearer hierarchy.
This change includes the following sections:
- Identity Governance integrations, including a new sidebar section for
Entra ID integration setup guides
- Enroll Resources Joining Agents
- Kubernetes Auto-Discovery
- Protecting cloud APIs
- Application access guides, including a new sidebar section for
enrolling different kinds of applications
- Top-level application access guides
- Enrolling databases, including new subsections for RDS Proxy and
RDS/Aurora databases
- New subsection for enrolling MCP servers
teleport-renovate[bot]