diff --git a/docs/config.json b/docs/config.json index fb81a85955b3d..367758832f381 100644 --- a/docs/config.json +++ b/docs/config.json @@ -2,58 +2,19 @@ "navigation": [ { "icon": "home", - "title": "Home", + "title": "Get Started", "entries": [ + { + "title": "Introduction to Teleport", + "slug": "/" + }, + { + "title": "How Teleport Works", + "slug": "/core-concepts/" + }, { - "title": "Introduction to Teleport", - "slug": "/" - }, - { - "title": "Documentation Overview", - "slug": "/documentation-overview/" - }, - { - "title": "Core Concepts", - "slug": "/core-concepts/" - }, - { - "title": "Installation", - "slug": "/installation/" - }, - { - "title": "Upgrading", - "slug": "/upgrading/", - "entries": [ - { - "title": "Compatibility Overview", - "slug": "/upgrading/overview/" - }, - { - "title": "Set up Automatic Agent Updates", - "slug": "/upgrading/automatic-agent-updates/" - }, - { - "title": "Updating Reference", - "slug": "/upgrading/reference/" - } - ] - }, - { - "title": "FAQ", - "slug": "/faq/" - }, - { - "title": "Usage Reporting and Billing", - "slug": "/usage-billing/", - "forScopes": ["cloud", "enterprise"] - }, - { - "title": "Upcoming Releases", - "slug": "/upcoming-releases/" - }, - { - "title": "Changelog", - "slug": "/changelog/" + "title": "Try out Teleport", + "slug": "/get-started/" } ] }, @@ -61,1159 +22,58 @@ "title": "Admin Guides", "icon": "wrench", "entries": [ + { + "title": "Protect Resources", + "slug": "/admin-guides/protect-resources/" + }, + { + "title": "Set up Single Sign-On", + "slug": "/access-controls/sso/overview/" + }, + { + "title": "Use Infrastructure as Code", + "slug": "/admin-guides/configure-teleport/dynamic-resources/overview/" + }, { "title": "All Topics", "slug": "/admin-guides/" } ] }, - { - "icon": "success", - "title": "Choose an Edition", - "entries": [ - { - "title": "Introduction", - "slug": "/choose-an-edition/introduction/" - }, - { - "title": "Migrate to Cloud-Hosted Enterprise", - "slug": "/choose-an-edition/migrate-to-cloud/" - }, - { - "title": "Teleport Enterprise Cloud", - "slug": "/choose-an-edition/teleport-cloud/", - "forScopes": ["cloud"], - "entries": [ - { - "title": "Get Started", - "slug": "/choose-an-edition/teleport-cloud/get-started/", - "forScopes": ["cloud"] - }, - { - "title": "Architecture", - "slug": "/choose-an-edition/teleport-cloud/architecture/", - "forScopes": ["cloud"] - }, - { - "title": "External Audit Storage", - "slug": "/choose-an-edition/teleport-cloud/external-audit-storage/", - "forScopes": ["cloud"] - }, - { - "title": "Downloads", - "slug": "/choose-an-edition/teleport-cloud/downloads/", - "forScopes": ["cloud"] - }, - { - "title": "Public IP Allowlist", - "slug": "/choose-an-edition/teleport-cloud/ips/", - "forScopes": ["cloud"] - }, - { - "title": "FAQ", - "slug": "/choose-an-edition/teleport-cloud/faq/", - "forScopes": ["cloud"] - } - ] - }, - { - "title": "Teleport Enterprise", - "slug": "/choose-an-edition/teleport-enterprise/introduction/", - "forScopes": ["enterprise"], - "entries": [ - { - "title": "HSM", - "slug": "/choose-an-edition/teleport-enterprise/hsm/", - "forScopes": ["enterprise"] - }, - { - "title": "AWS KMS", - "slug": "/choose-an-edition/teleport-enterprise/aws-kms/", - "forScopes": ["enterprise"] - }, - { - "title": "Google Cloud KMS", - "slug": "/choose-an-edition/teleport-enterprise/gcp-kms/", - "forScopes": ["enterprise"] - }, - { - "title": "Enterprise License File", - "slug": "/choose-an-edition/teleport-enterprise/license/", - "forScopes": ["enterprise"] - } - ] - } - ] - }, - { - "icon": "lock", - "title": "Manage Access", - "entries": [ - { - "title": "Introduction", - "slug": "/access-controls/introduction/" - }, - { - "title": "All Topics", - "slug": "/access-controls/" - }, - { - "title": "Getting Started", - "slug": "/access-controls/getting-started/" - }, - { - "title": "Cluster Access and RBAC", - "slug": "/access-controls/guides/", - "entries": [ - { - "title": "Role Templates", - "slug": "/access-controls/guides/role-templates/" - }, - { - "title": "Session Locking", - "slug": "/access-controls/guides/locking/" - }, - { - "title": "Passwordless", - "slug": "/access-controls/guides/passwordless/" - }, - { - "title": "Second Factor - WebAuthn", - "slug": "/access-controls/guides/webauthn/" - }, - { - "title": "Per-session MFA", - "slug": "/access-controls/guides/per-session-mfa/" - }, - { - "title": "MFA for Administrative Actions", - "slug": "/access-controls/guides/mfa-for-admin-actions/" - }, - { - "title": "Dual Authorization", - "slug": "/access-controls/guides/dual-authz/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Impersonation", - "slug": "/access-controls/guides/impersonation/" - }, - { - "title": "Moderated Sessions", - "slug": "/access-controls/guides/moderated-sessions/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Hardware Key Support", - "slug": "/access-controls/guides/hardware-key-support/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Headless WebAuthn", - "slug": "/access-controls/guides/headless/" - }, - { - "title": "IP Pinning ", - "slug": "/access-controls/guides/ip-pinning/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Single Sign-On (SSO)", - "slug": "/access-controls/sso/", - "forScopes": ["oss", "enterprise", "cloud"], - "entries": [ - { - "title": "Active Directory (ADFS)", - "slug": "/access-controls/sso/adfs/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Azure Active Directory", - "slug": "/access-controls/sso/azuread/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "GitHub", - "slug": "/access-controls/sso/github-sso/", - "forScopes": ["oss", "enterprise", "cloud"] - }, - { - "title": "GitLab", - "slug": "/access-controls/sso/gitlab/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Google Workspace", - "slug": "/access-controls/sso/google-workspace/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "OIDC", - "slug": "/access-controls/sso/oidc/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Okta", - "slug": "/access-controls/sso/okta/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "OneLogin", - "slug": "/access-controls/sso/one-login/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Teleport as an IdP", - "slug": "/access-controls/idps/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "SAML Identity Provider Guide", - "slug": "/access-controls/idps/saml-guide/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "SAML Attribute Mapping", - "slug": "/access-controls/idps/saml-attribute-mapping/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Authenticate to Grafana with Teleport SAML", - "slug": "/access-controls/idps/saml-grafana/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "GCP Workforce Identity Federation", - "slug": "/access-controls/idps/saml-gcp-workforce-identity-federation/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "SAML Identity Provider Reference", - "slug": "/access-controls/idps/saml-reference/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Login Rules", - "slug": "/access-controls/login-rules/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "Set Up Login Rules", - "slug": "/access-controls/login-rules/guide/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Login Rules Reference", - "slug": "/access-controls/login-rules/reference/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Terraform", - "slug": "/access-controls/login-rules/terraform/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Kubernetes Operator", - "slug": "/access-controls/login-rules/kubernetes/", - "forScopes": ["enterprise"] - } - ] - }, - { - "title": "Device Trust", - "slug": "/access-controls/device-trust/", - "forScopes": [ - "enterprise", - "cloud" - ], - "entries": [ - { - "title": "Getting Started", - "slug": "/access-controls/device-trust/guide/", - "forScopes": [ - "enterprise", - "cloud" - ] - }, - { - "title": "Manage Trusted Devices", - "slug": "/access-controls/device-trust/device-management/", - "forScopes": [ - "enterprise", - "cloud" - ] - }, - { - "title": "Enforce Device Trust", - "slug": "/access-controls/device-trust/enforcing-device-trust/", - "forScopes": [ - "enterprise", - "cloud" - ] - }, - { - "title": "Jamf Pro Integration", - "slug": "/access-controls/device-trust/jamf-integration/", - "forScopes": [ - "enterprise", - "cloud" - ] - } - ] - }, - { - "title": "Access Lists", - "slug": "/access-controls/access-lists/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "Getting Started with Access Lists", - "slug": "/access-controls/access-lists/guide/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Reference", - "slug": "/access-controls/access-lists/reference/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Teleport Policy", - "slug": "/access-controls/teleport-policy/getting-started-policy/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "Teleport Policy Integrations", - "slug": "/access-controls/teleport-policy/policy-integrations/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Teleport Policy Connections", - "slug": "/access-controls/teleport-policy/policy-connections/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Teleport Policy Usage", - "slug" : "/access-controls/teleport-policy/policy-how-to-use/", - "forScopes":["enterprise","cloud"] - }, - { - "title": "Teleport Policy for Self-Hosted Clusters", - "slug": "/access-controls/access-graph/self-hosted/", - "forScopes": [ - "enterprise" - ] - }, - { - "title": "Teleport Policy for Self-Hosted Clusters with Helm", - "slug": "/access-controls/access-graph/self-hosted-helm/", - "forScopes": [ - "enterprise" - ] - }, - { - "title": "Analyze AWS IAM policies", - "slug": "/access-controls/access-graph/aws-sync/", - "forScopes": [ - "cloud", - "enterprise" - ] - } - ] - }, - { - "title": "Access Monitoring", - "slug": "/access-controls/access-monitoring/", - "forScopes": [ - "team", - "cloud", - "enterprise", - "oss" - ] - }, - { - "title": "Access Requests", - "slug": "/access-controls/access-requests/", - "forScopes": ["oss", "enterprise", "cloud"], - "entries": [ - { - "title": "Role Requests", - "slug": "/access-controls/access-requests/role-requests/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Resource Requests", - "slug": "/access-controls/access-requests/resource-requests/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Configure Access Requests", - "slug": "/access-controls/access-requests/access-request-configuration/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Access Requests in Teleport Community Edition", - "slug": "/access-controls/access-requests/oss-role-requests/", - "forScopes": ["oss"] - } - ] - }, - { - "title": "Access Request Plugins", - "slug": "/access-controls/access-request-plugins/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "Mattermost", - "slug": "/access-controls/access-request-plugins/ssh-approval-mattermost/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Microsoft Teams", - "slug": "/access-controls/access-request-plugins/ssh-approval-msteams/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "PagerDuty", - "slug": "/access-controls/access-request-plugins/ssh-approval-pagerduty/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Opsgenie", - "slug": "/access-controls/access-request-plugins/opsgenie/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "ServiceNow", - "slug": "/access-controls/access-request-plugins/servicenow/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Jira", - "slug": "/access-controls/access-request-plugins/ssh-approval-jira/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Slack", - "slug": "/access-controls/access-request-plugins/ssh-approval-slack/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Email", - "slug": "/access-controls/access-request-plugins/ssh-approval-email/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Discord", - "slug": "/access-controls/access-request-plugins/ssh-approval-discord/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Notification Routing Rules", - "slug": "/access-controls/access-request-plugins/notification-routing-rules/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Compliance Frameworks", - "slug": "/access-controls/compliance-frameworks/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "FedRAMP", - "slug": "/access-controls/compliance-frameworks/fedramp/", - "forScopes": ["enterprise"] - }, - { - "title": "SOC 2", - "slug": "/access-controls/compliance-frameworks/soc2/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Reference", - "slug": "/access-controls/reference/" - } - ] - }, { "icon": "connect", "title": "Connect your Client", "entries": [ - { - "title": "Introduction", - "slug": "/connect-your-client/introduction/" - }, - { - "title": "Using tsh", - "slug": "/connect-your-client/tsh/" - }, { "title": "Using the Web UI", "slug": "/connect-your-client/web-ui/" }, { - "title": "Using Teleport Connect", + "title": "Teleport Desktop App", "slug": "/connect-your-client/teleport-connect/" }, { - "title": "Using VNet", - "slug": "/connect-your-client/vnet/" - }, - { - "title": "Using PuTTY and WinSCP", - "slug": "/connect-your-client/putty-winscp/" - }, - { - "title": "Database GUI Clients", - "slug": "/connect-your-client/gui-clients/" - } - ] - }, - { - "icon": "window", - "title": "Application Access", - "entries": [ - { - "title": "Introduction", - "slug": "/application-access/introduction/" - }, - { - "title": "Getting Started", - "slug": "/application-access/getting-started/" - }, - { - "title": "Securing Cloud Provider APIs", - "slug": "/application-access/cloud-apis/", - "entries": [ - { - "title": "Google Cloud Web Console Access", - "slug": "/access-controls/idps/saml-gcp-workforce-identity-federation/", - "forScopes": ["enterprise", "cloud"] - }, - { - "title": "Google Cloud CLI Access", - "slug": "/application-access/cloud-apis/google-cloud/" - }, - { - "title": "AWS CLI and Console Access", - "slug": "/application-access/cloud-apis/aws-console/" - }, - { - "title": "Azure CLI Access", - "slug": "/application-access/cloud-apis/azure/" - }, - { - "title": "Azure CLI Access on AKS", - "slug": "/application-access/cloud-apis/azure-aks-workload-id/" - } - ] - }, - { - "title": "Securing Internal Applications", - "slug": "/application-access/guides/", - "entries": [ - { - "title": "Web App Access", - "slug": "/application-access/guides/connecting-apps/" - }, - { - "title": "TCP App Access", - "slug": "/application-access/guides/tcp/" - }, - { - "title": "VNet", - "slug": "/application-access/guides/vnet/" - }, - { - "title": "API Access", - "slug": "/application-access/guides/api-access/" - }, - { - "title": "Dynamic Registration", - "slug": "/application-access/guides/dynamic-registration/" - }, - { - "title": "Amazon Athena", - "slug": "/application-access/guides/amazon-athena/" - }, - { - "title": "Amazon DynamoDB", - "slug": "/application-access/guides/dynamodb/" - }, - { - "title": "High Availability", - "slug": "/application-access/guides/ha/" - } - ] - }, - { - "title": "Using Teleport-Signed JWTs", - "slug": "/application-access/jwt/", - "entries": [ - { - "title": "Introduction", - "slug": "/application-access/jwt/introduction/" - }, - { - "title": "ElasticSearch", - "slug": "/application-access/jwt/elasticsearch/" - } - ] - }, - { - "title": "Protect Okta Applications and Groups ", - "slug": "/application-access/okta/", - "forScopes": ["enterprise", "cloud"], - "entries": [ - { - "title": "Okta Integration", - "slug": "/application-access/okta/hosted-guide/", - "forScopes": [ - "enterprise", - "cloud" - ] - }, - { - "title": "Synchronization and SCIM", - "slug": "/application-access/okta/sync-scim/", - "forScopes": [ - "enterprise", - "cloud" - ] - }, - { - "title": "Reference", - "slug": "/application-access/okta/reference/", - "forScopes": ["enterprise", "cloud"] - } - ] - }, - { - "title": "Access Controls", - "slug": "/application-access/controls/" - }, - { - "title": "Troubleshooting Application Access", - "slug": "/application-access/troubleshooting-apps/" - }, - { - "title": "Reference", - "slug": "/application-access/reference/" - } - ] - }, - { - "icon": "kubernetes", - "title": "Kubernetes Access", - "entries": [ - { - "title": "Introduction", - "slug": "/kubernetes-access/introduction/" - }, - { - "title": "Enroll a Kubernetes Cluster", - "slug": "/kubernetes-access/getting-started/" - }, - { - "title": "Manual Cluster Registration", - "slug": "/kubernetes-access/register-clusters/", - "entries": [ - { - "title": "Register a Cluster with Static kubeconfigs", - "slug": "/kubernetes-access/register-clusters/static-kubeconfig/" - }, - { - "title": "Register a Cluster with IAM Joining", - "slug": "/kubernetes-access/register-clusters/iam-joining/" - }, - { - "title": "Register Clusters Dynamically", - "slug": "/kubernetes-access/register-clusters/dynamic-registration/" - } - ] - }, - { - "title": "Setting up Role-Based Access Controls", - "slug": "/kubernetes-access/manage-access/" - }, - { - "title": "Access Controls Reference", - "slug": "/kubernetes-access/controls/" - }, - { - "title": "FAQ", - "slug": "/kubernetes-access/faq/" - }, - { - "title": "Troubleshooting", - "slug": "/kubernetes-access/troubleshooting/" - } - ] - }, - { - "icon": "database", - "title": "Database Access", - "entries": [ - { - "title": "Getting Started", - "slug": "/database-access/getting-started/" - }, - { - "title": "Access Controls", - "slug": "/database-access/rbac/" - }, - { - "title": "Automatic User Provisioning", - "slug": "/database-access/auto-user-provisioning/", - "entries": [ - { - "title": "Amazon Redshift", - "slug": "/database-access/auto-user-provisioning/aws-redshift/" - }, - { - "title": "MariaDB", - "slug": "/database-access/auto-user-provisioning/mariadb/" - }, - { - "title": "MongoDB", - "slug": "/database-access/auto-user-provisioning/mongodb/" - }, - { - "title": "MySQL", - "slug": "/database-access/auto-user-provisioning/mysql/" - }, - { - "title": "PostgreSQL", - "slug": "/database-access/auto-user-provisioning/postgres/" - } - ] - }, - { - "title": "AWS Databases", - "slug": "/database-access/enroll-aws-databases/", - "entries": [ - { - "title": "Amazon DynamoDB", - "slug": "/database-access/enroll-aws-databases/aws-dynamodb/" - }, - { - "title": "Amazon ElastiCache and MemoryDB for Redis", - "slug": "/database-access/enroll-aws-databases/redis-aws/" - }, - { - "title": "Amazon Keyspaces (Apache Cassandra)", - "slug": "/database-access/enroll-aws-databases/aws-cassandra-keyspaces/" - }, - { - "title": "Amazon OpenSearch", - "slug": "/database-access/enroll-aws-databases/aws-opensearch/" - }, - { - "title": "Amazon RDS Proxy for MariaDB/MySQL", - "slug": "/database-access/enroll-aws-databases/rds-proxy-mysql/" - }, - { - "title": "Amazon RDS Proxy for Microsoft SQL Server", - "slug": "/database-access/enroll-aws-databases/rds-proxy-sqlserver/" - }, - { - "title": "Amazon RDS Proxy for PostgreSQL", - "slug": "/database-access/enroll-aws-databases/rds-proxy-postgres/" - }, - { - "title": "Amazon RDS and Aurora", - "slug": "/database-access/enroll-aws-databases/rds/" - }, - { - "title": "Amazon RDS for Microsoft SQL Server", - "slug": "/database-access/enroll-aws-databases/sql-server-ad/" - }, - { - "title": "Amazon Redshift", - "slug": "/database-access/enroll-aws-databases/postgres-redshift/" - }, - { - "title": "Amazon Redshift Serverless", - "slug": "/database-access/enroll-aws-databases/redshift-serverless/" - }, - { - "title": "Cross-Account Access", - "slug": "/database-access/enroll-aws-databases/aws-cross-account/" - } - ] - }, - { - "title": "Azure Databases", - "slug": "/database-access/enroll-azure-databases/", - "entries": [ - { - "title": "SQL Server on Azure", - "slug": "/database-access/enroll-azure-databases/azure-sql-server-ad/" - }, - { - "title": "Azure PostgreSQL and MySQL", - "slug": "/database-access/enroll-azure-databases/azure-postgres-mysql/" - }, - { - "title": "Azure Cache for Redis", - "slug": "/database-access/enroll-azure-databases/azure-redis/" - } - ] - }, - { - "title": "Google Cloud Databases", - "slug": "/database-access/enroll-google-cloud-databases/", - "entries": [ - { - "title": "Cloud Spanner", - "slug": "/database-access/enroll-google-cloud-databases/spanner/" - }, - { - "title": "Cloud SQL for MySQL", - "slug": "/database-access/enroll-google-cloud-databases/mysql-cloudsql/" - }, - { - "title": "Cloud SQL for PostgreSQL", - "slug": "/database-access/enroll-google-cloud-databases/postgres-cloudsql/" - } - ] - }, - { - "title": "Database Clouds", - "slug": "/database-access/enroll-managed-databases/", - "entries": [ - { - "title": "MongoDB Atlas", - "slug": "/database-access/enroll-managed-databases/mongodb-atlas/" - }, - { - "title": "Snowflake", - "slug": "/database-access/enroll-managed-databases/snowflake/" - } - ] - }, - { - "title": "Self-Hosted Databases", - "slug": "/database-access/enroll-self-hosted-databases/", - "entries": [ - { - "title": "Vitess (MySQL protocol)", - "slug": "/database-access/enroll-self-hosted-databases/vitess/" - }, - { - "title": "Oracle", - "slug": "/database-access/enroll-self-hosted-databases/oracle-self-hosted/" - }, - { - "title": "CockroachDB", - "slug": "/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted/" - }, - { - "title": "Elasticsearch", - "slug": "/database-access/enroll-self-hosted-databases/elastic/" - }, - { - "title": "ClickHouse", - "slug": "/database-access/enroll-self-hosted-databases/clickhouse-self-hosted/" - }, - { - "title": "MySQL/MariaDB", - "slug": "/database-access/enroll-self-hosted-databases/mysql-self-hosted/" - }, - { - "title": "MongoDB", - "slug": "/database-access/enroll-self-hosted-databases/mongodb-self-hosted/" - }, - { - "title": "Microsoft SQL Server access with PKINIT authentication", - "slug": "/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit/" - }, - { - "title": "Cassandra and ScyllaDB", - "slug": "/database-access/enroll-self-hosted-databases/cassandra-self-hosted/" - }, - { - "title": "Redis", - "slug": "/database-access/enroll-self-hosted-databases/redis/" - }, - { - "title": "Redis Cluster", - "slug": "/database-access/enroll-self-hosted-databases/redis-cluster/" - }, - { - "title": "PostgreSQL", - "slug": "/database-access/enroll-self-hosted-databases/postgres-self-hosted/" - } - ] - }, - { - "title": "Using the Teleport Database Service", - "slug": "/database-access/guides/" - }, - { - "title": "Reference", - "slug": "/database-access/reference/", - "entries": [ - { - "title": "Configuration", - "slug": "/database-access/reference/configuration/" - }, - { - "title": "CLI", - "slug": "/database-access/reference/cli/" - }, - { - "title": "Audit Events", - "slug": "/database-access/reference/audit/" - }, - { - "title": "AWS IAM", - "slug": "/database-access/reference/aws/" - }, - { - "title": "Database Labels", - "slug": "/database-access/reference/labels/" - } - ] - }, - { - "title": "FAQ", - "slug": "/database-access/faq/" - }, - { - "title": "Troubleshooting", - "slug": "/database-access/troubleshooting/" - } - ] - }, - { - "icon": "desktop", - "title": "Desktop Access", - "entries": [ - { - "title": "Introduction", - "slug": "/desktop-access/introduction/" - }, - { - "title": "Configure local Windows users", - "slug": "/desktop-access/getting-started/" - }, - { - "title": "Active Directory", - "slug": "/desktop-access/active-directory/" - }, - { - "title": "Access Controls", - "slug": "/desktop-access/rbac/" - }, - { - "title": "Directory Sharing", - "slug": "/desktop-access/directory-sharing/" - }, - { - "title": "Reference", - "slug": "/desktop-access/reference/", - "entries": [ - { - "title": "Configuration", - "slug": "/desktop-access/reference/configuration/" - }, - { - "title": "Audit Events", - "slug": "/desktop-access/reference/audit/" - }, - { - "title": "Clipboard Sharing", - "slug": "/desktop-access/reference/clipboard/" - }, - { - "title": "Session Recording", - "slug": "/desktop-access/reference/sessions/" - }, - { - "title": "CLI", - "slug": "/desktop-access/reference/cli/" - } - ] - }, - { - "title": "Troubleshooting", - "slug": "/desktop-access/troubleshooting/" - } - ] - }, - { - "icon": "chip", - "title": "Machine ID", - "entries": [ - { - "title": "Introduction", - "slug": "/machine-id/introduction/" - }, - { - "title": "Getting Started", - "slug": "/machine-id/getting-started/" - }, - { - "title": "Deploying Machine ID", - "slug": "/machine-id/deployment/", - "entries": [ - { - "title": "AWS", - "slug": "/machine-id/deployment/aws/" - }, - { - "title": "Google Cloud", - "slug": "/machine-id/deployment/gcp/" - }, - { - "title": "Azure", - "slug": "/machine-id/deployment/azure/" - }, - { - "title": "CircleCI", - "slug": "/machine-id/deployment/circleci/" - }, - { - "title": "GitHub Actions", - "slug": "/machine-id/deployment/github-actions/" - }, - { - "title": "GitLab", - "slug": "/machine-id/deployment/gitlab/" - }, - { - "title": "Jenkins", - "slug": "/machine-id/deployment/jenkins/" - }, - { - "title": "Linux Server", - "slug": "/machine-id/deployment/linux/" - }, - { - "title": "Linux Server (TPM)", - "slug": "/machine-id/deployment/linux-tpm/" - }, - { - "title": "Kubernetes", - "slug": "/machine-id/deployment/kubernetes/" - }, - { - "title": "Spacelift", - "slug": "/machine-id/deployment/spacelift/" - } - ] - }, - { - "title": "Accessing Infrastructure with Machine ID", - "slug": "/machine-id/access-guides/", - "entries": [ - { - "title": "tctl", - "slug": "/machine-id/access-guides/tctl/" - }, - { - "title": "Kubernetes", - "slug": "/machine-id/access-guides/kubernetes/" - }, - { - "title": "Terraform", - "slug": "/machine-id/access-guides/terraform/" - }, - { - "title": "Applications", - "slug": "/machine-id/access-guides/applications/" - }, - { - "title": "Databases", - "slug": "/machine-id/access-guides/databases/" - }, - { - "title": "SSH", - "slug": "/machine-id/access-guides/ssh/" - }, - { - "title": "Ansible", - "slug": "/machine-id/access-guides/ansible/" - } - ] - }, - { - "title": "Architecture", - "slug": "/machine-id/architecture/" - }, - { - "title": "Reference", - "slug": "/machine-id/reference/", - "entries": [ - { - "title": "Configuration", - "slug": "/machine-id/reference/configuration/" - }, - { - "title": "GitHub Actions", - "slug": "/machine-id/reference/github-actions/" - }, - { - "title": "GitLab", - "slug": "/machine-id/reference/gitlab/" - }, - { - "title": "Telemetry", - "slug": "/machine-id/reference/telemetry/" - }, - { - "title": "Upgrading to v14", - "slug": "/machine-id/reference/v14-upgrade-guide/" - } - ] - }, - { - "title": "Workload Identity (SPIFFE)", - "slug": "/machine-id/workload-identity/", - "entries": [ - { - "title": "Getting Started", - "slug": "/machine-id/workload-identity/getting-started/" - }, - { - "title": "Best Practices", - "slug": "/machine-id/workload-identity/best-practices/" - }, - { - "title": "Tsh Support", - "slug": "/machine-id/workload-identity/tsh/" - } - ] - }, - { - "title": "FAQ", - "slug": "/machine-id/faq/" - }, - { - "title": "Troubleshooting", - "slug": "/machine-id/troubleshooting/" + "title": "Teleport CLI", + "slug": "/connect-your-client/tsh/" }, - { - "title": "Manifesto", - "slug": "/machine-id/manifesto/" - } + { + "title": "All Topics", + "slug": "/connect-your-client/" + } ] }, { "icon": "book", - "title": "Reference", + "title": "References", "entries": [ + { + "title": "CLI Reference", + "slug": "/reference/cli/overview/" + }, + { + "title": "Terraform Provider", + "slug": "/reference/config-references/terraform-provider/" + }, { "title": "All Topics", "slug": "/reference/" @@ -1314,731 +174,5 @@ } } }, - "redirects": [ - { - "source": "/enterprise/ssh_sso/", - "destination": "/access-controls/sso/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/migration/", - "destination": "/kubernetes-access/introduction/", - "permanent": true - }, - { - "source": "/setup/reference/license/", - "destination": "/choose-an-edition/teleport-enterprise/license/", - "permanent": true - }, - { - "source": "/intro/", - "destination": "/", - "permanent": true - }, - { - "source": "/server-access/guides/tsh/", - "destination": "/connect-your-client/tsh/", - "permanent": true - }, - { - "source": "/cluster/", - "destination": "/kubernetes-access/getting-started/", - "permanent": true - }, - { - "source": "/application-access/guides/jwt/", - "destination": "/application-access/jwt/", - "permanent": true - }, - { - "source": "/getting-started/digitalocean/", - "destination": "/", - "permanent": true - }, - { - "source": "/kubernetes-access/getting-started/agent/", - "destination": "/kubernetes-access/getting-started/", - "permanent": true - }, - { - "source": "/kubernetes-access/getting-started/local/", - "destination": "/kubernetes-access/", - "permanent": true - }, - { - "source": "/access-controls/guides/u2f/", - "destination": "/access-controls/guides/webauthn/", - "permanent": true - }, - { - "source": "/enterprise/workflow/", - "destination": "/access-controls/access-requests/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-mattermost/", - "destination": "/access-controls/access-request-plugins/ssh-approval-mattermost/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-pagerduty/", - "destination": "/access-controls/access-request-plugins/ssh-approval-pagerduty/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-jira-server/", - "destination": "/access-controls/access-request-plugins/ssh-approval-jira/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-jira-cloud/", - "destination": "/access-controls/access-request-plugins/ssh-approval-jira/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-jira-cloud/", - "destination": "/access-controls/access-request-plugins/ssh-approval-jira/", - "permanent": true - }, - { - "source": "/enterprise/workflow/ssh-approval-slack/", - "destination": "/access-controls/access-request-plugins/ssh-approval-slack/", - "permanent": true - }, - { - "source": "/enterprise/workflow/resource-requests/", - "destination": "/access-controls/access-requests/resource-requests/", - "permanent": true - }, - { - "source": "/enterprise/workflow/role-requests/", - "destination": "/access-controls/access-requests/role-requests/", - "permanent": true - }, - { - "source": "/user-manual/", - "destination": "/", - "permanent": true - }, - { - "source": "/enterprise/fedramp/", - "destination": "/access-controls/compliance-frameworks/fedramp/", - "permanent": true - }, - { - "source": "/enterprise/soc2/", - "destination": "/access-controls/compliance-frameworks/soc2/", - "permanent": true - }, - { - "source": "/enterprise/sso/", - "destination": "/access-controls/sso/", - "permanent": true - }, - { - "source": "/enterprise/sso/adfs/", - "destination": "/access-controls/sso/adfs/", - "permanent": true - }, - { - "source": "/enterprise/sso/azuread/", - "destination": "/access-controls/sso/azuread/", - "permanent": true - }, - { - "source": "/setup/admin/github-sso/", - "destination": "/access-controls/sso/github-sso/", - "permanent": true - }, - { - "source": "/enterprise/sso/gitlab/", - "destination": "/access-controls/sso/gitlab/", - "permanent": true - }, - { - "source": "/enterprise/sso/google-workspace/", - "destination": "/access-controls/sso/google-workspace/", - "permanent": true - }, - { - "source": "/enterprise/sso/oidc/", - "destination": "/access-controls/sso/oidc/", - "permanent": true - }, - { - "source": "/enterprise/sso/okta/", - "destination": "/access-controls/sso/okta/", - "permanent": true - }, - { - "source": "/enterprise/sso/one-login/", - "destination": "/access-controls/sso/one-login/", - "permanent": true - }, - { - "source": "/database-access/guides/gui-clients/", - "destination": "/connect-your-client/gui-clients/", - "permanent": true - }, - { - "source": "/use-teleport/teleport-connect/", - "destination": "/connect-your-client/teleport-connect/", - "permanent": true - }, - { - "source": "/use-teleport/tsh/", - "destination": "/connect-your-client/tsh/", - "permanent": true - }, - { - "source": "/setup/deployments/digitalocean/", - "destination": "/", - "permanent": true - }, - { - "source": "/getting-started/linux-server/", - "destination": "/", - "permanent": true - }, - { - "source": "/cloud/architecture/", - "destination": "/choose-an-edition/teleport-cloud/architecture/", - "permanent": true - }, - { - "source": "/cloud/downloads/", - "destination": "/choose-an-edition/teleport-cloud/downloads/", - "permanent": true - }, - { - "source": "/cloud/faq/", - "destination": "/choose-an-edition/teleport-cloud/faq/", - "permanent": true - }, - { - "source": "/cloud/getting-started/", - "destination": "/choose-an-edition/teleport-cloud/get-started/", - "permanent": true - }, - { - "source": "/cloud/introduction/", - "destination": "/choose-an-edition/teleport-cloud/", - "permanent": true - }, - { - "source": "/enterprise/getting-started/", - "destination": "/choose-an-edition/teleport-enterprise/introduction/", - "permanent": true - }, - { - "source": "/enterprise/hsm/", - "destination": "/choose-an-edition/teleport-enterprise/hsm/", - "permanent": true - }, - { - "source": "/enterprise/introduction/", - "destination": "/choose-an-edition/teleport-enterprise/introduction/", - "permanent": true - }, - { - "source": "/enterprise/license/", - "destination": "/choose-an-edition/teleport-enterprise/license/", - "permanent": true - }, - { - "source": "/machine-id/reference/cli/", - "destination": "/reference/cli/", - "permanent": true - }, - { - "source": "/setup/guides/docker/", - "destination": "/installation/", - "permanent": true - }, - { - "source": "/setup/operations/upgrading/", - "destination": "/upgrading/", - "permanent": true - }, - { - "source": "/setup/reference/cli/", - "destination": "/reference/cli/", - "permanent": true - }, - { - "source": "/getting-started/docker-compose/", - "destination": "/", - "permanent": true - }, - { - "source": "/getting-started/local-kubernetes/", - "destination": "/", - "permanent": true - }, - { - "source": "/architecture/overview/", - "destination": "/core-concepts/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/cicd/", - "destination": "/machine-id/access-guides/kubernetes/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-cloud/architecture/", - "destination": "/choose-an-edition/teleport-cloud/architecture/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-cloud/downloads/", - "destination": "/choose-an-edition/teleport-cloud/downloads/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-cloud/faq/", - "destination": "/choose-an-edition/teleport-cloud/faq/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-cloud/getting-started/", - "destination": "/choose-an-edition/teleport-cloud/get-started/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-cloud/introduction/", - "destination": "/choose-an-edition/teleport-cloud/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-enterprise/gcp-kms/", - "destination": "/choose-an-edition/teleport-enterprise/gcp-kms/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-enterprise/getting-started/", - "destination": "/choose-an-edition/teleport-enterprise/introduction/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-enterprise/hsm/", - "destination": "/choose-an-edition/teleport-enterprise/hsm/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-enterprise/introduction/", - "destination": "/choose-an-edition/teleport-enterprise/introduction/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/teleport-enterprise/license/", - "destination": "/choose-an-edition/teleport-enterprise/license/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/deployments/digitalocean/", - "destination": "/", - "permanent": true - }, - { - "source": "/deploy-a-cluster/open-source/", - "destination": "/", - "permanent": true - }, - { - "source": "/getting-started/", - "destination": "/", - "permanent": true - }, - { - "source": "/application-access/guides/aws-console/", - "destination": "/application-access/cloud-apis/aws-console/", - "permanent": true - }, - { - "source": "/application-access/guides/azure/", - "destination": "/application-access/cloud-apis/azure/", - "permanent": true - }, - { - "source": "/database-access/guides/dynamodb/", - "destination": "/application-access/guides/dynamodb/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/dynamic-registration/", - "destination": "/kubernetes-access/register-clusters/dynamic-registration/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/multiple-clusters/", - "destination": "/kubernetes-access/getting-started/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/standalone-teleport/", - "destination": "/kubernetes-access/register-clusters/static-kubeconfig/", - "permanent": true - }, - { - "source": "/kubernetes-access/guides/", - "destination": "/kubernetes-access/introduction/", - "permanent": true - }, - { - "source": "/choose-an-edition/teleport-cloud/getting-started/", - "destination": "/choose-an-edition/teleport-cloud/get-started/", - "permanent": true - }, - { - "source": "/access-controls/faq/", - "destination": "/access-controls/introduction/", - "permanent": true - }, - { - "source": "/access-controls/teleport-policy/", - "destination": "/access-controls/teleport-policy/getting-started-policy/", - "permanent": true - }, - { - "source": "/try-out-teleport/", - "destination": "/", - "permanent": true - }, - { - "source": "/connect-your-client/", - "destination": "/connect-your-client/introduction/", - "permanent": true - }, - { - "source": "/preview/", - "destination": "/upcoming-releases/", - "permanent": true - }, - { - "source": "/try-out-teleport/browser-labs/", - "destination": "/", - "permanent": true - }, - { - "source": "/try-out-teleport/digitalocean/", - "destination": "/", - "permanent": true - }, - { - "source": "/try-out-teleport/docker-compose/", - "destination": "/", - "permanent": true - }, - { - "source": "/try-out-teleport/introduction/", - "destination": "/", - "permanent": true - }, - { - "source": "/try-out-teleport/local-kubernetes/", - "destination": "/", - "permanent": true - }, - { - "source": "/management/guides/docker/", - "destination": "/installation/", - "permanent": true - }, - { - "source": "/choose-an-edition/teleport-enterprise/getting-started/", - "destination": "/choose-an-edition/teleport-enterprise/introduction/", - "permanent": true - }, - { - "source": "/preview/upcoming-releases/", - "destination": "/upcoming-releases/", - "permanent": true - }, - { - "source": "/adopters/", - "destination": "/", - "permanent": true - }, - { - "source": "/choose-an-edition/teleport-cloud/", - "destination": "/choose-an-edition/teleport-cloud/", - "permanent": true - }, - { - "source": "/access-controls/guides/device-trust/", - "destination": "/access-controls/device-trust/guide/", - "permanent": true - }, - { - "source": "/access-controls/device-trust/auto-enrollment/", - "destination": "/access-controls/device-trust/device-management/", - "permanent": true - }, - { - "source": "/get-started/", - "destination": "/", - "permanent": true - }, - { - "source": "/machine-id/guides/", - "destination": "/machine-id/introduction/", - "permanent": true - }, - { - "source": "/machine-id/guides/applications/", - "destination": "/machine-id/access-guides/applications/", - "permanent": true - }, - { - "source": "/machine-id/guides/ansible/", - "destination": "/machine-id/access-guides/ansible/", - "permanent": true - }, - { - "source": "/machine-id/guides/databases/", - "destination": "/machine-id/access-guides/databases/", - "permanent": true - }, - { - "source": "/machine-id/guides/kubernetes/", - "destination": "/machine-id/access-guides/kubernetes/", - "permanent": true - }, - { - "source": "/machine-id/guides/circleci/", - "destination": "/machine-id/deployment/circleci/", - "permanent": true - }, - { - "source": "/machine-id/guides/jenkins/", - "destination": "/machine-id/deployment/jenkins/", - "permanent": true - }, - { - "source": "/machine-id/guides/gitlab/", - "destination": "/machine-id/deployment/gitlab/", - "permanent": true - }, - { - "source": "/machine-id/guides/gitlab/", - "destination": "/machine-id/deployment/github-actions/", - "permanent": true - }, - { - "source": "/connect-your-client/putty/", - "destination": "/connect-your-client/putty-winscp/", - "permanent": true - }, - { - "source": "/database-access/rbac/configuring-auto-user-provisioning/", - "destination": "/database-access/auto-user-provisioning/", - "permanent": true - }, - { - "source": "/database-access/guides/rds-proxy/", - "destination": "/database-access/guides/", - "permanent": true - }, - { - "source": "/machine-id/guides/github-actions/", - "destination": "/machine-id/deployment/github-actions/", - "permanent": true - }, - { - "source": "/management/dynamic-resources/spacelift/", - "destination": "/machine-id/deployment/spacelift/", - "permanent": true - }, - { - "source": "/management/operations/enroll-agent-into-automatic-updates/", - "destination": "/upgrading/", - "permanent": true - }, - { - "source": "/management/operations/self-hosted-automatic-agent-updates/", - "destination": "/upgrading/", - "permanent": true - }, - { - "source": "/management/operations/upgrading/", - "destination": "/upgrading/", - "permanent": true - }, - { - "source": "/access-graph/", - "destination": "/access-controls/access-graph/", - "permanent": true - }, - { - "source": "/choose-an-edition/teleport-team/", - "destination": "/choose-an-edition/teleport-cloud/get-started/", - "permanent": true - }, - { - "source": "/kubernetes-access/manage-access/rbac/", - "destination": "/kubernetes-access/manage-access/", - "permanent": true - }, - { - "source": "/database-access/rbac/configuring-access/", - "destination": "/database-access/rbac/", - "permanent": true - }, - { - "source": "/database-access/guides/aws-cassandra-keyspaces/", - "destination": "/database-access/enroll-aws-databases/aws-cassandra-keyspaces/", - "permanent": true - }, - { - "source": "/database-access/guides/aws-cross-account/", - "destination": "/database-access/enroll-aws-databases/aws-cross-account/", - "permanent": true - }, - { - "source": "/database-access/guides/aws-dynamodb/", - "destination": "/database-access/enroll-aws-databases/aws-dynamodb/", - "permanent": true - }, - { - "source": "/database-access/guides/aws-opensearch/", - "destination": "/database-access/enroll-aws-databases/aws-opensearch/", - "permanent": true - }, - { - "source": "/database-access/guides/azure-postgres-mysql/", - "destination": "/database-access/enroll-azure-databases/azure-postgres-mysql/", - "permanent": true - }, - { - "source": "/database-access/guides/azure-redis/", - "destination": "/database-access/enroll-azure-databases/azure-redis/", - "permanent": true - }, - { - "source": "/database-access/guides/azure-sql-server-ad/", - "destination": "/database-access/enroll-azure-databases/azure-sql-server-ad/", - "permanent": true - }, - { - "source": "/database-access/guides/cassandra-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/cassandra-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/clickhouse-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/clickhouse-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/cockroachdb-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/elastic/", - "destination": "/database-access/enroll-self-hosted-databases/elastic/", - "permanent": true - }, - { - "source": "/database-access/guides/mongodb-atlas/", - "destination": "/database-access/enroll-managed-databases/mongodb-atlas/", - "permanent": true - }, - { - "source": "/database-access/guides/mongodb-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/mongodb-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/mysql-cloudsql/", - "destination": "/database-access/enroll-google-cloud-databases/mysql-cloudsql/", - "permanent": true - }, - { - "source": "/database-access/guides/mysql-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/mysql-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/oracle-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/oracle-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/postgres-cloudsql/", - "destination": "/database-access/enroll-google-cloud-databases/postgres-cloudsql/", - "permanent": true - }, - { - "source": "/database-access/guides/postgres-redshift/", - "destination": "/database-access/enroll-aws-databases/postgres-redshift/", - "permanent": true - }, - { - "source": "/database-access/guides/postgres-self-hosted/", - "destination": "/database-access/enroll-self-hosted-databases/postgres-self-hosted/", - "permanent": true - }, - { - "source": "/database-access/guides/rds-proxy-mysql/", - "destination": "/database-access/enroll-aws-databases/rds-proxy-mysql/", - "permanent": true - }, - { - "source": "/database-access/guides/rds-proxy-postgres/", - "destination": "/database-access/enroll-aws-databases/rds-proxy-postgres/", - "permanent": true - }, - { - "source": "/database-access/guides/rds-proxy-sqlserver/", - "destination": "/database-access/enroll-aws-databases/rds-proxy-sqlserver/", - "permanent": true - }, - { - "source": "/database-access/guides/rds/", - "destination": "/database-access/enroll-aws-databases/rds/", - "permanent": true - }, - { - "source": "/database-access/guides/redis-aws/", - "destination": "/database-access/enroll-aws-databases/redis-aws/", - "permanent": true - }, - { - "source": "/database-access/guides/redis-cluster/", - "destination": "/database-access/enroll-self-hosted-databases/redis-cluster/", - "permanent": true - }, - { - "source": "/database-access/guides/redis/", - "destination": "/database-access/enroll-self-hosted-databases/redis/", - "permanent": true - }, - { - "source": "/database-access/guides/redshift-serverless/", - "destination": "/database-access/enroll-aws-databases/redshift-serverless/", - "permanent": true - }, - { - "source": "/database-access/guides/snowflake/", - "destination": "/database-access/enroll-managed-databases/snowflake/", - "permanent": true - }, - { - "source": "/database-access/guides/sql-server-ad-pkinit/", - "destination": "/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit/", - "permanent": true - }, - { - "source": "/database-access/guides/sql-server-ad/", - "destination": "/database-access/enroll-aws-databases/sql-server-ad/", - "permanent": true - }, - { - "source": "/database-access/guides/vitess/", - "destination": "/database-access/enroll-self-hosted-databases/vitess/", - "permanent": true - } - ] + "redirects": [] } diff --git a/docs/pages/access-controls/sso/overview.mdx b/docs/pages/access-controls/sso/overview.mdx index 995f43a66fc04..b5251cbc9773e 100644 --- a/docs/pages/access-controls/sso/overview.mdx +++ b/docs/pages/access-controls/sso/overview.mdx @@ -479,11 +479,11 @@ of SSO buttons in the Teleport Web UI. | Provider | YAML | Example | | - | - | - | -| GitHub | `display: GitHub` | ![github](../../img/teleport-sso/github@2x.png) | -| Microsoft | `display: Microsoft` | ![microsoft](../../img/teleport-sso/microsoft@2x.png) | -| Google | `display: Google` | ![google](../../img/teleport-sso/google@2x.png) | -| BitBucket | `display: Bitbucket` | ![bitbucket](../../img/teleport-sso/bitbucket@2x.png) | -| OpenID | `display: Okta` | ![Okta](../../img/teleport-sso/openId@2x.png) | +| GitHub | `display: GitHub` | ![github](../../../img/teleport-sso/github@2x.png) | +| Microsoft | `display: Microsoft` | ![microsoft](../../../img/teleport-sso/microsoft@2x.png) | +| Google | `display: Google` | ![google](../../../img/teleport-sso/google@2x.png) | +| BitBucket | `display: Bitbucket` | ![bitbucket](../../../img/teleport-sso/bitbucket@2x.png) | +| OpenID | `display: Okta` | ![Okta](../../../img/teleport-sso/openId@2x.png) | ## Troubleshooting @@ -511,7 +511,7 @@ If something is not working, we recommend to: If you get "access denied" or other login errors, the number one place to check is the Audit Log. You can access it in the **Activity** tab of the Teleport Web UI. -![Audit Log Entry for SSO Login error](../../img/sso/teleportauditlogssofailed.png) +![Audit Log Entry for SSO Login error](../../../img/sso/teleportauditlogssofailed.png) Example of a user being denied because the role `clusteradmin` wasn't set up: diff --git a/docs/pages/admin-guides.mdx b/docs/pages/admin-guides.mdx index cbc65bfde9dd1..4141a2e1bff9c 100644 --- a/docs/pages/admin-guides.mdx +++ b/docs/pages/admin-guides.mdx @@ -11,6 +11,7 @@ Contains guides for performing common tasks on a Teleport cluster after the init - [Backup and Restore](admin-guides/common-operations/backup-restore.mdx): How to back up and restore your Teleport cluster state. - [Exporting Teleport Audit Events (section)](admin-guides/common-operations/export-audit-events.mdx): Learn how to export Teleport audit events to your log management solution. +- [External Audit Storage](admin-guides/common-operations/external-audit-storage.mdx): Store audit logs and session recordings on your own infrastructure with Teleport Enterprise Cloud. - [Run Teleport as a Daemon](admin-guides/common-operations/daemon.mdx): Configure Teleport to run as a daemon using systemd - [Secure Practices for Teleport Clusters (section)](admin-guides/common-operations/security.mdx): Highlights recommended practices and ways to harden security for your Teleport cluster. - [Troubleshooting](admin-guides/common-operations/troubleshooting.mdx): Troubleshooting and Collecting Metrics of Teleport Processes @@ -21,7 +22,7 @@ Contains guides for performing common tasks on a Teleport cluster after the init Use configuration files and dynamic resources to adjust access controls, enroll infrastructure resources, and edit cluster-wide settings. ([more info](admin-guides/configure-teleport.mdx)) -- [Dynamic Resources (section)](admin-guides/configure-teleport/dynamic-resources.mdx): Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. +- [Infrastructure as Code Guides (section)](admin-guides/configure-teleport/dynamic-resources.mdx): Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. - [Teleport API Introduction (section)](admin-guides/configure-teleport/api.mdx): Introduction to the Teleport gRPC API. ## Protect Infrastructure Resources @@ -38,8 +39,11 @@ Guides for enrolling servers, databases, and other infrastructure resources with Guides to deploying and managing the Teleport Auth Service and Proxy Service. ([more info](admin-guides/self-hosting.mdx)) - [Deploying a Self-Hosted Teleport Cluster (section)](admin-guides/self-hosting/deploy-a-cluster.mdx): Guides for deploying self-hosted Teleport clusters on various platforms and cloud providers. +- [Enterprise License File](admin-guides/self-hosting/license.mdx): How to manage your Teleport Enterprise license file. +- [Key Management in Self-Hosted Teleport (section)](admin-guides/self-hosting/key-management.mdx): Guides for managing private key material in self-hosted Teleport clusters. - [Manage a Self-Hosted Teleport Cluster (section)](admin-guides/self-hosting/management.mdx): Guides to completing common tasks on self-hosted Teleport clusters after the initial deployment. - [Running a Self-Hosted Teleport Demo Cluster (section)](admin-guides/self-hosting/demo-clusters.mdx): Guides to running small-scale, self-hosted Teleport clusters to test functionality. +- [Self-Hosted Teleport Enterprise Overview](admin-guides/self-hosting/introduction.mdx): Introduction to features and benefits of using Teleport Enterprise. ## Teleport Access Controls diff --git a/docs/pages/admin-guides/common-operations.mdx b/docs/pages/admin-guides/common-operations.mdx index 035bc12b2dca5..18fe018cb2c1e 100644 --- a/docs/pages/admin-guides/common-operations.mdx +++ b/docs/pages/admin-guides/common-operations.mdx @@ -6,6 +6,7 @@ description: Contains guides for performing common tasks on a Teleport cluster a {/*TOPICS*/} - [Backup and Restore](common-operations/backup-restore.mdx): How to back up and restore your Teleport cluster state. +- [External Audit Storage](common-operations/external-audit-storage.mdx): Store audit logs and session recordings on your own infrastructure with Teleport Enterprise Cloud. - [Run Teleport as a Daemon](common-operations/daemon.mdx): Configure Teleport to run as a daemon using systemd - [Troubleshooting](common-operations/troubleshooting.mdx): Troubleshooting and Collecting Metrics of Teleport Processes - [Uninstall Teleport](common-operations/uninstall-teleport.mdx): How to remove Teleport from your system diff --git a/docs/pages/choose-an-edition/teleport-cloud/external-audit-storage.mdx b/docs/pages/admin-guides/common-operations/external-audit-storage.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-cloud/external-audit-storage.mdx rename to docs/pages/admin-guides/common-operations/external-audit-storage.mdx diff --git a/docs/pages/admin-guides/configure-teleport.mdx b/docs/pages/admin-guides/configure-teleport.mdx index 9f846c5d7a1dd..f73701ff38e33 100644 --- a/docs/pages/admin-guides/configure-teleport.mdx +++ b/docs/pages/admin-guides/configure-teleport.mdx @@ -8,18 +8,18 @@ enroll infrastructure resources, and edit cluster-wide settings. {/*TOPICS*/} -## Dynamic Resources +## Infrastructure as Code Guides Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. ([more info](configure-teleport/dynamic-resources.mdx)) - [Creating Access Lists with IaC](configure-teleport/dynamic-resources/access-list.mdx): Use Infrastructure-as-Code tooling to create Teleport AccessLists. - [Kubernetes Operator in teleport-cluster Helm chart](configure-teleport/dynamic-resources/teleport-operator-helm.mdx): Deploy the operator alongside your Helm-deployed Teleport Cluster. +- [Manage Teleport with Infrastructure as Code](configure-teleport/dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. - [Managing Users And Roles With IaC](configure-teleport/dynamic-resources/user-and-role.mdx): Use infrastructure-as-code tooling to create Teleport users and roles. - [Registering Agentless OpenSSH Servers with IaC](configure-teleport/dynamic-resources/agentless-ssh-servers.mdx): Use infrastructure-as-code tooling to register Agentless OpenSSH servers in Teleport. - [Set up the Teleport Terraform Provider](configure-teleport/dynamic-resources/terraform-provider.mdx): How to manage dynamic resources using the Teleport Terraform provider. - [Standalone Kubernetes Operator](configure-teleport/dynamic-resources/teleport-operator-standalone.mdx): Run a standalone operator against a remote Teleport cluster such as Teleport Cloud. - [Teleport Kubernetes Operator](configure-teleport/dynamic-resources/teleport-operator.mdx): Easily manage Teleport resources from Kubernetes -- [Using Dynamic Resources](configure-teleport/dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. ## Teleport API Introduction diff --git a/docs/pages/admin-guides/configure-teleport/dynamic-resources.mdx b/docs/pages/admin-guides/configure-teleport/dynamic-resources.mdx index c252e18baf6d7..6badbef753fe5 100644 --- a/docs/pages/admin-guides/configure-teleport/dynamic-resources.mdx +++ b/docs/pages/admin-guides/configure-teleport/dynamic-resources.mdx @@ -1,5 +1,5 @@ --- -title: Dynamic Resources +title: Infrastructure as Code Guides description: Guides to using Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. --- @@ -11,9 +11,9 @@ infrastructure changes. - [Creating Access Lists with IaC](dynamic-resources/access-list.mdx): Use Infrastructure-as-Code tooling to create Teleport AccessLists. - [Kubernetes Operator in teleport-cluster Helm chart](dynamic-resources/teleport-operator-helm.mdx): Deploy the operator alongside your Helm-deployed Teleport Cluster. +- [Manage Teleport with Infrastructure as Code](dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. - [Managing Users And Roles With IaC](dynamic-resources/user-and-role.mdx): Use infrastructure-as-code tooling to create Teleport users and roles. - [Registering Agentless OpenSSH Servers with IaC](dynamic-resources/agentless-ssh-servers.mdx): Use infrastructure-as-code tooling to register Agentless OpenSSH servers in Teleport. - [Set up the Teleport Terraform Provider](dynamic-resources/terraform-provider.mdx): How to manage dynamic resources using the Teleport Terraform provider. - [Standalone Kubernetes Operator](dynamic-resources/teleport-operator-standalone.mdx): Run a standalone operator against a remote Teleport cluster such as Teleport Cloud. - [Teleport Kubernetes Operator](dynamic-resources/teleport-operator.mdx): Easily manage Teleport resources from Kubernetes -- [Using Dynamic Resources](dynamic-resources/overview.mdx): An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. diff --git a/docs/pages/admin-guides/configure-teleport/dynamic-resources/overview.mdx b/docs/pages/admin-guides/configure-teleport/dynamic-resources/overview.mdx index 8616f89646bfc..d9e529b81d7d5 100644 --- a/docs/pages/admin-guides/configure-teleport/dynamic-resources/overview.mdx +++ b/docs/pages/admin-guides/configure-teleport/dynamic-resources/overview.mdx @@ -1,5 +1,5 @@ --- -title: Using Dynamic Resources +title: Manage Teleport with Infrastructure as Code description: An introduction to Teleport's dynamic resources, which make it possible to apply settings to remote clusters using infrastructure as code. tocDepth: 3 --- @@ -24,7 +24,7 @@ There are two ways to configure a Teleport cluster: This approach makes it possible to incrementally adjust your Teleport configuration without restarting Teleport instances. -![Architecture of dynamic resources](../../img/dynamic-resources.png) +![Architecture of dynamic resources](../../../../img/dynamic-resources.png) A cluster is composed of different objects (i.e., resources) and there are three common operations that can be performed on them: `get` , `create` , and `remove` diff --git a/docs/pages/admin-guides/protect-resources.mdx b/docs/pages/admin-guides/protect-resources.mdx index 46a32eaeab184..9e6c2af2b25c4 100644 --- a/docs/pages/admin-guides/protect-resources.mdx +++ b/docs/pages/admin-guides/protect-resources.mdx @@ -3,6 +3,17 @@ title: Protect Infrastructure Resources description: Guides for enrolling servers, databases, and other infrastructure resources with Teleport so you can set up secure access. --- +You can use Teleport to set up secure access to resources in your infrastructure +such as Linux servers, databases, and Windows desktops. + +The guides in this section show you how to enroll infrastructure resources in +your Teleport cluster. + +Teleport **Agents** are Teleport processes that proxy traffic to and from +infrastructure resources. Agents check the permissions of a user who attempts +to access proxied resources, and only permit a connection to a resource if the +resource's **labels** match the labels allowed by the user's role. + {/*TOPICS*/} - [AWS OIDC Integration](protect-resources/awsoidc-integration.mdx): How to connect your AWS account with Teleport and provide access to AWS resources. diff --git a/docs/pages/admin-guides/self-hosting.mdx b/docs/pages/admin-guides/self-hosting.mdx index 4870f6de365c4..1b733a1d46092 100644 --- a/docs/pages/admin-guides/self-hosting.mdx +++ b/docs/pages/admin-guides/self-hosting.mdx @@ -5,6 +5,9 @@ description: Guides to deploying and managing the Teleport Auth Service and Prox {/*TOPICS*/} +- [Enterprise License File](self-hosting/license.mdx): How to manage your Teleport Enterprise license file. +- [Self-Hosted Teleport Enterprise Overview](self-hosting/introduction.mdx): Introduction to features and benefits of using Teleport Enterprise. + ## Deploying a Self-Hosted Teleport Cluster Guides for deploying self-hosted Teleport clusters on various platforms and cloud providers. ([more info](self-hosting/deploy-a-cluster.mdx)) @@ -15,6 +18,14 @@ Guides for deploying self-hosted Teleport clusters on various platforms and clou - [Reference Deployment Guides (section)](self-hosting/deploy-a-cluster/deployments.mdx): How to deploy a self-hosted Teleport cluster on different cloud providers. - [Running a Production Teleport Cluster](self-hosting/deploy-a-cluster/introduction.mdx): Guides to running Teleport in production. +## Key Management in Self-Hosted Teleport + +Guides for managing private key material in self-hosted Teleport clusters. ([more info](self-hosting/key-management.mdx)) + +- [AWS KMS](self-hosting/key-management/aws-kms.mdx): Configure Teleport to store CA private keys in the AWS Key Management Service +- [Google Cloud KMS](self-hosting/key-management/gcp-kms.mdx): Configure Teleport to store CA private keys in the Google Cloud Key Management Service +- [HSM Support](self-hosting/key-management/hsm.mdx): How to configure Hardware Security Modules to manage your Teleport CA private keys + ## Manage a Self-Hosted Teleport Cluster Guides to completing common tasks on self-hosted Teleport clusters after the initial deployment. ([more info](self-hosting/management.mdx)) diff --git a/docs/pages/choose-an-edition/teleport-enterprise/introduction.mdx b/docs/pages/admin-guides/self-hosting/introduction.mdx similarity index 97% rename from docs/pages/choose-an-edition/teleport-enterprise/introduction.mdx rename to docs/pages/admin-guides/self-hosting/introduction.mdx index 4f5c2fb1c4144..26764f68e3170 100644 --- a/docs/pages/choose-an-edition/teleport-enterprise/introduction.mdx +++ b/docs/pages/admin-guides/self-hosting/introduction.mdx @@ -1,6 +1,6 @@ --- -title: Teleport Enterprise -description: Introduction to features and benefits of using Teleport Enterprise. Why upgrade to Teleport Enterprise? +title: Self-Hosted Teleport Enterprise Overview +description: Introduction to features and benefits of using Teleport Enterprise. h1: Teleport Enterprise --- diff --git a/docs/pages/admin-guides/self-hosting/key-management.mdx b/docs/pages/admin-guides/self-hosting/key-management.mdx new file mode 100644 index 0000000000000..42e97c1bc77bc --- /dev/null +++ b/docs/pages/admin-guides/self-hosting/key-management.mdx @@ -0,0 +1,10 @@ +--- +title: Key Management in Self-Hosted Teleport +description: Guides for managing private key material in self-hosted Teleport clusters. +--- + +{/*TOPICS*/} + +- [AWS KMS](key-management/aws-kms.mdx): Configure Teleport to store CA private keys in the AWS Key Management Service +- [Google Cloud KMS](key-management/gcp-kms.mdx): Configure Teleport to store CA private keys in the Google Cloud Key Management Service +- [HSM Support](key-management/hsm.mdx): How to configure Hardware Security Modules to manage your Teleport CA private keys diff --git a/docs/pages/choose-an-edition/teleport-enterprise/aws-kms.mdx b/docs/pages/admin-guides/self-hosting/key-management/aws-kms.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-enterprise/aws-kms.mdx rename to docs/pages/admin-guides/self-hosting/key-management/aws-kms.mdx diff --git a/docs/pages/choose-an-edition/teleport-enterprise/gcp-kms.mdx b/docs/pages/admin-guides/self-hosting/key-management/gcp-kms.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-enterprise/gcp-kms.mdx rename to docs/pages/admin-guides/self-hosting/key-management/gcp-kms.mdx diff --git a/docs/pages/choose-an-edition/teleport-enterprise/hsm.mdx b/docs/pages/admin-guides/self-hosting/key-management/hsm.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-enterprise/hsm.mdx rename to docs/pages/admin-guides/self-hosting/key-management/hsm.mdx diff --git a/docs/pages/choose-an-edition/teleport-enterprise/license.mdx b/docs/pages/admin-guides/self-hosting/license.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-enterprise/license.mdx rename to docs/pages/admin-guides/self-hosting/license.mdx diff --git a/docs/pages/choose-an-edition/introduction.mdx b/docs/pages/choose-an-edition/introduction.mdx deleted file mode 100644 index f5ed279e9229b..0000000000000 --- a/docs/pages/choose-an-edition/introduction.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "How to Choose a Teleport Edition" -description: "Determine whether to use the cloud-hosted Teleport Enterprise, host your own Teleport Enterprise deployment, or try Teleport Community Edition for personal use." ---- - -The fully-featured edition of Teleport is called **Teleport Enterprise**. - -For most users, we recommend [signing up](https://goteleport.com/signup) for a -cloud-hosted Teleport Enterprise account. Our team at Teleport manages the -Teleport Auth Service and Proxy Service, giving you a running Teleport cluster -where you can configure RBAC, set up Single Sign-On connectors, and register -resources by deploying additional Teleport services. - -[Read more about Teleport Enterprise -(cloud-hosted)](./teleport-cloud/introduction.mdx). - -## Self-hosting Teleport Enterprise - -For organizations with specific security needs, it is also possible to run a -self-hosted Teleport Enterprise cluster. Self-hosting Teleport Enterprise allows -you to set up advanced features like Hardware Security Modules and FedRAMP -compliance. - -[Read more about self-hosting Teleport -Enterprise](./teleport-enterprise/introduction.mdx). - -## Migrating Teleport Enterprise clusters to the cloud - -We recommend using the cloud-hosted edition of Teleport Enterprise for most -organizations, as it removes the overhead of maintaining, scaling, and securing -a deployment of the Auth Service and Proxy Service. To migrate from a -self-hosted Teleport Enterprise deployment to a cloud-hosted deployment, follow -the [migration guide](./migrate-to-cloud.mdx). - -## Teleport Community Edition - -For hobby and personal use, we provide a free, open source distribution of -Teleport that enables you to get secure access to databases, Windows desktops, -Kubernetes clusters, and more. - -[Try out Teleport on a Linux server](../index.mdx). If you would like to take a -look at the source, visit the [Teleport GitHub -repository](https://github.com/gravitational/teleport). - -## Comparing editions - -(!docs/pages/includes/edition-comparison.mdx!) diff --git a/docs/pages/choose-an-edition/teleport-enterprise.mdx b/docs/pages/choose-an-edition/teleport-enterprise.mdx deleted file mode 100644 index 2aec09e15c869..0000000000000 --- a/docs/pages/choose-an-edition/teleport-enterprise.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Self-Hosted Teleport Enterprise -description: How to get started with self-hosted Teleport Enterprise, which allows for full control of your Teleport cluster for situations with specific security requirements. ---- - -{/*TOPICS*/} - -- [AWS KMS](teleport-enterprise/aws-kms.mdx): Configure Teleport to store CA private keys in the AWS Key Management Service -- [Enterprise License File](teleport-enterprise/license.mdx): How to manage your Teleport Enterprise license file. -- [Google Cloud KMS](teleport-enterprise/gcp-kms.mdx): Configure Teleport to store CA private keys in the Google Cloud Key Management Service -- [HSM Support](teleport-enterprise/hsm.mdx): How to configure Hardware Security Modules to manage your Teleport CA private keys -- [Teleport Enterprise](teleport-enterprise/introduction.mdx): Introduction to features and benefits of using Teleport Enterprise. Why upgrade to Teleport Enterprise? diff --git a/docs/pages/choose-an-edition/teleport-cloud/downloads.mdx b/docs/pages/cloud-downloads.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-cloud/downloads.mdx rename to docs/pages/cloud-downloads.mdx diff --git a/docs/pages/documentation-overview.mdx b/docs/pages/documentation-overview.mdx deleted file mode 100644 index b68bbc87f1288..0000000000000 --- a/docs/pages/documentation-overview.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Documentation Overview -description: Explains the sections of the documentation. ---- - -This page provides a tour of the major sections of the Teleport documentation. - -We maintain a separate version of the Teleport documentation for each major -version of Teleport that we support. If you are running a version earlier than -v(=teleport.major_version=), or want a preview of the next version's -documentation, adjust the dropdown menu at the top of the page. - -## Get started - -If you are curious to see how Teleport works, you can get started by [spinning -up a demo cluster](./index.mdx) on a Linux server. After seeing how your demo -Teleport cluster lets you securely access a server and play back your SSH -sessions, you can configure RBAC, add resources, and protect your infrastructure -with Teleport. - -Once you are ready to learn more about Teleport, read our [Core Concepts -guide](./core-concepts.mdx), which introduces the components of a Teleport -cluster. You can refer to this glossary as you continue through the -documentation. - -## Critical guides - -Guides in the "Home" section include information that all Teleport users will -probably need to consult at some point: - -- [Installation](./installation.mdx): How to install Teleport binaries on your - environment. If you are just getting started with Teleport, we recommend - spinning up a [demo cluster](./index.mdx) or signing up for a [Teleport - Enterprise Cloud trial](https://goteleport.com/signup). -- [Frequently Asked Questions](./faq.mdx): If this page does not answer your - question, try our AI-assisted search box on the left sidebar. -- [Usage Reporting and Billing](./usage-billing.mdx): How Teleport calculates - usage metrics to determine customer billing. -- [Upcoming Releases](./upcoming-releases.mdx): Features to be introduced in - future versions of Teleport. -- [Changelog](./changelog.mdx): A comprehensive collection of release notes. - -## Choose an edition - -After trying out Teleport, you are ready to deploy a cluster to your -infrastructure. Teleport has three editions: - -- Teleport Enterprise Cloud -- Teleport Enterprise -- Teleport Community Edition - -You can compare these in our [Choose an -Edition](./choose-an-edition/introduction.mdx) section. - -## Deploy a cluster - -Once you know which edition you would like to deploy, read our [Deploy a -Cluster](./deploy-a-cluster/introduction.mdx) documentation for how to launch a -fully fledged Teleport cluster in production. (If you are using Teleport -Enterprise Cloud, you can skip this step.) This section shows you the best -practices to follow for a high-availability Teleport cluster, and how to deploy -Teleport on your cloud provider of choice. - -## Manage access - -Now that you have a running Teleport cluster, set up role-based access controls -to enable secure access to your infrastructure. You can define roles with -granular permissions and use Teleport's integrations with Single Sign-On -providers to automatically map these roles to users. You can also set up Access -Requests to enable just-in-time access to your infrastructure. Read [Manage -Access](./access-controls/introduction.mdx) to get started. - -## Manage your cluster - -With your Teleport cluster configured, you can now begin Day Two operations -such as upgrades, adding agents to the cluster, and integrating Teleport with -third-party tools. Read [Manage your -Cluster](./management/introduction.mdx) for more information. - -## Add your infrastructure - -Teleport is protocol aware and provides functionality that is unique to each -protocol it supports. To enable access to a protocol, deploy the appropriate -Teleport service and configure it to communicate with resources in your -infrastructure. - -Set up the [Teleport Discovery Service](./auto-discovery/introduction.mdx) to -automatically enroll infrastructure resources in your Teleport cluster. - -Read about how to enable access to: - -- [Servers](./server-access/getting-started.mdx), including OpenSSH servers that - [do not have Teleport installed](./server-access/openssh/openssh.mdx) -- [Kubernetes clusters](./kubernetes-access/introduction.mdx) -- [Databases](./database-access/introduction.mdx) -- [Applications](./application-access/introduction.mdx) -- [Remote desktops](./desktop-access/introduction.mdx) - -You can also set up [Machine ID](./machine-id/introduction.mdx) to enable -service accounts to access resources in your infrastructure with short-lived -credentials. - -## Extend Teleport for your organization - -Teleport is highly customizable, exposing much of its functionality via a gRPC -API. For example, you can build API clients to register infrastructure -automatically or manage Access Requests using your organization's unique -workflows. Read how to build applications that interact with Teleport's API in -our [API guides](./api/introduction.mdx). - -## Learn more about Teleport - -Get more information about Teleport by reading our library of architecture, -reference, and developer guides. See the -[Upcoming Releases](./upcoming-releases.mdx) section for a glimpse of features we -will release in the next Teleport version. Consult our -[Reference](./reference/introduction.mdx) guides for comprehensive lists of -configuration options, CLI flags, and more. For detailed explanations of how -Teleport works, see the [Architecture](./architecture/introduction.mdx) section. diff --git a/docs/pages/choose-an-edition/teleport-cloud/get-started.mdx b/docs/pages/get-started.mdx similarity index 72% rename from docs/pages/choose-an-edition/teleport-cloud/get-started.mdx rename to docs/pages/get-started.mdx index 25d70a629c7c7..91477baff1d69 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/get-started.mdx +++ b/docs/pages/get-started.mdx @@ -1,63 +1,56 @@ --- -title: "Get Started with Teleport Enterprise Cloud" -description: "Shows you how to set up a Teleport Enterprise Cloud account and protect your first resource with Teleport." +title: "Get Started with Teleport" +description: "Shows you how to set up a cloud-managed Teleport Enterprise account and protect your first resource with Teleport." tocDepth: 3 --- -Teleport Enterprise Cloud helps organizations provide secure access to their -infrastructure with minimal configuration and cluster management. +Teleport helps organizations provide secure access to their infrastructure with +minimal configuration and cluster management. -With Teleport Enterprise Cloud, the Teleport Auth Service and Teleport Proxy -Service are managed for you as cloud-based services. These services provide you -with immediate access to a scalable and fault-tolerant certificate authority and -reverse proxy that you don't need to manage or maintain. You can focus on -enrolling the resources you want to protect and configuring secure role-based -access for private and public networks across the globe. +With cloud-managed Teleport Enterprise, the Teleport Auth Service and Teleport +Proxy Service are managed for you as cloud-based services. These services +provide you with immediate access to a scalable and fault-tolerant certificate +authority and reverse proxy that you don't need to manage or maintain. You can +focus on enrolling the resources you want to protect and configuring secure +role-based access for private and public networks across the globe. -After you start a [free trial](https://goteleport.com/signup) of Teleport -Enterprise Cloud, you can set up role-based access control (RBAC), enable single -sign-on, and prevent unauthorized use of organization resources. - - - -For a detailed comparison of Teleport editions, including how Teleport -Enterprise Cloud compares to Teleport Enterprise, see [Choose an -Edition](introduction.mdx). - - +After you start a [free trial](https://goteleport.com/signup) of managed +Teleport Enterprise, you can set up role-based access control (RBAC), enable +single sign-on, and prevent unauthorized use of organization resources. This guide explains how to register a local server with a Teleport Enterprise -Cloud account. After you register the server, you can access it through the -Teleport Web UI in a browser or using the terminal. You can also record your -sessions, so you can review them later. +account. After you register the server, you can access it through the Teleport +Web UI in a browser or using the terminal. You can also record your sessions, so +you can review them later. ## Prerequisites -- A Teleport Enterprise Cloud account. You can sign up for a free trial at the - following page: +- A cloud-managed Teleport Enterprise account. You can sign up for a free trial + at the following page: https://goteleport.com/signup/ After you sign up, you receive an email invitation to activate your account. Use this account to authenticate your identity when you access the Teleport - Enterprise Cloud cluster. + Enterprise cluster. - Docker installed on your workstation. - This guide illustrates how to register a server with Teleport Enterprise Cloud - using a Docker container and the Teleport SSH Service. Docker is only required - for the local demo environment used in this guide. You can find installation + This guide illustrates how to register a server with Teleport Enterprise using + a Docker container and the Teleport SSH Service. Docker is only required for + the local demo environment used in this guide. You can find installation instructions for Docker on [Docker's website](https://docs.docker.com/get-docker/). If you want to register servers - in Teleport without using Docker, see the getting started guide for - [server access](../../server-access/getting-started.mdx). + in Teleport without using Docker, see the getting started guide for [server + access](../../server-access/getting-started.mdx). - The `tsh` client tool. The `tsh` client tool is only required to access the server from a terminal. - For installation instructions, see [Installation Guide](../../installation.mdx). - If you don't install the `tsh` client tool, you can access the server in - Teleport Enterprise Cloud using the Web UI through your browser. + For installation instructions, see [Installation + Guide](../../installation.mdx). If you don't install the `tsh` client tool, + you can access the server in Teleport Enterprise using the Web UI through your + browser. ## Step 1/5. Spin up a server @@ -65,12 +58,10 @@ To spin up a new server using Docker: 1. Open a terminal shell on your workstation. -1. Start a Docker container on your workstation to prepare a server that you want enroll -as a resource in your Teleport Enterprise Cloud cluster: +1. Start a Docker container on your workstation to prepare a server that you + want to enroll as a resource in your Teleport Enterprise cluster: - ```code - $ docker run --interactive --tty ubuntu:22.04 /bin/bash - ``` + ```code $ docker run --interactive --tty ubuntu:22.04 /bin/bash ``` This command starts a new shell session in the `ubuntu:22.04` container. @@ -95,14 +86,14 @@ To install the Teleport SSH Service on your server: The first time you sign in, you are prompted to add your first resource: - ![Add your first resource](../../../img/cloud/getting-started/add-my-first-resource@2x.png) + ![Add your first resource](../img/cloud/getting-started/add-my-first-resource@2x.png) 1. Click **Add my first resource**, and you will see the option to enroll resources in your Teleport cluster. 1. Type *server* in the search box to filter the list of resources: - ![Select resource type](../../../img/cloud/getting-started/choose-resource@2x.png) + ![Select resource type](../img/cloud/getting-started/choose-resource@2x.png) 1. Click *Ubuntu 14.04+* to register the server in the Docker container. @@ -110,7 +101,7 @@ To install the Teleport SSH Service on your server: for your multi-factor authentication device, then displays a script to install and configure the Teleport SSH Service. For example: - ![Configure resource](../../../img/cloud/getting-started/paste-script@2x.png) + ![Configure resource](../img/cloud/getting-started/paste-script@2x.png) 1. The Teleport installation script uses `sudo`, which is not installed on your Docker container. Before copying the command to run the installation script, @@ -129,18 +120,18 @@ into the container shell session. Leave the script running in the shell. After Teleport is installed on the server, you'll see a message in the Web UI that your new Teleport instance was successfully detected: - ![Connected successfully](../../../img/cloud/getting-started/successfully-connected@2x.png) + ![Connected successfully](../img/cloud/getting-started/successfully-connected@2x.png) To continue, click **Next**. 1. Confirm that you want to authenticate as the `root` user and click **Next**: - ![Choose your user](../../../img/cloud/getting-started/set-up-access@2x.png) + ![Choose your user](../img/cloud/getting-started/set-up-access@2x.png) 1. Respond to the MFA prompt again, then click **Test Connection** to verify access to the server. - ![Start session](../../../img/cloud/getting-started/test-connection@2x.png) + ![Start session](../img/cloud/getting-started/test-connection@2x.png) ## Step 3/5. Start a session @@ -182,7 +173,7 @@ To play back a session in the Teleport Web UI: step listed. For example: ![Session - recordings](../../../img/cloud/getting-started/session-recordings@2x.png) + recordings](../img/cloud/getting-started/session-recordings@2x.png) 1. Click **Play** to see a full recording of your session. @@ -235,7 +226,7 @@ of your cluster and the name of your Teleport user: ## Next steps -This guide introduced how you can use Teleport Enterprise Cloud to protect your +This guide introduced how you can use Teleport Enterprise to protect your infrastructure by demonstrating how to register a server with your Teleport cluster. diff --git a/docs/pages/choose-an-edition/teleport-cloud/ips.mdx b/docs/pages/ips.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-cloud/ips.mdx rename to docs/pages/ips.mdx diff --git a/docs/pages/reference.mdx b/docs/pages/reference.mdx index e0889eefbb530..09b2afed55c95 100644 --- a/docs/pages/reference.mdx +++ b/docs/pages/reference.mdx @@ -5,6 +5,13 @@ description: Comprehensive guides to commands, configuration options, and other {/*TOPICS*/} +## Frequently Asked Questions + +Contains guides to frequently asked questions for various Teleport features and use cases. ([more info](reference/faq.mdx)) + +- [Teleport Enterprise Cloud FAQ](reference/faq/cloud-hosting.mdx): Teleport cloud frequently asked questions. +- [Teleport FAQ](reference/faq/faq.mdx): Frequently Asked Questions About Using Teleport + ## Operational Reference Guides References for concepts and tools available for operating Teleport. ([more info](reference/operations.mdx)) @@ -35,6 +42,7 @@ Guides to the inner workings of components within a Teleport cluster. ([more inf - [Teleport Architecture Guides](reference/architecture/introduction.mdx): Get detailed information about how Teleport works - [Teleport Authentication](reference/architecture/authentication.mdx): This chapter explains how Teleport uses certificate authorities to authenticate users and services. - [Teleport Authorization](reference/architecture/authorization.mdx): This chapter explains how Teleport authorizes users and roles. +- [Teleport Enterprise Cloud Architecture](reference/architecture/cloud.mdx): Cloud security, availability, and networking details. - [Teleport Proxy Service](reference/architecture/proxy.mdx): Architecture of Teleport's identity-aware proxy service - [Teleport Session Recording](reference/architecture/session-recording.mdx): An overview of Teleport's session recording and its configuration - [Trusted Clusters Architecture](reference/architecture/trustedclusters.mdx): Deep dive into design of Teleport Trusted Clusters. diff --git a/docs/pages/reference/architecture.mdx b/docs/pages/reference/architecture.mdx index 4f351a3e04363..c76b87041fc50 100644 --- a/docs/pages/reference/architecture.mdx +++ b/docs/pages/reference/architecture.mdx @@ -13,6 +13,7 @@ description: Guides to the inner workings of components within a Teleport cluste - [Teleport Architecture Guides](architecture/introduction.mdx): Get detailed information about how Teleport works - [Teleport Authentication](architecture/authentication.mdx): This chapter explains how Teleport uses certificate authorities to authenticate users and services. - [Teleport Authorization](architecture/authorization.mdx): This chapter explains how Teleport authorizes users and roles. +- [Teleport Enterprise Cloud Architecture](architecture/cloud.mdx): Cloud security, availability, and networking details. - [Teleport Proxy Service](architecture/proxy.mdx): Architecture of Teleport's identity-aware proxy service - [Teleport Session Recording](architecture/session-recording.mdx): An overview of Teleport's session recording and its configuration - [Trusted Clusters Architecture](architecture/trustedclusters.mdx): Deep dive into design of Teleport Trusted Clusters. diff --git a/docs/pages/choose-an-edition/teleport-cloud/architecture.mdx b/docs/pages/reference/architecture/cloud.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-cloud/architecture.mdx rename to docs/pages/reference/architecture/cloud.mdx diff --git a/docs/pages/reference/faq.mdx b/docs/pages/reference/faq.mdx new file mode 100644 index 0000000000000..5329523b3b715 --- /dev/null +++ b/docs/pages/reference/faq.mdx @@ -0,0 +1,9 @@ +--- +title: Frequently Asked Questions +description: Contains guides to frequently asked questions for various Teleport features and use cases. +--- + +{/*TOPICS*/} + +- [Teleport Enterprise Cloud FAQ](faq/cloud-hosting.mdx): Teleport cloud frequently asked questions. +- [Teleport FAQ](faq/faq.mdx): Frequently Asked Questions About Using Teleport diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/reference/faq/cloud-hosting.mdx similarity index 100% rename from docs/pages/choose-an-edition/teleport-cloud/faq.mdx rename to docs/pages/reference/faq/cloud-hosting.mdx diff --git a/docs/pages/faq.mdx b/docs/pages/reference/faq/faq.mdx similarity index 100% rename from docs/pages/faq.mdx rename to docs/pages/reference/faq/faq.mdx diff --git a/package.json b/package.json index c16489d6315df..8b6232cdf6713 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "teleport-ui", "version": "1.0.0", "scripts": { - "all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/admin-guides,docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/choose-an-edition,docs/pages/machine-id,docs/pages/reference,docs/pages/application-access", + "all-topics": "node docs/gen-topic-pages/index.js --in docs/pages/admin-guides,docs/pages/database-access,docs/pages/access-controls,docs/pages/desktop-access,docs/pages/kubernetes-access,docs/pages/connect-your-client,docs/pages/machine-id,docs/pages/reference,docs/pages/application-access", "build-ui": "yarn build-ui-oss && yarn build-ui-e", "build-ui-oss": "yarn workspace @gravitational/teleport build", "build-ui-e": "yarn workspace @gravitational/teleport.e build",