* Add a Beams use case demo for databases
This guide demonstrates the Teleport RBAC configuration to allow AI
agents running on a Teleport beam to access a Teleport-protected
database using an untrusted prompt. It includes an example of enrolling
a local Postgres container with Teleport, plus a Teleport user/role with
read-only access to the database. This way, a user can go through an
example that is guaranteed to work without having to run a
`--dangerously-skip-permissions` agent session against a preexisting
database.
* Simplify the Beams database guide
- Use `format=text` for the `tctl tokens add` command
- Use `teleport db configure create` instead of a config example
* Fix minor issues in the Beams database guide
- Remove technically inaccurate sentence.
- Clarify "AI agents" vs. Teleport Agents in an introductory paragraph.
- Clarify the `token` flag in `teleport db configure create`
This commit adds a new docs skills page, under `/get-started/` listing available skills, benefits, and usages. It also adds a banner on applicable pages that skills can be used on.
* 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.
* Add a conceptual introduction to Beams
Expand the Agentic Identity Framework section of the docs with a
conceptual guide to the architectural principles behind Beams. The guide
is for prospective Teleport users who may be solving the same problems
as Beams independently with their own solution. This guide explains the
principles behind Beams by emphasizing that Teleport builds Beams on top
of its existing infrastructure identity foundations, and that the
overall approach is deeply integrated into Teleport's longstanding
approach to infrastructure security.
Implementation details:
- Create an Agentic Identity Framework section.
- Assume that we have moved to VNet for egress controls (e.g., #66074).
- Mention the possibility of scoped delegation based on the current
architecture of Beams.
- Link to the guide in the "security model" section of beams.mdx.
- Add a sidebar item for the new guide, but don't add it to the section
index page yet, as there is no natural place for it. Decouple this
change from a reorganization of the Agentic Identity Framework page.
* Clean up Beams guidance
Responds to **kurktchiev**
- Remove the mentions of "Firecracker", as this is an implementation
detail that is more likely to change than the use of a microVM.
- Add a link to the tbot introduction and VNet in the "Sandboxing"
section of the "Reference implementation" H2
- Indicate in the Beams guide that they are a reference implementation
of the Agentic Identity Framework
- Remove the specific TTL of a beam, which is an implementation detail.
Move the first mention of the TTL to where we explain how Teleport
uses it.
* Update spellcheck config
Add "sandboxing" and "indeterministic" and sort the list.
* Edit introductory Beams documentation
- Remove descriptions of functionality that is not yet available from
beams.mdx.
- Replace "indeterministic" with "non-deterministic".
- Remove the Beams discussion from the conceptual introduction. Link to
the Beams docs instead.
* Remove implementation language around Beams
Use softer language around Beams implementing the agentic identity
framework or a secure agentic environment.
* Remove redundant sentence
Respond to zmb3 feedback.
* 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.
* Add Agentic Identity Framework page
Add an Agentic Identity Framework index page. While the first iteration
does not include links, the plan is to build this out into a set of
opinionated guides to building identity into agentic AI.
Edit the sidebar to add a "new" tag for the Agentic Identity Framework
page.
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Update text and links
---------
Co-authored-by: Aatu Väisänen <aatu.vaisanen.ext@goteleport.com>
Co-authored-by: Aleksandr Klizhentas <sasha@node1634.local>
Revamps the Getting Started experience into a concise, four-step guide:
1. Deploy a Teleport cluster
2. Connect infrastructure
3. Set up access controls
4. Configure audit logging
This guide is designed as a multi-page, flowing overview that links to more in-depth documentation (if needed), rather than a long one-page tutorial.
Replaces:
- Existing single-page Getting Started guide (Teleport Enterprise Cloud)
- Linux Demo guide (Teleport Community Edition)
Links in other pages have been updated to point to these new locations and sidebar has been updated as well.
Since this section has an increasing, regularly changing set of pages,
we can autogenerate it to make sure that no pages in the section go
without a sidebar.
Assign a `sidebar_position` of 1 to the Upgrading Compatibility
Overview, since it is a conceptual guide that we expect users to be
familiar with.
* Consolidate Reference docs section contents
Closes#56206
Reduce the number of first-level children in the Reference section of
the docs from 23 to 9, not counting the index page available at
`/docs/reference/`. This makes the Reference section easier to navigate,
since a user can more readily form a mental model of the content
available in the section with fewer items and a more thematic
organization.
- Add a section for deployment references, consolidating reference
guides for configuring and architecting a Teleport deployment.
- Move the Predicate Language and User Types references into the Access
Controls section of References.
- Add a section for API reference guides, consolidating the Terraform,
MWI Terraform, and Operator sections.
- Move Cloud FAQ to Quick Links. This places the guide next to the main
FAQ in the sidebar to make it more discoverable, since the guide is
currently rather hidden. This also helps pave the way to merge the two
FAQs in the future.
* Add an MWI reference section
The MWI Terraform module reference does not belong with reference guides
for API clients. Add a section to the reference guide for Machine &
Workload Identity.
* Rename "API" to "Infrastructure as Code"
Teleport users expect tctl, Operator, and Terraform Provider docs to be
in an Infrastructure as Code reference section, rather than the more
vague "API" section.
Responds to **ravicious** feedback.
We are ensuring that all docs pages about Teleport features fall under a
product-focused section. Move the API how-to guides to Zero Trust Access
except for the Access Request pluging guide, which requires Identity
Governance.
Move the Migrate Plans page to the root of the docs since it is a
general-purpose document for all users.
* Update client tools managed updates documentation to add information about multi-cluster and multi-version caching support
* Rename to managed updates
* Add info about using custom CDN and managed updates initiation
Add redirect
* Apply suggestions from code review
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Apply suggestions from code review
Co-authored-by: Stephen Levine <stephen.levine@goteleport.com>
* Corrected action order
* Apply suggestions from code review
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* Reorder configuration section
---------
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Stephen Levine <stephen.levine@goteleport.com>
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* Edit the Resource Request guide
Closes#33417
Focus the guide more on its stated topic by moving tangentially related
reference information at the end of the guide to more appropriate pages.
- Replace the `search_as_roles` section with a link. Much of the "Next
steps" section is a long list of examples of Teleport roles that an
admin could assign to `search_as_roles`. This is unnecessary, since a
user familiar with a Teleport role won't need this information to
understand `search_as_roles`. It is not the job of the Resource Requests
guide to teach users about Teleport roles.
- Condense the "Next steps" guidance. There are "Next steps" sections.
Make them one. Also turn the section re: Access Request plugins into a
bullet.
- Create a "Request Access to Resources" guide that shows end-users how
to create Access Requests. Instead of manually adding an entry to the
User Guides section in `sidebar.json`, this change configures the
sidebar to generate entries for this section automatically.
- Add a subsection to the Kubernetes RBAC guide explaining implications
for Access Requests and Kubernetes cluster resources. This information
was removed from the docs when we cleaned up the Resource Requests
page.
* Respond to feedback
- Indicate that Teleport Enterprise is required to create Access
Requests in the Web UI.
- Mention Teleport Connect.
- Mention `kube_resource`.
The goal for organizing the documentation is to include a top-level
section for each main Teleport product in order to prevent discrepancies
between other public-facing Teleport materials and the documentation.
This change moves some existing docs sections into a new, top-level
section for Teleport Zero Trust Access.
- SSO: Makes this a child section of ZTA since it is a prominent
Teleport feature.
- Compliance frameworks: Makes this a child of ZTA since compliance is
featured on the ZTA landing page
(https://goteleport.com/platform/zero-trust-access/).
- Export audit events: A prominent feature like SSO is. Moving from
"Management", which is an ambiguous category.
- Infrastructure as code: We want to remove Admin Guides, since the new
product-based organization makes the purpose of this section vague.
Moving the IaC section is one step toward that purpose.
* installations page revamp
* added redirect
* tiles to the top and other suggestions
* adding an intro paragraph to Docker guide
* caps and operating system section update
* fixed broken link
* removing redirect and reflected sha update
Move Identity Security-related how-to guides into a dedicated
documentation sidebar section so readers are aware of this product as a
top-level offering. This is part of a broader initiative to add a
top-level documentation section for each Teleport product.
* Add a top-level MWI section to the docs
Move how-to guides related to Machine & Workload Identity into a
dedicated top-level documentation sidebar section so readers are aware
of this product as a top-level offering. This is part of a broader
initiative to add a top-level documentation section for each Teleport
product.
* Rename the mwi docs directory
Change the name to machine-workload-identity.
Responds to strideynet feedback
The Linux Demo guide is currently our only guide to running a
self-hosted demo cluster. Make this guide more prominent in order to
invite practitioners to try out Teleport.
- Move the Linux Demo guide to the root docs directory and update the
sidebar configuration.
- Link to the Linux Demo guide in Get Started.
- Add a link to the Get Started guide early in the docs index page.
Avoid the temptation to include a two-item list that also includes the
Linux Demo guide, since we want to lead the user down a narrow path
instead of forcing them to make decisions with insufficient context.
Move Identity Governance-related how-to guides into a dedicated
documentation sidebar section so readers are aware of this product as a
top-level offering. This is part of a broader initiative to add a
top-level documentation section for each Teleport product.
Closes#55403
The Introduction section of the docs navigation sidebar includes two
kinds of content:
- Foundational information that is critical to get starting with
Teleport, including a Get Started guide, outline of core concepts, and
installation and upgrading information.
- Information that is good to keep handy and prominent but not critical
to getting started with Teleport.
Since the latter kind of content can distract first-time users and make
it difficult to use the sidebar, this change proposes that we move it to
its own sidebar section, "Quick Links". This change does not edit the
structure of the `docs/pages` content directory.
- Remove the "Introduction to Teleport" link from the sidebar. There is
already one link to the docs index page, the "Get Started" topic link.
Rename the section index link to "Introduction" for clarity. This
prevents the Introduction page from having a "Next" link to the same
page.
- Remove the images from the index page. We obtained these from a slide
deck as placeholders, but have not replaced them with final images.
Since the index page is a high-traffic docs page, removing them
ensures docs viewers have a more polished docs experience.
Paul Gottschling