Teleport Reference Guides

Technical specifications for components, configuration fields, CLI flags, and APIs.

Report an Issue

Is this page helpful?

How can we improve this page?

View as Markdown

Most Visited

teleport.yaml reference

Configuration fields for Auth, Proxy, SSH, Kubernetes, Apps, and Databases

Role reference

Role YAML spec for defining access, permissions, and request rules

Audit Event Reference

Key system events across access, auth, Kubernetes, and admin activity

tsh CLI reference

Commands and flags for SSH, Kubernetes, databases, and application access

Helm Charts

Helm chart for deploying Teleport Auth Service and Proxy Service with full configuration options

Join Methods

Join clusters using IAM, GitHub, GitLab, Kubernetes, TPM, and tokens

Guides

Platform Architecture

Understand how Teleport services connect, authenticate, and route traffic.

Core

• Authentication Service
• Proxy Service
• TLS Routing
• Teleport Enterprise Cloud
• gRPC API

Agents

• Agent Architecture
• Agent Update Management
• Kubernetes Application Discovery

Sessions & Federation

• Session Recording
• Authorization
• Trusted Cluster

Cluster Configuration

Reference all teleport.yaml fields and cluster-wide configuration options.

Core

• Join Methods
• Storage Backends

Teleport Configuration

• Proxy Service
• Auth Service
• SSH Service
• Kubernetes Service
• Application Service
• Database Service
• more

Networking & Scale

• Networking
• Scaling
• Signature Algorithms

Operations

• Managed Updates Resources
• Process Signals
• Identity Security Config

Monitoring

• Audit Event & Records
• Performance Metrics
• Event Handler
• Distributed Tracing Config
• Vulnerability Management

Access Control

Configure roles, authentication, access controls, and policy settings.

Roles & Expressions

• Predicate Language
• Login Rules

Users & Identity

• User Types
• Authentication Options
• SAML Identity Provider

Access & Monitoring

• Access Lists
• Access Monitoring Rules
• Access Monitoring Events

Machine & Workload Identity

Manage tbot workload identities, and machine identity resources.

tbot Operators

• Auth Service
• Telemetry
• TLS Routing
• Teleport Cloud
• gRPC API

Workload Identity Resources

• Workload Identity
• Resource Configuration Migration
• API Service & Attestation
• Attributes
• Revocations
• Sigstore Attestation
• X.509 Issuer Override

Joining

• Bound keypair joining
• Join Methods

Command-line Tools

Explore CLI commands, flags, and usage for Teleport binaries.

Cluster Services

• teleport
• teleport-update

Operator & User Tools

• tctl
• tsh

Machine Identity Tools

• tbot
• fdpass-teleport

Infrastructure as Code

Automate Teleport with APIs, resource schemas, and infrastructure-as-code tools.

Terraform

• Terraform-provider
• Terraform modules
• MWI terraform provider

Kubernetes operator

• Operator Resources

Dynamic Resources

• Dynamic Resource

Helm Charts

Configure and deploy Teleport using Helm charts and chart values.

Control Plane

• teleport-cluster
• teleport-relay
• teleport-operator
• teleport-access-graph

Agents & Machine Identity

• teleport-kube-agent
• tbot
• tbot-spiffe-daemon-set

Access Request Plugins

• Slack
• Pagerduty
• Jira
• MS Teams
• Discord
• Mattermost
• Email
• Datadog

Security Verification

Verify Teleport packages, binaries, and container images using signing credentials.

• Public Certificate & Encryption Keys