Tweak messaging to anticipate a new linter (#22270)

In gravitational/docs#238, we will add a linter that lints for incorrect
usage of Teleport terms. This change fixes linter violations to
anticipate this new linter.

Changes include:

- Ensuring that Teleport service names are capitalized
- No longer using the "[Resource] Access" terminology. Instead, talk
  about adding resources, using Teleport services, etc.
This commit is contained in:
Paul Gottschling 2023-04-11 12:42:00 -04:00 committed by GitHub
parent afc449e01a
commit 1ee16dda12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 429 additions and 410 deletions

View file

@ -10,24 +10,24 @@ Platform:
* Resource Access Requests (Preview)
* Proxy Peering (Preview)
Server Access:
Server access:
* IP-Based Restrictions (Preview)
* Automatic User Provisioning (Preview)
Database Access:
Database access:
* Audit Logging for Microsoft SQL Server Database Access
* Snowflake Database Access (Preview)
* ElastiCache/MemoryDB Database Access (Preview)
* Audit Logging for Microsoft SQL Server database access
* Snowflake database access (Preview)
* ElastiCache/MemoryDB database access (Preview)
Teleport Connect:
* Teleport Connect for Server and Database Access (Preview)
* Teleport Connect for server and database access (Preview)
Machine ID:
* Machine ID Database Access Support (Preview)
* Machine ID database access support (Preview)
### Passwordless (Preview)
@ -90,32 +90,32 @@ Linux groups and assigned appropriate “sudoer” privileges.
To learn more about configuring automatic user provisioning read the guide:
https://goteleport.com/docs/server-access/guides/host-user-creation/.
### Audit Logging for Microsoft SQL Server Database Access
### Audit Logging for Microsoft SQL Server database access
Teleport 9 introduced a preview of Database Access support for Microsoft SQL
Teleport 9 introduced a preview of database access support for Microsoft SQL
Server which didnt include audit logging of user queries. Teleport 10 captures
users' queries and prepared statements and sends them to the audit log, similarly
to other supported database protocols.
Teleport Database Access for SQL Server remains in Preview mode with more UX
Teleport database access for SQL Server remains in Preview mode with more UX
improvements coming in future releases.
Refer to the guide to set up access to a SQL Server with Active Directory
authentication: https://goteleport.com/docs/database-access/guides/sql-server-ad/.
### Snowflake Database Access (Preview)
### Snowflake database access (Preview)
Teleport 10 brings support for Snowflake to Database Access. Administrators can
Teleport 10 brings support for Snowflake to database access. Administrators can
set up access to Snowflake databases through Teleport for their users with
standard Database Access features like role-based access control and audit
standard database access features like role-based access control and audit
logging, including query activity.
Connect your Snowflake database to Teleport following this guide:
https://goteleport.com/docs/database-access/guides/snowflake/.
### Elasticache/MemoryDB Database Access (Preview)
### Elasticache/MemoryDB database access (Preview)
Teleport 9 added Redis protocol support to Database Access. Teleport 10 improves
Teleport 9 added Redis protocol support to database access. Teleport 10 improves
this integration by adding native support for AWS-hosted Elasticache and
MemoryDB, including auto-discovery and automatic credential management in some
deployment configurations.
@ -123,18 +123,18 @@ deployment configurations.
Learn more about it in this guide:
https://goteleport.com/docs/database-access/guides/redis-aws/.
### Teleport Connect for Server and Database Access (Preview)
### Teleport Connect for server and database access (Preview)
Teleport Connect is a graphical macOS application that simplifies access to your
Teleport resources. Teleport Connect 10 supports Server Access and Database Access.
Teleport resources. Teleport Connect 10 supports server access and database access.
Other protocols and Windows support are coming in a future release.
Get Teleport Connect installer from the macOS tab on the downloads page:
https://goteleport.com/download/.
### Machine ID Database Access Support (Preview)
### Machine ID database access support (Preview)
In Teleport 10 weve added Database Access support to Machine ID. Applications
In Teleport 10 weve added database access support to Machine ID. Applications
can use Machine ID to access databases protected by Teleport.
You can find Machine ID guide for database access in the documentation:
@ -246,16 +246,16 @@ This release of Teleport contains multiple improvements and bug fixes.
* Fixed two potential panics. [#13590](https://github.com/gravitational/teleport/pull/13590), [#13655](https://github.com/gravitational/teleport/pull/13655)
* Fixed issue with enhanced session recording not working on recent Ubuntu versions. [#13650](https://github.com/gravitational/teleport/pull/13650)
* Fixed issue with CA rotation when Database Service does not contain any databases. [#13517](https://github.com/gravitational/teleport/pull/13517)
* Fixed issue with Desktop Access connection failing with "invalid channel name rdpsnd" error. [#13450](https://github.com/gravitational/teleport/issues/13450)
* Fixed issue with desktop access connection failing with "invalid channel name rdpsnd" error. [#13450](https://github.com/gravitational/teleport/issues/13450)
* Fixed issue with invalid Teleport config when enabling IMDSv2 in Terraform config. [#13537](https://github.com/gravitational/teleport/pull/13537)
## 9.3.6
This release of Teleport contains multiple improvements and bug fixes.
* Added Unicode clipboard support to Desktop Access. [#13391](https://github.com/gravitational/teleport/pull/13391)
* Added Unicode clipboard support to desktop access. [#13391](https://github.com/gravitational/teleport/pull/13391)
* Fixed backwards compatibility issue with fetch access requests from older servers. [#13490](https://github.com/gravitational/teleport/pull/13490)
* Fixed issue with Application Access requests periodically failing with 500 errors. [#13469](https://github.com/gravitational/teleport/pull/13469)
* Fixed issue with application access requests periodically failing with 500 errors. [#13469](https://github.com/gravitational/teleport/pull/13469)
* Fixed issues with pagination when displaying applications. [#13451](https://github.com/gravitational/teleport/pull/13451)
* Fixed file descriptor leak in Machine ID. [#13386](https://github.com/gravitational/teleport/pull/13386)
@ -264,10 +264,10 @@ This release of Teleport contains multiple improvements and bug fixes.
This release of Teleport contains multiple improvements and bug fixes.
* Fixed backwards compatibility issue with fetching access requests from older servers. [#13428](https://github.com/gravitational/teleport/pull/13428)
* Fixed issue with using Microsoft SQL Server Management Studio with Database Access. [#13337](https://github.com/gravitational/teleport/pull/13337)
* Fixed issue with using Microsoft SQL Server Management Studio with database access. [#13337](https://github.com/gravitational/teleport/pull/13337)
* Added support for `tsh proxy ssh -J` to improve interoperability with OpenSSH clients. [#13311](https://github.com/gravitational/teleport/pull/13311)
* Added ability to provide security context in Helm charts. [#13286](https://github.com/gravitational/teleport/pull/13286)
* Added Application and Database Access support to reference AWS Terraform deployment. [#13383](https://github.com/gravitational/teleport/pull/13383)
* Added Application and database access support to reference AWS Terraform deployment. [#13383](https://github.com/gravitational/teleport/pull/13383)
* Improved reliability of dialing Auth Server through the Proxy. [#13399](https://github.com/gravitational/teleport/pull/13399)
* Improved `kubectl exec` auditing by logging access denied attempts. [#12831](https://github.com/gravitational/teleport/pull/12831), [#13400](https://github.com/gravitational/teleport/pull/13400)
@ -356,9 +356,9 @@ This release of Teleport contains multiple improvements and bug fixes.
* Improved compatibility with PuTTY. [#12662](https://github.com/gravitational/teleport/pull/12662)
* Added support for global tsh config file `/etc/tsh.yaml`. [#12626](https://github.com/gravitational/teleport/pull/12626)
* Added `tbot configure` command. [#12576](https://github.com/gravitational/teleport/pull/12576)
* Fixed issue with Desktop Access not working in Teleport Cloud. [#12781](https://github.com/gravitational/teleport/pull/12781)
* Fixed issue with desktop access not working in Teleport Cloud. [#12781](https://github.com/gravitational/teleport/pull/12781)
* Improved Web UI performance in large clusters. [#12637](https://github.com/gravitational/teleport/pull/12637)
* Fixed issue with running MySQL stored procedures via Database Access. [#12734](https://github.com/gravitational/teleport/pull/12734)
* Fixed issue with running MySQL stored procedures via database access. [#12734](https://github.com/gravitational/teleport/pull/12734)
## 9.2.3
@ -369,14 +369,14 @@ This release of Teleport contains multiple improvements and bug fixes.
* Fixed backwards compatibility issues with session upload. [#12535](https://github.com/gravitational/teleport/pull/12535)
* Added support for persistency in custom mode in Helm charts. [#12218](https://github.com/gravitational/teleport/pull/12218)
* Fixed issue with PostgreSQL backend not respecting username from certificate. [#12553](https://github.com/gravitational/teleport/pull/12553)
* Fixed issues with `kubectl cp` and `kubectl exec` not working through Kubernetes Access. [#12541](https://github.com/gravitational/teleport/pull/12541)
* Fixed issues with `kubectl cp` and `kubectl exec` not working through Kubernetes access. [#12541](https://github.com/gravitational/teleport/pull/12541)
* Fixed issues with dynamic registration logic for cloud databases. [#12451](https://github.com/gravitational/teleport/pull/12451)
* Fixed issue with automatic Add Application script failing to join the cluster. [#12539](https://github.com/gravitational/teleport/pull/12539)
* Fixed issue with `tctl` crashing when PAM is enabled. [#12572](https://github.com/gravitational/teleport/pull/12572)
* Added support for setting priority class and extra labels in Helm charts. [#12568](https://github.com/gravitational/teleport/pull/12568)
* Fixed issue with App Access JWT tokens not including `iat` claim. [#12589](https://github.com/gravitational/teleport/pull/12589)
* Added ability to inject App Access JWT tokens in rewritten headers. [#12589](https://github.com/gravitational/teleport/pull/12589)
* Desktop Access automatically adds a `teleport.dev/ou` label for desktops discovered via LDAP. [#12502](https://github.com/gravitational/teleport/pull/12502)
* Desktop access automatically adds a `teleport.dev/ou` label for desktops discovered via LDAP. [#12502](https://github.com/gravitational/teleport/pull/12502)
* Updated Machine ID to generates identity files compatible with `tctl` and `tsh`. [#12500](https://github.com/gravitational/teleport/pull/12500)
* Updated internal build infrastructure to Go 1.17.10. [#12607](https://github.com/gravitational/teleport/pull/12607)
* Improved proxy memory usage in clusters with large number of nodes. [#12573](https://github.com/gravitational/teleport/pull/12573)
@ -413,7 +413,7 @@ This release of Teleport contains multiple improvements and bug fixes.
* Fixed multiple conditions that could lead to SSH sessions freezing. [#12286](https://github.com/gravitational/teleport/pull/12286)
* Fixed issue with `tsh db ls` failing for leaf clusters. [#12320](https://github.com/gravitational/teleport/pull/12320)
* Fixed a scenario in which Teleport's internal cache could potentially become unhealthy. [#12251](https://github.com/gravitational/teleport/pull/12251), [#12002](https://github.com/gravitational/teleport/pull/12002)
* Improved performance when opening new Application Access sessions. [#12300](https://github.com/gravitational/teleport/pull/12300)
* Improved performance when opening new application access sessions. [#12300](https://github.com/gravitational/teleport/pull/12300)
* Added flags to the `teleport configure` command. [#12267](https://github.com/gravitational/teleport/pull/12267)
* Improved CA rotation stability. [#12333](https://github.com/gravitational/teleport/pull/12333)
* Fixed issue with `mongosh` certificate verification when using TLS routing. [#12363](https://github.com/gravitational/teleport/pull/12363)
@ -486,7 +486,7 @@ the URL.
This release of Teleport contains multiple improvements and fixes.
* Fixed issue with `:` not being allowed in label keys. [#11563](https://github.com/gravitational/teleport/pull/11563)
* Fixed potential panic in Kubernetes Access. [#11614](https://github.com/gravitational/teleport/pull/11614)
* Fixed potential panic in Kubernetes access. [#11614](https://github.com/gravitational/teleport/pull/11614)
* Added `teleport_connect_to_node_attempts_total` Prometheus metric. [#11629](https://github.com/gravitational/teleport/pull/11629)
* Multiple CA rotation stability improvements. [#11658](https://github.com/gravitational/teleport/pull/11658)
* Fixed console player Ctrl-C and Ctrl-D functionality. [#11559](https://github.com/gravitational/teleport/pull/11559)
@ -539,12 +539,12 @@ This release of Teleport contains multiple improvements and bug fixes.
Teleport 9.0 is a major release that brings:
- Teleport Desktop Access GA
- Teleport desktop access GA
- Teleport Machine ID Preview
- Various additions to Teleport Database Access
- Moderated Sessions for Server and Kubernetes Access
- Various additions to Teleport database access
- Moderated Sessions for server and Kubernetes access
Desktop Access adds support for clipboard sharing, session recording, and
Desktop access adds support for clipboard sharing, session recording, and
per-session MFA.
Teleport Machine ID Preview extends identity-based access to machines. It's the
@ -552,7 +552,7 @@ easiest way to issue, renew, and manage SSH and X.509 certificates for service
accounts, microservices, CI/CD automation and all other forms of
machine-to-machine access.
Database Access brings self-hosted Redis support, RDS MariaDB (10.6 and higher)
Database access brings self-hosted Redis support, RDS MariaDB (10.6 and higher)
support, auto-discovery for Redshift clusters, and auto-IAM configuration
improvements to GA. Additionally, this release also brings Microsoft SQL Server
with AD authentication to Preview.
@ -561,11 +561,11 @@ Moderated Sessions enables the creation of sessions where a moderator has to
be present. This feature can be selectively enabled for specific sessions via
RBAC and can be used in conjunction with per-session MFA.
### Desktop Access
### Desktop access
#### Clipboard Support
Desktop Access now supports copying and pasting text between your local
Desktop access now supports copying and pasting text between your local
workstation and a remote Windows Desktop. This feature requires a Chromium-based
browser and can be disabled via RBAC.
@ -602,11 +602,11 @@ Some of the things you can do with Machine ID:
[Machine ID getting started guide](docs/pages/machine-id/getting-started.mdx)
### Database Access
### Database access
#### Redis
You can now use Database Access to connect to a self-hosted Redis instance or
You can now use database access to connect to a self-hosted Redis instance or
Redis cluster and view Redis commands in the Teleport audit log. We will be
adding support for AWS Elasticache in the coming weeks.
@ -615,7 +615,7 @@ adding support for AWS Elasticache in the coming weeks.
#### SQL Server (Preview)
Teleport 9 includes a preview release of Microsoft SQL Server with Active
Directory authentication support for Database Access. Audit logging of query
Directory authentication support for database access. Audit logging of query
activity is not included in the preview release and will be implemented in a
later 9.x release.
@ -632,7 +632,7 @@ supports IAM authentication is 10.6.
#### Other Improvements
In addition, Teleport 9 expands auto-discovery to support Redshift databases and
2 new commands which simplify the Database Access getting started experience:
2 new commands which simplify the database access getting started experience:
"teleport db configure create", which generates Database Service configuration,
and "teleport db configure bootstrap", which configures IAM permissions for the
Database Service when running on AWS.
@ -656,9 +656,9 @@ observers, moderators or peers.
CentOS 6 support was deprecated in Teleport 8 and has now been removed.
#### Desktop Access
#### Desktop access
Desktop Access now authenticates to LDAP using X.509 client certificates.
desktop access now authenticates to LDAP using X.509 client certificates.
Support for the `password_file` configuration option has been removed.
## 8.0.0
@ -667,9 +667,9 @@ Teleport 8.0 is a major release of Teleport that contains new features, improvem
### New Features
#### Windows Desktop Access Preview
#### Windows desktop access Preview
Teleport 8.0 includes a preview of the Windows Desktop Access feature, allowing
Teleport 8.0 includes a preview of the Windows desktop access feature, allowing
users passwordless login to Windows Desktops via any modern web browser.
Teleport users can connect to Active Directory enrolled Windows hosts running
@ -678,7 +678,7 @@ Windows 10, Windows Server 2012 R2 and newer Windows versions.
To try this feature yourself, check out our
[Getting Started Guide](docs/pages/desktop-access/getting-started.mdx).
Review the Desktop Access design in:
Review the desktop access design in:
- [RFD #33](https://github.com/gravitational/teleport/blob/master/rfd/0033-desktop-access.md)
- [RFD #34](https://github.com/gravitational/teleport/blob/master/rfd/0034-desktop-access-windows.md)
@ -762,7 +762,7 @@ confirmation, for example).
[#8491](https://github.com/gravitational/teleport/pull/8491)
* Added support for account recovery and cancellation.
[#6769](https://github.com/gravitational/teleport/pull/6769)
* Added per-session MFA support to Database Access.
* Added per-session MFA support to database access.
[#8270](https://github.com/gravitational/teleport/pull/8270)
* Added support for profile specific `kubeconfig`.
[#7840](https://github.com/gravitational/teleport/pull/7840)
@ -771,7 +771,7 @@ confirmation, for example).
* Fixed issues with web applications that utilized
[EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource)
with Application Access.
with application access.
[#8359](https://github.com/gravitational/teleport/pull/8359)
* Fixed issue were interactive sessions would always return exit code 0.
[#8081](https://github.com/gravitational/teleport/pull/8081)
@ -810,9 +810,9 @@ glibc compatibility layer they have already been using.
apk --update --no-cache add libgcc
```
#### Database Access Certificates
#### Database access Certificates
With the `GODEBUG=x509ignoreCN=0` flag removed in Go 1.17, Database Access users
With the `GODEBUG=x509ignoreCN=0` flag removed in Go 1.17, database access users
will no longer be able to connect to databases that include their hostname in
the `CommonName` field of the presented certificate. Users are recommended to
update their database certificates to include hostname in the
@ -835,21 +835,21 @@ Teleport 7.0 is a major release of Teleport that contains new features, improvem
#### MongoDB
Added support for [MongoDB](https://www.mongodb.com) to Teleport Database Access. [#6600](https://github.com/gravitational/teleport/issues/6600).
Added support for [MongoDB](https://www.mongodb.com) to Teleport database access. [#6600](https://github.com/gravitational/teleport/issues/6600).
View the [Database Access with MongoDB](docs/pages/database-access/guides/mongodb-self-hosted.mdx) for more details.
View the [database access with MongoDB](docs/pages/database-access/guides/mongodb-self-hosted.mdx) for more details.
#### Cloud SQL MySQL
Added support for [GCP Cloud SQL MySQL](https://cloud.google.com/sql/docs/mysql) to Teleport Database Access. [#7302](https://github.com/gravitational/teleport/pull/7302)
Added support for [GCP Cloud SQL MySQL](https://cloud.google.com/sql/docs/mysql) to Teleport database access. [#7302](https://github.com/gravitational/teleport/pull/7302)
View the Cloud SQL MySQL [guide](docs/pages/database-access/guides/mysql-cloudsql.mdx) for more details.
#### AWS Console
Added support for [AWS Console](https://aws.amazon.com/console) to Teleport Application Access. [#7590](https://github.com/gravitational/teleport/pull/7590)
Added support for [AWS Console](https://aws.amazon.com/console) to Teleport application access. [#7590](https://github.com/gravitational/teleport/pull/7590)
Teleport Application Access can now automatically sign users into the AWS Management Console using [Identity federation](https://aws.amazon.com/identity/federation). View AWS Management Console [guide](docs/pages/application-access/cloud-apis/aws-console.mdx) for more details.
Teleport application access can now automatically sign users into the AWS Management Console using [Identity federation](https://aws.amazon.com/identity/federation). View AWS Management Console [guide](docs/pages/application-access/cloud-apis/aws-console.mdx) for more details.
#### Restricted Sessions
@ -861,7 +861,7 @@ Updated Enhanced Session Recording to no longer require the installation of exte
### Improvements
* Added the ability to terminate Database Access certificates when the certificate expires. [#5476](https://github.com/gravitational/teleport/issues/5476)
* Added the ability to terminate database access certificates when the certificate expires. [#5476](https://github.com/gravitational/teleport/issues/5476)
* Added additional FedRAMP compliance controls, such as custom disconnect and MOTD messages. [#6091](https://github.com/gravitational/teleport/issues/6091) [#7396](https://github.com/gravitational/teleport/pull/7396)
* Added the ability to export Audit Log and session recordings using the Teleport API. [#6731](https://github.com/gravitational/teleport/pull/6731) [#7360](https://github.com/gravitational/teleport/pull/7360)
* Added the ability to partially configure a cluster. [#5857](https://github.com/gravitational/teleport/issues/5857) [RFD #28](https://github.com/gravitational/teleport/blob/master/rfd/0028-cluster-config-resources.md)
@ -882,9 +882,9 @@ Updated Enhanced Session Recording to no longer require the installation of exte
Enhanced Session Recording has been updated to use CO-RE BPF executables. This makes deployment much simpler, you no longer have to install `bcc-tools`, but comes with a higher minimum kernel version of 5.8 and above. [#6027](https://github.com/gravitational/teleport/pull/6027)
#### Kubernetes Access
#### Kubernetes access
Kubernetes Access will no longer automatically register a cluster named after the Teleport cluster if the proxy is running within a Kubernetes cluster. Users wishing to retain this functionality now have to explicitly set `kube_cluster_name`. [#6786](https://github.com/gravitational/teleport/pull/6786)
Kubernetes access will no longer automatically register a cluster named after the Teleport cluster if the proxy is running within a Kubernetes cluster. Users wishing to retain this functionality now have to explicitly set `kube_cluster_name`. [#6786](https://github.com/gravitational/teleport/pull/6786)
#### `tsh`
@ -904,16 +904,16 @@ before upgrading.
#### Added Amazon Redshift Support
Added support for [Amazon Redshift](https://aws.amazon.com/redshift) to Teleport Database Access.[#6479](https://github.com/gravitational/teleport/pull/6479).
Added support for [Amazon Redshift](https://aws.amazon.com/redshift) to Teleport database access.[#6479](https://github.com/gravitational/teleport/pull/6479).
View the [Database Access with Redshift on AWS Guide](docs/pages/database-access/guides/postgres-redshift.mdx) for more details.
View the [database access with Redshift on AWS guide](docs/pages/database-access/guides/postgres-redshift.mdx) for more details.
### Improvements
* Added pass-through header support for Teleport Application Access. [#6601](https://github.com/gravitational/teleport/pull/6601)
* Added pass-through header support for Teleport application access. [#6601](https://github.com/gravitational/teleport/pull/6601)
* Added ability to propagate claim information from root to leaf clusters. [#6540](https://github.com/gravitational/teleport/pull/6540)
* Added Proxy Protocol for MySQL Database Access. [#6594](https://github.com/gravitational/teleport/pull/6594)
* Added prepared statement support for Postgres Database Access. [#6303](https://github.com/gravitational/teleport/pull/6303)
* Added Proxy Protocol for MySQL database access. [#6594](https://github.com/gravitational/teleport/pull/6594)
* Added prepared statement support for Postgres database access. [#6303](https://github.com/gravitational/teleport/pull/6303)
* Added `GetSessionEventsRequest` RPC endpoint for Audit Log pagination. [RFD 19](https://github.com/gravitational/teleport/blob/master/rfd/0019-event-iteration-api.md) [#6731](https://github.com/gravitational/teleport/pull/6731)
* Changed DynamoDB indexing strategy for events. [RFD 24](https://github.com/gravitational/teleport/blob/master/rfd/0024-dynamo-event-overflow.md) [#6583](https://github.com/gravitational/teleport/pull/6583)
@ -963,7 +963,7 @@ This release of Teleport contains multiple bug fixes.
This release of Teleport contains a bug fix.
* Added support for PROXY protocol to Database Access (MySQL). [#6517](https://github.com/gravitational/teleport/issues/6517)
* Added support for PROXY protocol to database access (MySQL). [#6517](https://github.com/gravitational/teleport/issues/6517)
## 6.1.2
@ -999,15 +999,15 @@ See [#5071](https://github.com/gravitational/teleport/pull/5071) for technical d
* Added the ability to propagate SSO claims to PAM modules. [#6158](https://github.com/gravitational/teleport/pull/6158)
* Added support for cluster routing to reduce latency to leaf clusters. [RFD 21](https://github.com/gravitational/teleport/blob/master/rfd/0021-cluster-routing.md)
* Added support for Google Cloud SQL to Database Access. [#6090](https://github.com/gravitational/teleport/pull/6090)
* Added support CLI credential issuance for Application Access. [#5918](https://github.com/gravitational/teleport/pull/5918)
* Added support for Google Cloud SQL to database access. [#6090](https://github.com/gravitational/teleport/pull/6090)
* Added support CLI credential issuance for application access. [#5918](https://github.com/gravitational/teleport/pull/5918)
* Added support for Encrypted SAML Assertions. [#5598](https://github.com/gravitational/teleport/pull/5598)
* Added support for user impersonation. [#6073](https://github.com/gravitational/teleport/pull/6073)
### Fixes
* Fixed interoperability issues with `gpg-agent`. [RFD 18](http://github.com/gravitational/teleport/blob/master/rfd/0018-agent-loading.md)
* Fixed websocket support in Application Access. [#6028](https://github.com/gravitational/teleport/pull/6028)
* Fixed websocket support in application access. [#6028](https://github.com/gravitational/teleport/pull/6028)
* Fixed file argument issues with `tsh play`. [#1580](https://github.com/gravitational/teleport/issues/1580)
* Fixed `utmp` regressions that caused issues in LXC containers. [#6256](https://github.com/gravitational/teleport/pull/6256)
@ -1036,22 +1036,22 @@ This release of Teleport contains multiple bug fixes.
Teleport 6.0 is a major release with new features, functionality, and bug fixes.
We have implemented [Database Access](./docs/pages/database-access/introduction.mdx),
We have implemented [database access](./docs/pages/database-access/introduction.mdx),
open sourced role-based access control (RBAC), and added official API and a Go client library.
Users can review the [6.0 milestone](https://github.com/gravitational/teleport/milestone/33?closed=1) on Github for more details.
### New Features
#### Database Access
#### Database access
Review the Database Access design in [RFD #11](https://github.com/gravitational/teleport/blob/master/rfd/0011-database-access.md).
Review the database access design in [RFD #11](https://github.com/gravitational/teleport/blob/master/rfd/0011-database-access.md).
With Database Access users can connect to PostgreSQL and MySQL databases using short-lived certificates, configure SSO authentication and role-based access controls for databases, and capture SQL query activity in the audit log.
With database access users can connect to PostgreSQL and MySQL databases using short-lived certificates, configure SSO authentication and role-based access controls for databases, and capture SQL query activity in the audit log.
##### Getting Started
Configure Database Access following the [Getting Started](./docs/pages/database-access/introduction.mdx#getting-started/) guide.
Configure database access following the [Getting Started](./docs/pages/database-access/introduction.mdx#getting-started/) guide.
##### Guides
@ -1063,11 +1063,11 @@ Configure Database Access following the [Getting Started](./docs/pages/database-
##### Resources
To learn more about configuring role-based access control for Database Access, check out [RBAC](./docs/pages/database-access/introduction.mdx/) section.
To learn more about configuring role-based access control for database access, check out the [RBAC](./docs/pages/database-access/introduction.mdx/) section.
[Architecture](./docs/pages/database-access/introduction.mdx/) provides a more in-depth look at Database Access internals such as networking and security.
[Architecture](./docs/pages/database-access/introduction.mdx/) provides a more in-depth look at database access internals such as networking and security.
See [Reference](./docs/pages/database-access/reference.mdx) for an overview of Database Access related configuration and CLI commands.
See [Reference](./docs/pages/database-access/reference.mdx) for an overview of database access related configuration and CLI commands.
Finally, check out [Frequently Asked Questions](docs/pages/database-access/faq.mdx).
@ -1119,7 +1119,7 @@ if err = clt.CreateAccessRequest(ctx, accessRequest); err != nil {
* Added `utmp`/`wtmp` support for SSH in [#5491](https://github.com/gravitational/teleport/pull/5491).
* Added the ability to set a Kubernetes specific public address in [#5611](https://github.com/gravitational/teleport/pull/5611).
* Added Proxy Protocol support to Kubernetes Access in [#5299](https://github.com/gravitational/teleport/pull/5299).
* Added Proxy Protocol support to Kubernetes access in [#5299](https://github.com/gravitational/teleport/pull/5299).
* Added ACME ([Let's Encrypt](https://letsencrypt.org/)) support to make getting and using TLS certificates easier. [#5177](https://github.com/gravitational/teleport/issues/5177).
* Added the ability to manage local users to the Web UI in [#2945](https://github.com/gravitational/teleport/issues/2945).
* Added the ability to preserve timestamps when using `tsh scp` in [#2889](https://github.com/gravitational/teleport/issues/2889).
@ -1185,13 +1185,13 @@ Teleport 5.0 is a major release with new features, functionality, and bug fixes.
#### New Features
Teleport 5.0 introduces two distinct features: Teleport Application Access and significant Kubernetes Access improvements - multi-cluster support.
Teleport 5.0 introduces two distinct features: Teleport application access and significant Kubernetes access improvements - multi-cluster support.
##### Teleport Application Access
##### Teleport application access
Teleport can now be used to provide secure access to web applications. This new feature was built with the express intention of securing internal apps which might have once lived on a VPN or had a simple authorization and authentication mechanism with little to no audit trail. Application Access works with everything from dashboards to single page Javascript applications (SPA).
Teleport can now be used to provide secure access to web applications. This new feature was built with the express intention of securing internal apps which might have once lived on a VPN or had a simple authorization and authentication mechanism with little to no audit trail. application access works with everything from dashboards to single page Javascript applications (SPA).
Application Access uses mutually authenticated reverse tunnels to establish a secure connection with the Teleport unified Access Plane which can then becomes the single ingress point for all traffic to an internal application.
application access uses mutually authenticated reverse tunnels to establish a secure connection with the Teleport unified Access Plane which can then becomes the single ingress point for all traffic to an internal application.
Adding an application follows the same UX as adding SSH servers or Kubernetes clusters, starting with creating a static or dynamic invite token.
@ -1213,15 +1213,15 @@ Applications can also be configured using the new `app_service` section in `tele
```yaml
app_service:
# Teleport Application Access is enabled.
# Teleport application access is enabled.
enabled: yes
# We've added a default sample app that will check
# that Teleport Application Access is working
# that Teleport application access is working
# and output JWT tokens.
# https://dumper.teleport.example.com:3080/
debug_app: true
apps:
# Application Access can be used to proxy any HTTP endpoint.
# application access can be used to proxy any HTTP endpoint.
# Note: Name can't include any spaces and should be DNS-compatible A-Za-z0-9-._
- name: "internal-dashboard"
uri: "http://10.0.1.27:8000"
@ -1244,7 +1244,7 @@ app_service:
- name: "os"
command: ["/usr/bin/uname"]
period: "5s"
# A proxy can support multiple applications. Application Access
# A proxy can support multiple applications. application access
# can also be deployed with a Teleport node.
- name: "arris"
uri: "http://localhost:3001"
@ -1271,7 +1271,7 @@ proxy_service:
You can learn more in the [Application Access introduction](./docs/pages/application-access/introduction.mdx).
##### Teleport Kubernetes Access
##### Teleport Kubernetes access
Teleport 5.0 also introduces two highly requested features for Kubernetes.
@ -1397,7 +1397,7 @@ See https://rpm.releases.teleport.dev/ for more details.
* Added `--format=json` playback option for `tsh play`. For example `tsh play --format=json ~/play/0c0b81ed-91a9-4a2a-8d7c-7495891a6ca0.tar | jq '.event` can be used to show all events within an a local archive. [#4578](https://github.com/gravitational/teleport/issues/4578)
* Added support for continuous backups and auto scaling for DynamoDB. [#4780](https://github.com/gravitational/teleport/issues/4780)
* Added a Linux ARM64/ARMv8 (64-bit) Release. [#3383](https://github.com/gravitational/teleport/issues/3383)
* Added `https_keypairs` field which replaces `https_key_file` and `https_cert_file`. This allows administrators to load multiple HTTPS certs for Teleport Application Access. Teleport 5.0 is backwards compatible with the old format, but we recommend updating your configuration to use `https_keypairs`.
* Added `https_keypairs` field which replaces `https_key_file` and `https_cert_file`. This allows administrators to load multiple HTTPS certs for Teleport application access. Teleport 5.0 is backwards compatible with the old format, but we recommend updating your configuration to use `https_keypairs`.
Enterprise Only:
@ -1422,7 +1422,7 @@ Please follow our [standard upgrade
procedure](./docs/pages/management/admin/upgrading-the-teleport-binary.mdx).
* Optional: Consider updating `https_key_file` & `https_cert_file` to our new `https_keypairs:` format.
* Optional: Consider migrating Kubernetes Access from `proxy_service` to `kubernetes_service` after the upgrade.
* Optional: Consider migrating Kubernetes access from `proxy_service` to `kubernetes_service` after the upgrade.
### 4.4.6

View file

@ -99,12 +99,12 @@ version: v3
teleport:
auth_token: xxxx-token-xxxx
# Specify either the proxy address
# Specify either the Proxy Service address...
proxy_server: teleport.example.com:3080
# or the auth server address
# or the Auth Service address
auth_server: 10.1.1.10:3025
# Enable ssh service and disable auth and proxy:
# Enable the SSH Service and disable the Auth and Proxy Services:
ssh_service:
enabled: true
auth_service:

View file

@ -27,22 +27,22 @@ Additionally, this feature can be configured to require touch for every Teleport
Supported (`tsh`, `tctl`, and Teleport Connect):
- Standard Teleport API requests (`tsh ls`, `tctl create`, etc.)
- Server Access
- Database Access
- Server access
- Database access
- Must use `tsh proxy db` instead of `tsh db connect`
Not yet supported:
- Teleport WebUI (except for user registration / reset password)
- Agent forwarding functionality such as `tsh ssh -A`, Proxy Recording mode, and OpenSSH integration
- Kubernetes Access
- Desktop Access
- Application Access
- Kubernetes access
- Desktop access
- Application access
The unsupported features above will not function for users that have have hardware key support
enforced. This is either because the user's hardware key can't be accessed within that feature
(WebUI) or because the protocol only supports raw private keys currently (Agent forwarding,
Kubernetes Access, Desktop Access).
Kubernetes access, desktop access).
To navigate these incompatibilities, we recommend enabling hardware key support only when
necessary, such as for roles with access to critical infrastructure. These roles can be accessed

View file

@ -7,9 +7,9 @@ h1: Moderated Sessions
## Introduction
Moderated Sessions allows Teleport administrators to define requirements for
other users to be present in a Server or Kubernetes Access session. Depending on
the requirements, these users can observe the session in real time, participate
in the session, and terminate the session at will.
other users to be present in a server or Kubernetes session. Depending on the
requirements, these users can observe the session in real time, participate in
the session, and terminate the session at will.
In addition, Teleport administrators can [define rules](#join_sessions) that allow users to join each other's
sessions from `tsh` and the Web UI.
@ -200,7 +200,7 @@ but the session will remain open. This discards all input from session participa
Moderated Session RBAC controls were added to the role specification in version 5
(`version: v5` in the YAML definition).
Previously, Server Access did not include controls over which users can join a
Previously, the Teleport SSH Service did not include controls over which users can join a
session.
To avoid breaking functionality for users with only roles on v4 or older, RBAC
access checks will only be enforced if the user has at least one v5 role.

View file

@ -35,7 +35,7 @@ their on-disk Teleport certificates.
enforced. Additionally, only v6.1 or newer `tsh` binaries implement
per-session MFA checks.
Per-session MFA for Desktop Access was introduced in Teleport 9.
Per-session MFA for desktop access was introduced in Teleport 9.
</Details>
## Prerequisites
@ -268,9 +268,9 @@ even when logging into `dev1.example.com`.
<Admonition title="Per-session MFA for Database Access" type="tip">
Database Access supports per-connection MFA. When Jerry connects to the database
`prod-mysql-instance` (with label `env: prod`), he gets prompted for an MFA check
for each `tsh db connect` or `tsh proxy db` call:
The Teleport Database Service supports per-connection MFA. When Jerry connects
to the database `prod-mysql-instance` (with label `env: prod`), he gets prompted
for an MFA check for each `tsh db connect` or `tsh proxy db` call:
```code
$ tsh db connect prod-mysql-instance
@ -307,4 +307,4 @@ Current limitations for this feature are:
If you enable per-session MFA checks cluster-wide, you will not be able to
use Application access. We're working on integrating per-session
MFA checks for these clients.
- For Desktop Access, only WebAuthn devices are supported.
- For desktop access, only WebAuthn devices are supported.

View file

@ -1,6 +1,6 @@
---
title: Access AWS With Teleport Application Access
description: How to access AWS with Teleport Application Access.
description: How to access AWS with Teleport application access.
videoBanner: GVcy_rffxQw
---
@ -18,13 +18,15 @@ This guide will explain how to:
## Prerequisites
- A running Teleport cluster, either self hosted or in Teleport Cloud.
- A host running the `teleport` daemon with Application Access enabled. Follow
the [Getting Started](../getting-started.mdx) or
[Connecting Apps](../guides/connecting-apps.mdx) guides to get it running.
- A host running the `teleport` daemon with the Teleport Application Service
enabled. Follow the [Getting Started](../getting-started.mdx) or [Connecting
Apps](../guides/connecting-apps.mdx) guides to get it running.
- IAM permissions in the AWS account you want to connect.
- AWS EC2 or other instance where you can assign a IAM Security Role for the Teleport Agent.
- `aws` command line interface (CLI) tool in PATH. [Installing or updating the latest version of the AWS CLI
](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
- AWS EC2 or other instance where you can assign a IAM Security Role for the
Teleport Agent.
- `aws` command line interface (CLI) tool in PATH. [Installing or updating the
latest version of the AWS CLI
](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
<Admonition type="note">
If using Teleport deployed in AWS EKS, you cannot use Helm chart
@ -126,7 +128,7 @@ You can make the policy more strict by providing specific IAM role resource
ARNs in the Resource field instead of using a wildcard.
</Admonition>
Attach this policy to the IAM role/user your Teleport application service agent
Attach this policy to the IAM role/user your Teleport Application Service agent
is using.
![AWS Attach Security Role](../../../img/application-access/attach-security-role.png)

View file

@ -3,10 +3,9 @@ title: "Protect Azure CLIs with Teleport Application Access"
description: How to enable secure access to Azure CLIs.
---
You can use Teleport Application Access to manage access to CLI tools that
interact with Azure's APIs. This lets you control access to your
infrastructure's management APIs using the same RBAC system that you use to
protect your infrastructure itself.
You can use Teleport to manage access to CLI tools that interact with Azure's
APIs. This lets you control access to your infrastructure's management APIs
using the same RBAC system that you use to protect your infrastructure itself.
The Teleport Application Service uses Azure managed identities to obtain
authentication tokens from Azure. When a user authenticates to Teleport, they

View file

@ -1,13 +1,14 @@
---
title: Application Access Role-Based Access Control
description: Role-Based Access Control (RBAC) for Teleport Application Access.
description: Role-Based Access Control (RBAC) for Teleport application access.
---
This article describes Access Control concepts particularly relevant to Teleport Application Access.
This article describes access control concepts particularly relevant to the
Teleport Application Service.
## Assigning labels to applications
Teleport Application Access uses labels to control access to the proxied
The Teleport Application Service uses labels to control access to the proxied
web applications.
Teleport administrators can assign static and dynamic labels to apps using

View file

@ -1,10 +1,10 @@
---
title: Getting Started with Teleport Application Access
description: Getting started with Teleport Application Access.
description: Getting started with Teleport application access.
videoBanner: 5Uwhp3IQMHY
---
Let's connect to Grafana using Teleport Application Access in three steps:
Let's connect to Grafana using Teleport in three steps:
- Launch Grafana in a Docker container.
- Install the Teleport Application Service on a node and configure it to proxy Grafana.
@ -22,7 +22,7 @@ Let's connect to Grafana using Teleport Application Access in three steps:
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- (!docs/pages/includes/tctl.mdx!)
- A Docker installation, which we will use to launch Grafana in a container. Alternatively, if you have another web application you'd like to protect with Application Access, you can use that instead.
- A Docker installation, which we will use to launch Grafana in a container. Alternatively, if you have another web application you'd like to protect with Teleport, you can use that instead.
- A host where you will run the Teleport Application Service.
<Admonition type="tip" title="Not yet a Teleport user?">

View file

@ -1,18 +1,18 @@
---
title: Application Access Guides
description: Guides for configuring Teleport Application Access.
description: Guides for configuring Teleport application access.
layout: tocless-doc
---
These guides explain how to use Teleport Application Access, which allows your
teams to connect to applications within private networks with fine-grained RBAC
and audit logging.
These guides explain how to use the Teleport Application Service, which allows
your teams to connect to applications within private networks with fine-grained
RBAC and audit logging.
Manage access to internal applications:
- [Web App Access](./guides/connecting-apps.mdx): How to access web apps with Teleport Application Access.
- [TCP App Access (Preview)](./guides/tcp.mdx): How to access plain TCP apps with Teleport Application Access.
- [API Access](./guides/api-access.mdx): How to access REST APIs with Teleport Application Access.
- [Web App Access](./guides/connecting-apps.mdx): How to access web apps with Teleport.
- [TCP App Access (Preview)](./guides/tcp.mdx): How to access plain TCP apps with Teleport.
- [API Access](./guides/api-access.mdx): How to access REST APIs with Teleport.
- [Dynamic Registration](./guides/dynamic-registration.mdx): Register/unregister apps without restarting Teleport.
- [AWS DynamoDB Access](./guides/dynamodb.mdx): How to access AWS DynamoDB as an application.
- [Application Access HA](./guides/ha.mdx): How to configure Teleport Application Access in a Highly Available (HA) configuration.
- [Application Access HA](./guides/ha.mdx): How to configure the Teleport Application Service for high availability.

View file

@ -1,13 +1,14 @@
---
title: Access REST APIs With Teleport Application Access
description: How to access REST APIs with Teleport Application Access.
description: How to access REST APIs with Teleport application access.
---
Teleport Application Access can be used to access applications' (REST or Teleport's own gRPC) APIs with
tools like [curl](https://man7.org/linux/man-pages/man1/curl.1.html) or Postman.
The Teleport Application Service can be used to access applications' (REST or
Teleport's own gRPC) APIs with tools like
[curl](https://man7.org/linux/man-pages/man1/curl.1.html) or Postman.
<Admonition type="note" title="Non-HTTP API Support">
Use [TCP Application Access](./tcp.mdx) for non-HTTP APIs (like gRPC).
Use [TCP application access](./tcp.mdx) for non-HTTP APIs (like gRPC).
</Admonition>
## Prerequisites

View file

@ -9,7 +9,7 @@ and follow the installation [instructions](../../installation.mdx).
## Start Auth/Proxy service
Create a configuration file for a Teleport service that will be running
auth and proxy servers:
the Auth and Proxy Services:
```yaml
teleport:
@ -72,7 +72,7 @@ comes with a built-in `access` role that grants access to all apps:
$ tctl --config=/path/to/teleport.yaml users add --roles=access appuser
```
## Start application service with CLI flags
## Start the Application Service with CLI flags
Install Teleport:
@ -151,7 +151,7 @@ proxy_service:
enabled: "no"
```
Start the application service:
Start the Application Service:
```code
$ sudo teleport start --config=/path/to/teleport.yaml

View file

@ -40,7 +40,7 @@ This guide will help you to:
- (!docs/pages/includes/tctl.mdx!)
<Admonition type="tip" title="Not yet a Teleport user?">
If you have not yet deployed the Auth Service and Proxy Service, you should follow one of our [getting started guides](../getting-started.mdx) or try our Teleport Application Access [interactive learning track](https://play.instruqt.com/teleport/invite/rgvuva4gzkon).
If you have not yet deployed the Auth Service and Proxy Service, you should follow one of our [getting started guides](../getting-started.mdx) or try our Teleport application access [interactive learning track](https://play.instruqt.com/teleport/invite/rgvuva4gzkon).
</Admonition>
We will assume your Teleport cluster is accessible at `teleport.example.com` and `*.teleport.example.com`. You can substitute the address of your Teleport Proxy Service. (For Teleport Cloud customers, this will be similar to `mytenant.teleport.sh`.)

View file

@ -1,13 +1,12 @@
---
title: Application Access High Availability (HA)
description: How to configure Teleport Application Access in a Highly Available (HA) configuration.
description: How to configure Teleport application access in a Highly Available (HA) configuration.
---
# Application Access High Availability (HA)
You can deploy Application Access in a Highly Available (HA) configuration in a
couple of common ways: combined instances and separate instances. Both of those
revolve around pointing multiple Application Services to the same application.
You can deploy the Application Service in a Highly Available (HA) configuration
in a couple of common ways: combined instances and separate instances. Both of
those revolve around pointing multiple Application Services to the same
application.
## Combined instances

View file

@ -5,7 +5,8 @@ description: How to configure Teleport for accessing plain TCP apps
Teleport can provide access to any TCP-based application. This allows users to
connect to applications which Teleport doesn't natively support such as SMTP
servers or databases not yet natively supported in Database Access.
servers or databases not yet natively supported by the Teleport Database
Service.
## Prerequisites

View file

@ -3,8 +3,8 @@ title: Protect Applications with Teleport
description: How to set up Teleport to protect internal apps and cloud provider APIs
---
Teleport Application Access is designed to provide secure access to
cloud provider APIs and internal applications. Examples include:
Teleport is designed to provide secure access to cloud provider APIs and
internal applications. Examples include:
- The AWS management console.
- The `aws`, `gcloud`, `gsutil`, and `az` CLIs.
@ -65,17 +65,17 @@ private network, with no shared secrets.
These guides explain how to protect internal applications with Teleport:
- [Web App Access](./guides/connecting-apps.mdx): How to access web apps with Teleport Application Access.
- [TCP App Access (Preview)](./guides/tcp.mdx): How to access plain TCP apps with Teleport Application Access.
- [API Access](./guides/api-access.mdx): How to access REST APIs with Teleport Application Access.
- [Web App Access](./guides/connecting-apps.mdx): How to access web apps with Teleport.
- [TCP App Access (Preview)](./guides/tcp.mdx): How to access plain TCP apps with Teleport.
- [API Access](./guides/api-access.mdx): How to access REST APIs with Teleport.
- [Dynamic Registration](./guides/dynamic-registration.mdx): Register/unregister apps without restarting Teleport.
- [Interactive Lab](https://play.instruqt.com/teleport/invite/rgvuva4gzkon): Try Teleport using our guided Teleport Application Access lab.
- [Interactive Lab](https://play.instruqt.com/teleport/invite/rgvuva4gzkon): Try Teleport using our guided Teleport application access lab.
## Use Teleport-signed JSON Web Tokens
These guides explain how web apps registered with Teleport can use
Teleport-signed JSON web tokens to implement authentication and authorization.
- [Introduction](./jwt/introduction.mdx): Introduction to JWT tokens with Application Access.
- [Introduction](./jwt/introduction.mdx): Introduction to JWT tokens with application access.
- [Elasticsearch](./jwt/elasticsearch.mdx): How to use JWT authentication with Elasticsearch.

View file

@ -1,12 +1,12 @@
---
title: Application Access JWT Authentication
description: Guides for using Teleport Application Access JWT authentication.
description: Guides for using Teleport application access JWT authentication.
layout: tocless-doc
---
These guides explain how web apps behind Teleport Application Access can
These guides explain how web apps behind the Teleport Application Service can
leverage Teleport-signed JWT tokens to implement authentication and
authorization.
- [Introduction](./jwt/introduction.mdx): Introduction to JWT tokens with Application Access.
- [Introduction](./jwt/introduction.mdx): Introduction to JWT tokens with application access.
- [Elasticsearch](./jwt/elasticsearch.mdx): How to use JWT authentication with Elasticsearch.

View file

@ -4,7 +4,7 @@ description: How to use JWT authentication with Elasticsearch
---
This guide will help you configure Elasticsearch [JWT authentication](https://www.elastic.co/guide/en/elasticsearch/reference/current/jwt-realm.html)
with Teleport Application Access.
with Teleport.
<Details title="Version warning" opened={true}>
Elasticsearch supports JWT authentication starting from version `8.2.0`.
@ -110,5 +110,6 @@ $ curl \
## Next steps
- Get more information about integrating with [Teleport JWT tokens](./introduction.mdx).
- Learn more about [accessing APIs](../guides/api-access.mdx) with Application Access.
- Take a look at [Access Controls](../controls.mdx) with Application Access.
- Learn more about [accessing APIs](../guides/api-access.mdx) with the Teleport
Application Service.
- Take a look at application-related [Access Controls](../controls.mdx).

View file

@ -1,6 +1,6 @@
---
title: Use JWT Tokens With Application Access
description: How to use JWT tokens for authentication with Teleport Application Access.
description: How to use JWT tokens for authentication with Teleport application access.
---
Teleport sends a JWT token signed with Teleport's authority with each request

View file

@ -1,6 +1,6 @@
---
title: Application Access Reference Documentation
description: Configuration and CLI reference documentation for Teleport Application Access.
description: Configuration and CLI reference documentation for Teleport application access.
---
## Configuration
@ -130,7 +130,7 @@ $ tctl create -f app.yaml
## CLI
This section shows CLI commands relevant for Application Access.
This section shows CLI commands relevant for application access.
### tsh apps ls

View file

@ -49,9 +49,10 @@ Windows, database, and Kubernetes sessions are always recorded at the host runni
the Teleport service for this session type, since there is no Teleport software
running on the "node" (desktop, database, or Kubernetes cluster).
For this reason, Teleport Windows, Database, and Kubernetes Access treats `node`
and `proxy` identically (perform asynchronous recording) and `node-sync` and
`proxy-sync` identically (perform synchronous recording).
For this reason, the Teleport Windows, Database, and Kubernetes Services treat
`node` and `proxy` identically (perform asynchronous recording) and `node-sync`
and `proxy-sync` identically (perform synchronous recording).
</Admonition>
### Record at Node

View file

@ -1,10 +1,10 @@
---
title: Database Access GUI Clients
description: How to configure graphical database clients for Teleport Database Access.
description: How to configure graphical database clients for Teleport database access.
---
This guide describes how to configure popular graphical database clients to
work with Teleport Database Access.
work with Teleport.
## Setting up your Teleport environment
@ -62,8 +62,8 @@ Ensure that your environment includes the following:
</Tabs>
- The Teleport Database Service configured to access a database. See one of our
[guides](../database-access/guides.mdx) for how to set up Teleport Database Access for your
database.
[guides](../database-access/guides.mdx) for how to set up the Teleport
Database Service for your database.
### Get connection information

View file

@ -62,7 +62,7 @@ required for your particular use case.
The Teleport Connect app provides all the same access to resources as `tsh` in
a friendly graphic user interface. After [downloading](https://goteleport.com/download/)
and installing Teleport Connect, you can log in and initiate sessions for
Server and Database Access within a single window.
server and database access within a single window.
1. Click **CONNECT** to connect to the Teleport cluster:
@ -94,12 +94,12 @@ Activity logs for users with the right permissions.
## Protocols
### Server Access (`ssh`)
### Server access (`ssh`)
<Tabs>
<TabItem label="tsh">
`tsh ls` lists the servers you have access to through Server Access (SSH):
`tsh ls` lists the servers you have access to through Teleport:
```code
$ tsh ls
@ -144,7 +144,7 @@ $ tsh scp some-file.ext server.example.com:
some-file.ext 7% |███████ | (25/342 MB, 2.9 MB/s) [9s:1m48s]
```
### Kubernetes Access (`kubectl`)
### Kubernetes access (`kubectl`)
<Tabs>
<TabItem label="tsh">
@ -286,7 +286,7 @@ list those that are accessible to your user under <Icon name="database" size="sm
### Desktop Access
Desktop Access is available through the Teleport Web UI. In your browser,
Desktop access is available through the Teleport Web UI. In your browser,
navigate to your Teleport cluster (e.g.
<ScopedBlock scope={["oss", "enterprise"]}>`https://teleport.example.com`</ScopedBlock>
<ScopedBlock scope={["cloud"]}>`https://mytennant.teleport.sh`</ScopedBlock>
@ -310,8 +310,9 @@ either directly or through proxy tunnels.
Learn more about it from [Using the tsh Command Line Tool](./tsh.mdx).
- Teleport Connect is a graphic utility for connecting to resources through
Teleport. You can initiate Server Access, connect to databases, and start
Desktop Access sessions. See [Using Teleport Connect](./teleport-connect.mdx).
Teleport. You use it to connect to servers, databases, and Kubernetes
clusters. See [Using Teleport Connect](./teleport-connect.mdx).
{/*lint ignore messaging for page title*/}
- [Database Access GUI Clients](./gui-clients.mdx) details
how to connect many popular database GUI clients through Teleport.

View file

@ -840,8 +840,8 @@ DEBU [TSH] Self re-exec command: tsh [status --format=json]. tsh/aliases.g
## Interactive Recording
Within the Teleport cluster the Server and Kubernetes recorded sessions are available for listing and replay for authorized users via `tsh`.
The same listings, including Desktop Access sessions, are available in the Web Console under Session Recordings in the Activity section.
Within the Teleport cluster, server and Kubernetes recorded sessions are available for listing and replay for authorized users via `tsh`.
The same listings, including Windows desktop sessions, are available in the Web Console under Session Recordings in the Activity section.
### List and Play Recordings

View file

@ -47,7 +47,7 @@ Teleport and want to set up Teleport for a specific scenario.
#### Example outline
- Guide title: "Kubernetes Access on GKE"
- Guide title: "Access Kubernetes on GKE"
- The purpose of the guide
- Prerequisites
- Setup steps

View file

@ -1,13 +1,15 @@
---
title: Database Access Architecture
description: How Teleport Database Access works.
description: How Teleport enables secure access to databases.
---
This section provides an overview of Teleport Database Access inner workings.
This section provides an overview of how Teleport enables secure access to
databases.
## How it works
Let's take a look at a sample Database Access deployment:
Let's take a look at a sample Teleport deployment that enables access to
databases:
![Teleport Database Access Diagram](../../img/database-access/diagram.png)
@ -29,11 +31,11 @@ In it, we have the following Teleport components:
</ScopedBlock>
- [Teleport Auth](../architecture/authentication.mdx). Serves as
- [Teleport Auth Service](../architecture/authentication.mdx). Serves as
cluster's certificate authority, handles user authentication/authorization
and issues short-lived client certificates.
- Teleport Database Service. The Database Access' "brain" that connects
to the databases, performs database authentication and protocol parsing.
- Teleport Database Service. The "brain" that connects to the databases,
performs database authentication and protocol parsing.
Database Service establishes an SSH reverse tunnel to the Proxy. As such, users
do not need to have direct connectivity to the Database Service, or the databases
@ -48,7 +50,7 @@ can be located behind a firewall.
Database Service can be also connected to multiple databases.
</Admonition>
Let's take a look at the typical flow Database Access users go through to
Let's take a look at the typical flow that Teleport users go through to
connect to a database.
1. A user logs into the cluster with `tsh login` command and retrieves
@ -102,7 +104,7 @@ For configuring graphical clients, use the `tsh proxy db` command, which prints
detailed information about the connection such as the host, port, and location
of the secrets. See [GUI Clients](../connect-your-client/gui-clients.mdx) for details.
### Proxy to Database service
### Proxy to the Database Service
The connection between the Proxy and the Database Service is also authenticated
with mutual TLS.
@ -111,7 +113,7 @@ The Proxy generates a short-lived X.509 certificate signed by the
cluster's host authority, with the client's identity and database routing
information encoded in it, and uses it to authenticate with the Database Service.
### Database service to database
### Database Service to database
Database authentication is handled differently for self-hosted databases and
databases hosted by AWS.

View file

@ -1,11 +1,11 @@
---
title: Database Access FAQ
description: Frequently asked questions about Teleport Database Access.
description: Frequently asked questions about Teleport database access.
---
## Which database protocols does Teleport Database Access support?
## Which database protocols does Teleport the Database Service support?
Teleport Database Access currently supports the following protocols:
The Teleport Database Service currently supports the following protocols:
- MariaDB
- Microsoft SQL Server
@ -55,7 +55,7 @@ on a plain TCP load balancer (e.g. NLB in AWS).
<TabItem scope={["cloud"]} label="Teleport Cloud">
In Teleport Cloud, the Proxy Service uses the following ports for
Database Access client traffic:
Database Service client traffic:
|Configuration setting|Port|
|---|---|

View file

@ -1,10 +1,10 @@
---
title: Database Access Getting Started Guide
description: Getting started with Teleport Database Access and AWS Aurora PostgreSQL.
description: Getting started with Teleport database access and AWS Aurora PostgreSQL.
---
In this getting started guide we will use Teleport Database Access to connect
to a PostgreSQL AWS Aurora database.
In this getting started guide we will use Teleport to connect to a PostgreSQL
AWS Aurora database.
Here's an overview of what we will do:
@ -23,7 +23,7 @@ Here's an overview of what we will do:
<Admonition type="note" title="Supported versions">
Teleport Database Access is available starting from the `6.0.0` Teleport
Teleport database access is available starting from the `6.0.0` Teleport
release.
</Admonition>

View file

@ -1,6 +1,6 @@
---
title: Database Access Guides
description: Guides for configuring Teleport Database Access with self-hosted or cloud-hosted databases.
description: Guides for configuring Teleport database access with self-hosted or cloud-hosted databases.
layout: tocless-doc
---

View file

@ -1,6 +1,6 @@
---
title: Database Access with AWS Keyspaces (Apache Cassandra)
description: How to configure Teleport Database Access with AWS Keyspaces (Apache Cassandra)
description: How to configure Teleport database access with AWS Keyspaces (Apache Cassandra)
---
<Details
@ -10,7 +10,7 @@ description: How to configure Teleport Database Access with AWS Keyspaces (Apach
scopeOnly={true}
min="11.0"
>
Database Access for AWS Keyspaces (Apache Cassandra) is available starting from Teleport `v11.0`.
Database access for AWS Keyspaces (Apache Cassandra) is available starting from Teleport `v11.0`.
</Details>
This guide will help you to:

View file

@ -1,6 +1,6 @@
---
title: Database Access with AWS DynamoDB
description: How to access AWS DynamoDB with Teleport Database Access
description: How to access AWS DynamoDB with Teleport database access
---
Access to AWS DynamoDB can be provided by [Teleport Database
@ -44,10 +44,10 @@ organization's access conventions. You should adjust the AWS IAM permissions to
## Step 1/4. Create IAM roles for DynamoDB access
The setup described in this guide requires two IAM roles:
- One associated with the EC2 instance running the Teleport Database Access
service, which lets it assume additional roles granted to the user.
- One that can be assumed by the EC2 instance role and grants access to
DynamoDB services to users.
- One associated with the EC2 instance running the Teleport Database Service,
which lets it assume additional roles granted to the user.
- One that can be assumed by the EC2 instance role and grants access to DynamoDB
services to users.
### EC2 instance role

View file

@ -1,6 +1,6 @@
---
title: Database Access with Azure PostgreSQL and MySQL
description: How to configure Teleport Database Access with Azure Database for PostgreSQL and MySQL.
description: How to configure Teleport database access with Azure Database for PostgreSQL and MySQL.
---
<Details

View file

@ -1,6 +1,6 @@
---
title: Database Access with Azure Cache for Redis
description: How to configure Teleport Database Access with Azure Cache for Redis
description: How to configure Teleport database access with Azure Cache for Redis
---
This guide will help you to:

View file

@ -1,6 +1,6 @@
---
title: Database Access with SQL Server on Azure (Preview)
description: How to configure Teleport Database Access with Azure SQL Server using Azure Active Directory authentication.
description: How to configure Teleport database access with Azure SQL Server using Azure Active Directory authentication.
---
<Details
@ -10,12 +10,12 @@ description: How to configure Teleport Database Access with Azure SQL Server usi
scopeOnly={true}
min="11.0"
>
Database Access for Azure SQL Server with Azure Active Directory authentication
Database access for Azure SQL Server with Azure Active Directory authentication
is available starting from Teleport `11.0`.
</Details>
<Admonition type="warning" title="Preview">
Database Access for Azure SQL Server with Azure Active Directory authentication is
Database access for Azure SQL Server with Azure Active Directory authentication is
currently in Preview mode.
</Admonition>

View file

@ -1,6 +1,6 @@
---
title: Database Access with Cassandra and ScyllaDB
description: How to configure Teleport Database Access with Cassandra and ScyllaDB.
description: How to configure Teleport database access with Cassandra and ScyllaDB.
---
<Details

View file

@ -1,6 +1,6 @@
---
title: Database Access with Self-Hosted CockroachDB
description: How to configure Teleport Database Access with self-hosted CockroachDB.
description: How to configure Teleport database access with self-hosted CockroachDB.
---
<Details

View file

@ -1,6 +1,6 @@
---
title: Database Access with Elasticsearch
description: How to configure Teleport Database Access with Elasticsearch.
description: How to configure Teleport database access with Elasticsearch.
---
<Details
@ -13,13 +13,13 @@ description: How to configure Teleport Database Access with Elasticsearch.
Database access for Elasticsearch is available starting from Teleport `10.3`.
</Details>
This guide will help you to configure secured access to an Elasticsearch database using Teleport Database Access.
This guide will help you to configure secured access to an Elasticsearch database using the Teleport Database Service.
## Prerequisites
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- A self-hosted Elasticsearch database. Elastic Cloud [does not support client certificates](https://www.elastic.co/guide/en/cloud/current/ec-restrictions.html#ec-restrictions-security), which are required for setting up Database Access.
- A self-hosted Elasticsearch database. Elastic Cloud [does not support client certificates](https://www.elastic.co/guide/en/cloud/current/ec-restrictions.html#ec-restrictions-security), which are required for setting up the Database Service.
- A host where you will run the Teleport Database Service. If you are already running the Teleport
Database Service, you must ensure that it uses Teleport version 10.3 or newer in order to connect

View file

@ -1,12 +1,12 @@
---
title: Database Access High Availability (HA)
description: How to configure Teleport Database Access in a Highly Available (HA) configuration.
description: How to configure Teleport database access in a Highly Available (HA) configuration.
---
You can deploy Database Access in a Highly Available (HA) configuration in a
couple of common ways: combined replicas and separate replicas. Both of those
revolve around pointing multiple Database Services to the same database
instance.
You can deploy the Teleport Database Service in a Highly Available (HA)
configuration in a couple of common ways: combined replicas and separate
replicas. Both of those revolve around pointing multiple Database Services to
the same database instance.
## Combined replicas
@ -89,4 +89,5 @@ you're using to connect.
## Next steps
- Get started by [connecting](../guides.mdx) your database.
- Review Database Access [architecture](../architecture.mdx).
- Review the [architecture](../architecture.mdx) of the Teleport Database
Service.

View file

@ -1,6 +1,6 @@
---
title: Database Access with MongoDB Atlas
description: How to configure Teleport Database Access with MongoDB Atlas.
description: How to configure Teleport database access with MongoDB Atlas.
videoBanner: mu_ZKTjnFJ8
---

View file

@ -1,12 +1,12 @@
---
title: Database Access with Self-Hosted MongoDB
description: How to configure Teleport Database Access with self-hosted MongoDB.
description: How to configure Teleport database access with self-hosted MongoDB.
videoBanner: 6lgVObxoLkc
---
In this guide you will:
1. Install and configure Teleport for Database Access.
1. Install and configure Teleport for database access.
2. Configure mutual TLS authentication between Teleport and your MongoDB cluster.
3. Connect to your MongoDB instance via Teleport.
@ -24,7 +24,7 @@ In this guide you will:
- MongoDB cluster (standalone or replica set) version `(=mongodb.min_version=)` or newer.
<Admonition type="note">
Teleport Database Access supports MongoDB `(=mongodb.min_version=)` and newer.
Teleport database access supports MongoDB `(=mongodb.min_version=)` and newer.
Older versions have not been tested and are not guaranteed to work. MongoDB
`(=mongodb.min_version=)` was released in November 2017 and reached EOL in
April 2021 so if you're still using an older version, consider upgrading.

View file

@ -1,6 +1,6 @@
---
title: Database Access with MySQL on GCP Cloud SQL
description: How to configure Teleport Database Access with GCP Cloud SQL MySQL.
description: How to configure Teleport database access with GCP Cloud SQL MySQL.
---
This guide will help you to:
@ -22,7 +22,7 @@ This guide will help you to:
<Notice type="warning">
Teleport Database Access for Cloud SQL MySQL is available starting from the
Teleport database access for Cloud SQL MySQL is available starting from the
`7.0` release.
</Notice>
@ -224,7 +224,7 @@ proxy_service:
title="Tip"
>
A single Teleport process can run multiple different services, for example
multiple Database Access instances as well as other services such the SSH
multiple Database Service instances as well as other services such the SSH
Service or Application Service.
</Admonition>

View file

@ -1,6 +1,6 @@
---
title: Database Access with Self-Hosted MySQL/MariaDB
description: How to configure Teleport Database Access with self-hosted MySQL/MariaDB.
description: How to configure Teleport database access with self-hosted MySQL/MariaDB.
---
This guide will help you to:

View file

@ -1,10 +1,10 @@
---
title: Database Access with Oracle (Preview)
description: How to configure Teleport Database Access with Oracle.
description: How to configure Teleport database access with Oracle.
---
<Admonition type="warning" title="Preview">
Database Access for Oracle Database is currently in Preview mode.
Database access for Oracle Database is currently in Preview mode.
</Admonition>
This guide will help you to:
@ -160,4 +160,4 @@ $ tsh db logout
(!docs/pages/includes/database-access/guides-next-steps.mdx!)
- Learn more about `sqlnet.ora` and `listener.ora` configuration from the [Parameters for the sqlnet.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/parameters-for-the-sqlnet-ora-file.html#GUID-28040885-6832-4FFC-9258-0EF19FE9A3AC) and [Oracle Net Listener Parameters in the listener.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/Oracle-Net-Listener-parameters-in-listener-ora-file.html#GUID-F9FA0DF5-2FAF-45CA-B6A1-F0166C7BFE54) Oracle documentation.
- Learn more about `sqlnet.ora` and `listener.ora` configuration from the [Parameters for the sqlnet.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/parameters-for-the-sqlnet-ora-file.html#GUID-28040885-6832-4FFC-9258-0EF19FE9A3AC) and [Oracle Net Listener Parameters in the listener.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/Oracle-Net-Listener-parameters-in-listener-ora-file.html#GUID-F9FA0DF5-2FAF-45CA-B6A1-F0166C7BFE54) Oracle documentation.

View file

@ -1,6 +1,6 @@
---
title: Database Access with PostgreSQL on GCP Cloud SQL
description: How to configure Teleport Database Access with GCP Cloud SQL PostgreSQL.
description: How to configure Teleport database access with GCP Cloud SQL PostgreSQL.
videoBanner: br9LZ3ZXqCk
---
@ -287,7 +287,7 @@ proxy_service:
>
A single Teleport process can run multiple different services, for example
multiple Database Access instances as well as other services such the SSH
multiple Database Services instances as well as other services such the SSH
Service or Application Service.
</Notice>
@ -357,7 +357,7 @@ $ tsh db connect --db-user=teleport@<project-id>.iam --db-name=postgres cloudsql
title="What database user name to use?"
>
When connecting to the database, use the name of the database service account
When connecting to the database, use the name of the database's service account
that you added as an IAM database user
[above](#step-27-create-a-service-account-for-the-database), minus the
`.gserviceaccount.com` suffix. The database user name is shown on the Users

View file

@ -1,6 +1,6 @@
---
title: Database Access with Redshift on AWS
description: How to configure Teleport Database Access with AWS Redshift PostgreSQL.
description: How to configure Teleport database access with AWS Redshift PostgreSQL.
videoBanner: UFhT52d5bYg
---

View file

@ -1,6 +1,6 @@
---
title: Database Access with Self-Hosted PostgreSQL
description: How to configure Teleport Database Access with self-hosted PostgreSQL.
description: How to configure Teleport database access with self-hosted PostgreSQL.
---
This guide will help you to:

View file

@ -1,6 +1,6 @@
---
title: Database Access with AWS RDS Proxy
description: How to configure Teleport Database Access with AWS RDS Proxy.
description: How to configure Teleport database access with AWS RDS Proxy.
---
This guide will help you to set up Teleport to access your AWS RDS proxies.

View file

@ -1,7 +1,7 @@
---
title: Database Access with AWS RDS and Aurora
h1: Database Access with AWS RDS and Aurora for PostgreSQL, MySQL and MariaDB
description: How to configure Teleport Database Access with AWS RDS and Aurora for PostgreSQL, MySQL and MariaDB.
description: How to configure Teleport database access with AWS RDS and Aurora for PostgreSQL, MySQL and MariaDB.
---
This guide will help you to:
@ -18,7 +18,7 @@ This guide will help you to:
</ScopedBlock>
<Admonition type="note" title="Supported versions">
The following products are not compatible with Database Access as they don't support IAM authentication:
The following products are not compatible with database access as they don't support IAM authentication:
- Aurora Serverless v1.
- RDS MariaDB versions lower than 10.6.

View file

@ -1,6 +1,6 @@
---
title: Database Access with AWS ElastiCache and AWS MemoryDB for Redis
description: How to configure Teleport Database Access with AWS ElastiCache and AWS MemoryDB for Redis.
description: How to configure Teleport database access with AWS ElastiCache and AWS MemoryDB for Redis.
---
This guide will help you to:

View file

@ -1,6 +1,6 @@
---
title: Database Access with Redis Cluster
description: How to configure Teleport Database Access with Redis Cluster.
description: How to configure Teleport database access with Redis Cluster.
---
<Details
@ -10,7 +10,7 @@ description: How to configure Teleport Database Access with Redis Cluster.
scopeOnly={true}
min="9.0"
>
Database Access for Redis is available starting from Teleport `9.0`.
Database access for Redis is available starting from Teleport `9.0`.
</Details>
If you want to configure Redis Standalone, please read [Database Access with Redis](redis.mdx).

View file

@ -1,6 +1,6 @@
---
title: Database Access with Redis
description: How to configure Teleport Database Access with Redis.
description: How to configure Teleport database access with Redis.
---
<Details

View file

@ -1,6 +1,6 @@
---
title: Database Access with Redshift Serverless on AWS
description: How to configure Teleport Database Access with AWS Redshift Serverless.
description: How to configure Teleport database access with AWS Redshift Serverless.
---
This guide will help you to:

View file

@ -1,6 +1,6 @@
---
title: Database Access with Snowflake
description: How to configure Teleport Database Access with Snowflake.
description: How to configure Teleport database access with Snowflake.
---
<Details

View file

@ -1,6 +1,6 @@
---
title: Database Access with Microsoft SQL Server with Active Directory authentication (Preview)
description: How to configure Teleport Database Access with Microsoft SQL Server with Active Directory authentication.
description: How to configure Teleport database access with Microsoft SQL Server with Active Directory authentication.
videoBanner: k2wz79XCexY
---
@ -11,12 +11,12 @@ videoBanner: k2wz79XCexY
scopeOnly={true}
min="9.0"
>
Database Access for Microsoft SQL Server with Active Directory authentication
Database access for Microsoft SQL Server with Active Directory authentication
is available starting from Teleport `9.0`.
</Details>
<Admonition type="warning" title="Preview">
Database Access for Microsoft SQL Server is currently in Preview mode.
Database access for Microsoft SQL Server is currently in Preview mode.
</Admonition>
This guide will help you to:

View file

@ -1,12 +1,12 @@
---
title: Database Access
description: Teleport Database Access introduction, demo and resources.
description: Teleport database access introduction, demo and resources.
---
Teleport can provide secure connections to your databases while improving both
access control and visibility.
Some of the things you can do with Database Access:
Some of the things you can do with database access:
- Enable users to retrieve short-lived database certificates using a Single Sign-On
flow, thus maintaining their organization-wide identity.
@ -48,14 +48,14 @@ with GitHub, execute a few SQL queries and observe them in the audit log:
## Resources
To learn more about configuring role-based access control for Database Access,
To learn more about configuring role-based access control for database access,
check out the [RBAC](./rbac.mdx) section.
The [Architecture](./architecture.mdx) section provides a more in-depth look at
Database Access internals such as networking and security.
Teleport Database Service internals such as networking and security.
See [Reference](./reference.mdx) for an overview of
Database Access-related configuration and CLI commands.
database access-related configuration and CLI commands.
If you hit any issues, check out the [Troubleshooting
documentation](./troubleshooting.mdx) for common problems and solutions.

View file

@ -1,6 +1,6 @@
---
title: Database Role-Based Access Controls
description: Role-based access control (RBAC) for Teleport Database Access.
description: Role-based access control (RBAC) for Teleport database access.
---
Role-based access control (or RBAC, for short) allows administrators to set up
@ -12,7 +12,7 @@ engineers can gain temporary access to the production database in case of
emergency"*.
For a more general description of Teleport roles and examples see [RBAC](../access-controls/introduction.mdx), as
this section focuses on configuring RBAC for Database Access.
this section focuses on configuring RBAC for database access.
## Role configuration

View file

@ -1,6 +1,6 @@
---
title: Database Access Reference
description: Configuration and CLI reference for Teleport Database Access.
description: Configuration and CLI reference for the Teleport Database Service.
---
- [Configuration](./reference/configuration.mdx)

View file

@ -1,10 +1,8 @@
---
title: Database Access Audit Events Reference
description: Audit events reference for Teleport Database Access.
description: Audit events reference for Teleport database access.
---
# Database Access Audit Events Reference
## db.session.start (TDB00I/W)
Emitted when a client successfully connects to a database, or when a connection

View file

@ -1,10 +1,10 @@
---
title: Database Access CLI Reference
description: CLI reference for Teleport Database Access.
description: CLI reference for Teleport database access.
---
This reference shows you how to run common commands for managing Teleport
Database Access, including:
the Database Service, including:
- The `teleport` daemon command, which is executed on the host where you
will run the Teleport Database Service.
@ -148,7 +148,7 @@ $ teleport db configure bootstrap -c /etc/teleport.yaml --manual
When invoked with a `--format=db` (or `--format=mongodb` for MongoDB) flag,
produces a CA certificate, a client certificate and a private key file used for
configuring Database Access with self-hosted database instances.
configuring the Database Service with self-hosted database instances.
<Admonition type="note" title="Note">
For database formats, `tctl` must be run on an Auth Service host or the remote

View file

@ -1,6 +1,6 @@
---
title: Database Access Configuration Reference
description: Configuration reference for Teleport Database Access.
description: Configuration reference for Teleport database access.
---
## Database service configuration
@ -17,7 +17,7 @@ appearing in `teleport.yaml` configuration file:
<Tabs>
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">
The following Proxy service configuration is relevant for Database Access:
The following Proxy service configuration is relevant for database access:
<Admonition
type="warning"
@ -58,7 +58,7 @@ proxy_service:
<TabItem scope={["cloud"]} label="Teleport Cloud">
Teleport Cloud automatically configures the Teleport Proxy Service with the
following settings that are relevant to Database Access. This reference
following settings that are relevant to database access. This reference
configuration uses `mytenant.teleport.sh` in place of your Teleport Cloud tenant
address.

View file

@ -226,7 +226,7 @@ This must be a subdomain of the domain you chose for [`route53_zone`](#route53\_
Setting `export TF_VAR_add_wildcard_route53_record="true"`
Used to enable Application Access for subdomains of the Teleport Proxy Service's public web address. A wildcard entry for the public-facing
Used to enable the Teleport Application Service for subdomains of the Teleport Proxy Service's public web address. A wildcard entry for the public-facing
domain will be set in Route 53, e.g., `*.teleport.example.com`, to point to the Teleport load balancer. For ACM a wildcard
certificate is included if this is set to `true`. Let's Encrypt automatically includes a wildcard subdomain in certificates that it issues.

View file

@ -344,10 +344,11 @@ Save the following configuration file as `/etc/teleport.yaml` on the Node:
version: v3
teleport:
auth_token: (= presets.tokens.second =)
# Nodes and other agents can be joined to the cluster via the proxy's public address.
# This will establish a reverse tunnel between the proxy and the node which is used for all traffic.
# Teleport agents can be joined to the cluster via the Proxy Service's
# public address. This will establish a reverse tunnel between the Proxy
# Service and the agent that is used for all traffic.
proxy_server: teleport.example.com:443
# enable ssh service and disable auth and proxy
# enable the SSH Service and disable the Auth and Proxy Services
ssh_service:
enabled: true
auth_service:

View file

@ -65,7 +65,7 @@ these options:
You can use `cert-manager` to provision and automatically renew TLS credentials
by completing ACME challenges via Let's Encrypt. We recommend this approach if
you require CLI access to web applications using client certificates via
Teleport Application Access.
the Teleport Application Service.
#### Using AWS Certificate Manager
@ -75,10 +75,10 @@ certificates.
You should be aware of the limitations for using AWS Certificate Manager to
provision TLS credentials for Teleport:
- This will prevent Teleport Application Access from working via CLI using
client certificates. Application Access will still work via a browser.
- Command-line Application Access does not work with ACM. Using ACM will prevent
Teleport from facilitating Application Access via CLI (using client
- This will prevent the Teleport Application Service from working via CLI using
client certificates. Application access will still work via a browser.
- Command-line application access does not work with ACM. Using ACM will prevent
Teleport from facilitating application access via CLI (using client
certificates), as Teleport will not be handling its own TLS termination.
- Using ACM through a AWS Load Balancer prevents the required traffic for
Postgres or MongoDB through Teleport's web port. If you choose to use the ACM

View file

@ -11,7 +11,7 @@ and how to upgrade existing releases from version 11 to version 12.
The main changes in version 12 of the `teleport-cluster` chart are:
- PodSecurityPolicy has been removed on Kubernetes 1.23 and 1.24
- Teleport now deploys its auth and proxy services as separate pods.
- Teleport now deploys its Auth and Proxy Services as separate pods.
Running Teleport with this new topology allows it to be more resilient to
disruptions and scale better.
- Proxies are now deployed as stateless workloads. The `proxy` session recording

View file

@ -4,13 +4,13 @@ description: Manually Connect Teleport to an Active Directory domain
videoBanner: YvMqgcq0MTQ
---
In this guide we will connect an Active Directory domain to Teleport using
Desktop Access and log into a Windows desktop from that domain.
In this guide we will connect an Active Directory domain to Teleport using the
Desktop Service and log into a Windows desktop from that domain.
<Admonition type="tip" title="Use The Wizard">
Starting with Teleport 10.2.6, you can install Active Directory and configure
Teleport Desktop Access through the web UI. See [Desktop Access with Active
the Teleport Desktop Service through the web UI. See [Desktop Access with Active
Directory](active-directory.mdx) for more information.
Teleport Enterprise users can configure Windows Access for local users by
@ -19,7 +19,7 @@ following [Getting Started with Windows Access](getting-started.mdx).
Continue with this guide if:
- You're running an older version of Teleport and can't upgrade.
- You want to install Desktop Access using the same instance of `teleport` running the proxy/auth services.
- You want to install the Desktop Service using the same instance of `teleport` running the proxy/auth services.
</Admonition>
@ -41,7 +41,7 @@ This guide requires you to have:
See [Teleport Getting Started](../try-out-teleport/introduction.mdx) if you're new to Teleport.
- A Linux server to run the Teleport Desktop Access service on.
- A Linux server to run the Teleport Desktop Service on.
You can reuse an existing server running any other Teleport instance.
@ -465,7 +465,7 @@ the filepath to the `der_ca_file` configuration variable.
<Admonition type="note" title="Teleport CA">
Prior to v8.0, the Teleport CA was not compatible with Windows logins. If
you're setting up Desktop Access in an existing cluster created before v8.0,
you're setting up desktop access in an existing cluster created before v8.0,
you must first perform a [CA rotation](../management/operations/ca-rotation.mdx) in
order to resolve this.
</Admonition>
@ -474,7 +474,7 @@ Install Teleport on the host where you will run the Teleport Desktop Service:
(!docs/pages/includes/install-linux.mdx!)
In order to enable Desktop Access in Teleport, add the following section in
In order to enable desktop access in Teleport, add the following section in
`/etc/teleport.yaml` on your Linux server. For a detailed description of these
configuration fields, see the
[configuration reference](./reference/configuration.mdx) page.
@ -606,7 +606,7 @@ $ tctl create -f windows-desktop-admins.yaml
### Connect to your Windows desktop
At this point everything is ready for Desktop Access connections. Open
At this point everything is ready for Desktop Service connections. Open
the Teleport web UI and log in with a user with the role created above.
On the left pane, select `Desktops (preview)`. You should see the list of all

View file

@ -1,6 +1,6 @@
---
title: Desktop Access with Active Directory
description: Integrate Teleport Desktop Access to your Active Directory Domain
description: Integrate the Teleport Desktop Service with your Active Directory domain
videoBanner: v36tlB8D5kk
---
@ -21,10 +21,10 @@ provide secure, passwordless access to Windows desktops.
<Details title="Compare Desktop Access to other RDP clients">
Teleport Desktop Access is designed to be a secure access solution for Windows
The Teleport Desktop Service is designed to be a secure access solution for Windows
environments. Teleport implements a minimal feature set of the RDP protocol with
security as a priority, and may not be as performant as standard RDP clients.
Consider Desktop Access to manage access to your most sensitive Windows
Consider the Desktop Service to manage access to your most sensitive Windows
environments, not as a drop-in replacement for other tools to provide general
access to Windows desktops.
@ -73,7 +73,7 @@ Click **NEXT**.
The PowerShell script will output a Teleport configuration block. Copy this
block to a temporary location. Click **Next**.
On the Linux host you installed Teleport to run as the Desktop Access connector,
On the Linux host you installed Teleport to run as the Desktop Service connector,
edit `/etc/teleport.yaml` and paste the configuration provided by the output of
the previous step. Review and edit the addition as necessarily for your environment:

View file

@ -1,11 +1,11 @@
---
title: Desktop Access Directory Sharing
description: Teleport Desktop Access Directory Sharing lets you easily send files to a remote desktop.
description: Teleport desktop Directory Sharing lets you easily send files to a remote desktop.
---
Directory Sharing is a feature of Teleport Desktop Access that makes it easy to
move files between a local machine and a remote desktop—and apply changes to
those files—without compromising security.
Directory Sharing is a Teleport feature of that makes it easy to move files
between a local machine and a remote desktop—and apply changes to those
files—without compromising security.
During a remote desktop session, you can select a folder on your local
workstation to share with the remote desktop. Changes to the folder on either
@ -22,9 +22,11 @@ after the session ends.
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- Teleport Desktop Access with at least one remote desktop registered in your
cluster. If you have not yet configured Desktop Access, read [Getting Started
with Desktop Access](./getting-started.mdx) before beginning this guide.
{/*lint ignore messaging to ignore the page title linked here*/}
- The Teleport Desktop Service with at least one remote desktop registered in
your cluster. If you have not yet configured Desktop Access, read [Getting
Started with Desktop Access](./getting-started.mdx) before beginning this
guide.
- A browser on your local machine that supports the File System Access API,
which Teleport uses for Directory Sharing. We support the latest versions of
Chromium-based browsers like Google Chrome, Brave, and Microsoft Edge.
@ -166,11 +168,11 @@ $ tctl create -f role.yaml
Directory Sharing is a powerful tool for editing files on remote desktops, and
you'll want to make sure you have a comprehensive audit trail so you can conduct
a post-incident retrospective or investigate unintended usage. Learn how to set
up [session recording for Desktop Access](./reference/sessions.mdx).
up [session recording for desktop access](./reference/sessions.mdx).
Aside from Directory Sharing, Desktop Access also enables you to share the
contents of your clipboard with a remote desktop. Learn how to use [Clipboard
Sharing](./reference/clipboard.mdx).
Aside from Directory Sharing, the Teleport Desktop Service also enables you to
share the contents of your clipboard with a remote desktop. Learn how to use
[Clipboard Sharing](./reference/clipboard.mdx).
### How Directory Sharing works

View file

@ -33,7 +33,7 @@ an [Active Directory domain](./active-directory.mdx).
(!docs/pages/includes/commercial-prereqs-tabs.mdx!)
- A Linux server to run the Teleport Desktop Access service on.
- A Linux server to run the Teleport Desktop Service on.
You can reuse an existing server running any other Teleport instance.
- A server or virtual machine running a Windows operating system with
Remote Desktop enabled and the RDP port available to the Linux server.
@ -195,6 +195,6 @@ You can now connect to your Windows desktops from the Teleport Web UI:
## Next Steps
- See the [RBAC page](./rbac.mdx) for more information about setting up
Windows Desktop Access permissions.
Windows desktop access permissions.
- See the [Access Controls Getting Started](../access-controls/getting-started.mdx#step-13-add-local-users-with-preset-roles)
guide for instructions on how to create or update a user with a given role.

View file

@ -1,11 +1,11 @@
---
title: Desktop Access
description: Teleport Desktop Access introduction and resources.
description: Teleport desktop access introduction and resources.
videoBanner: n2h0GisWdss
---
Teleport manages graphical desktop access to remote hosts. With Teleport
Desktop Access, you get:
Teleport manages graphical desktop access to remote hosts. With Teleport, you
get:
- A password-less login experience backed by strong cryptographic
authentication.

View file

@ -1,6 +1,6 @@
---
title: Role-Based Access Control for Desktop Access
description: Role-based access control (RBAC) for Teleport Desktop Access
description: Role-based access control (RBAC) for Teleport desktop access
---
Teleport's RBAC allows administrators to set up granular access policies for
@ -77,9 +77,9 @@ host_labels:
### Using LDAP
Teleport Desktop Access can automatically discover Windows Desktops and register
them with the Teleport Cluster by periodically querying an LDAP server. There
are several ways that these desktops can be labeled:
The Teleport Desktop Service can automatically discover Windows Desktops and
register them with the Teleport Cluster by periodically querying an LDAP server.
There are several ways that these desktops can be labeled:
Teleport applies the following labels automatically to all desktops discovered
via LDAP:
@ -97,7 +97,7 @@ via LDAP:
Additionally, users can configure
[LDAP attributes](https://docs.microsoft.com/en-us/windows/win32/adschema/attributes-all)
which will be converted into Teleport labels. For example, consider the
following Desktop Access configuration:
following Desktop Service configuration:
```yaml
discovery:

View file

@ -1,10 +1,10 @@
---
title: Desktop Access Reference
description: Comprehensive guides to configuring and auditing Desktop Access.
description: Comprehensive guides to configuring and auditing desktop access.
layout: tocless-doc
---
- [Configuration](./reference/configuration.mdx): Configure Teleport Desktop Access.
- [Audit](./reference/audit.mdx): Desktop Access audit events.
- [Configuration](./reference/configuration.mdx): Configure Teleport desktop access.
- [Audit](./reference/audit.mdx): Desktop access audit events.
- [Clipboard](./reference/clipboard.mdx): Share your clipboard with a remote desktop.
- [Session Recording](./reference/sessions.mdx): Desktop session recording and playback

View file

@ -1,6 +1,6 @@
---
title: Desktop Access Audit Events Reference
description: Audit events reference for Teleport Desktop Access.
description: Audit events reference for Teleport desktop access.
---
## windows.desktop.session.start (TDP00I/W)

View file

@ -1,9 +1,10 @@
---
title: Desktop Access CLI Reference
description: CLI reference for Teleport Desktop Access.
description: CLI reference for Teleport desktop access.
---
The following `tctl` commands are used to manage Teleport Desktop Access.
The following `tctl` commands are used to manage the Teleport Windows Desktop
Service.
- (!docs/pages/includes/tctl.mdx!)
@ -23,4 +24,4 @@ List registered Windows desktops:
```sh
$ tctl get windows_desktop
```
```

View file

@ -1,10 +1,10 @@
---
title: Clipboard Sharing
description: Using Clipboard Sharing with Teleport Desktop Access.
description: Using Clipboard Sharing with Teleport desktop access.
---
Teleport Desktop Access supports copying and pasting text between your browser
and a remote Windows Desktop.
Teleport supports copying and pasting text between your browser and a remote
Windows Desktop.
<Admonition type="note">
This feature requires a Chromium-based browser such as Google Chrome, Brave,
@ -43,4 +43,4 @@ is enabled in the menu bar at the top of the screen.
{
/* screenshots for enabled / disabled */
}
}

View file

@ -1,16 +1,14 @@
---
title: Desktop Access Configuration Reference
description: Configuration reference for Teleport Desktop Access.
description: Configuration reference for Teleport desktop access.
---
## Windows Desktop Service configuration
`teleport.yaml` fields related to Desktop Access:
`teleport.yaml` fields related to desktop access:
```yaml
# Main service responsible for Desktop Access.
# Main service responsible for desktop access.
#
# You can have multiple Desktop Access services in your cluster (but not in the
# You can have multiple Desktop Service instances in your cluster (but not in the
# same teleport.yaml), connected to the same or different Active Directory
# domains.
(!docs/pages/includes/config-reference/desktop-config.yaml!)

View file

@ -1,9 +1,9 @@
---
title: Session Recording and Playback
description: Recording and Playing Back Teleport Desktop Access Sessions.
description: Recording and playing back Teleport desktop access sessions.
---
Teleport Desktop Access supports recording and playback of desktop sessions.
The Teleport Database Service supports recording and playback of desktop sessions.
## Disabling session recording
@ -85,12 +85,14 @@ Use `tsh recordings ls` to list available recordings.
## Storage
Be aware, Desktop Access session recordings save PNGs of changing sections of the
screen, which means they take up significantly more disk space than SSH or Kubernetes
session recordings. When using async recording modes, ensure that the host running
Teleport's desktop service has sufficient disk space to store recordings that are
in progress. As a point of reference, when a full 1080p screen is redrawn (for example
when opening a new full-sized application window), you can expect about 250kb to be
Be aware, desktop session recordings save PNGs of changing sections of the
screen, which means they take up significantly more disk space than SSH or
Kubernetes session recordings. When using async recording modes, ensure that the
host running Teleport's Desktop Service has sufficient disk space to store
recordings that are in progress.
As a point of reference, when a full 1080p screen is redrawn (for example when
opening a new full-sized application window), you can expect about 250kb to be
saved to disk. If disk space is a concern, we recommend using sync recording and
configuring a cloud storage solution such as S3.

View file

@ -1,6 +1,6 @@
---
title: Troubleshooting Desktop Access
description: Common issues and resolutions for Teleport's Desktop Access
description: Common issues and resolutions for Teleport's desktop access
---
Common issues and resolution steps.

View file

@ -1,9 +1,9 @@
<Details scopeOnly={true} scope={["cloud"]} title="Teleport Cloud">
This guide deploys the Teleport Auth Service and Proxy Service, which are fully managed in Teleport Cloud. If you are a Teleport Cloud customer, we recommend following our guides for accessing specific resources within your infrastructure:
- [Server Access](/docs/server-access/getting-started.mdx)
- [Kubernetes Access](/docs/kubernetes-access/getting-started.mdx)
- [Database Access](/docs/database-access/getting-started.mdx)
- [Desktop Access](/docs/desktop-access/getting-started.mdx)
- [Application Access](/docs/application-access/getting-started.mdx)
- [Servers](/docs/server-access/getting-started.mdx)
- [Kubernetes clusters](/docs/kubernetes-access/getting-started.mdx)
- [Databases](/docs/database-access/getting-started.mdx)
- [Windows Desktops](/docs/desktop-access/getting-started.mdx)
- [Applications](/docs/application-access/getting-started.mdx)
</Details>

View file

@ -1,8 +1,8 @@
app_service:
# Turns 'app' role on. Default is 'no'
enabled: yes
# Teleport contains a small debug app that can be used to make sure
# Application Access is working correctly. The app outputs JWTs so it can
# Teleport contains a small debug app that can be used to make sure the
# Application Service is working correctly. The app outputs JWTs so it can
# be useful when extending your application.
debug_app: true
apps:

View file

@ -34,7 +34,7 @@ proxy_service:
peer_listen_addr: 0.0.0.0:3021
# The HTTPS listen address to serve the Web UI and authenticate users.
# Handles the PostgreSQL proxy if Database Access is enabled.
# Handles the PostgreSQL proxy if the Database Service is enabled.
web_listen_addr: 0.0.0.0:3080
# The DNS name of the proxy HTTPS endpoint as accessible by cluster users.

View file

@ -56,7 +56,7 @@ policy.
</Details>
Another option is to deploy [Database Access in a Highly Available (HA)
Another option is to deploy [the Database Service in a highly available (HA)
configuration](../../database-access/guides/ha.mdx) where databases can be
sharded to separate Database Services with different IAM roles.

View file

@ -1,6 +1,6 @@
<Admonition type="tip">
To modify an existing user to provide access to the Database Access service, see [Database Access Access Controls](../../database-access/rbac.mdx)
To modify an existing user to provide access to the Database Service, see [Database Access Access Controls](../../database-access/rbac.mdx)
</Admonition>

View file

@ -1,8 +1,8 @@
<Admonition type="note" title="Certificate Rotation">
Teleport 10.0 introduced a new certificate authority that is only used by Database Access.
Older Teleport versions use a host certificate to sign Database Access certificates.
Teleport 10.0 introduced a new certificate authority that is only used by the Teleport Database Service.
Older Teleport versions use a host certificate to sign Database Service certificates.
After upgrading to Teleport 10.0, the host certificate authority will still be used by Database Access to maintain compatibility.
After upgrading to Teleport 10.0, the host certificate authority will still be used by the Database Service to maintain compatibility.
The first [certificate rotation](../../management/operations/ca-rotation.mdx) will rotate host and database certificates.
New Teleport 10.0+ installations generate the database certificate authority when they first start, and are not affected

View file

@ -1,9 +1,9 @@
Set up two `A` DNS records: `tele.example.com` for all traffic and
`*.tele.example.com` for web apps using Application Access. We are assuming
`*.tele.example.com` for web apps using application access. We are assuming
that your domain name is `example.com`. Use your own subdomain instead of
`tele`.
<Details opened={false} title="Why are we using wildcard subdomains for Application Access?">
<Details opened={false} title="Why are we using wildcard subdomains for application access?">
(!docs/pages/includes/dns-app-access.mdx!)
</Details>

View file

@ -12,12 +12,12 @@
||Open Source|Enterprise|Cloud|
|---|---|---|---|
|[Application Access](../application-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Server Access](../server-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Database Access](../database-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Desktop Access - Active Directory](../desktop-access/active-directory.mdx)|&#10004;|&#10004;|&#10004;|
|[Passwordless Windows Access for Local Users](../desktop-access/getting-started.mdx)|&#10006;|&#10004;|&#10004;|
|[Kubernetes Access](../kubernetes-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Application access](../application-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Server access](../server-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Database access](../database-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Desktop access - Active Directory](../desktop-access/active-directory.mdx)|&#10004;|&#10004;|&#10004;|
|[Passwordless Windows access for local users](../desktop-access/getting-started.mdx)|&#10006;|&#10004;|&#10004;|
|[Kubernetes access](../kubernetes-access/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|[Machine ID](../machine-id/getting-started.mdx)|&#10004;|&#10004;|&#10004;|
|Agentless integration with [OpenSSH servers](../server-access/guides/openssh.mdx)|&#10004;|&#10004;|&#10004;|

View file

@ -21,8 +21,8 @@ following situations:
From Teleport 12.2, Trusted Cluster support for SSH Access has been included in
Machine ID.
We currently do not support Application Access, Database Access or Kubernetes
Access to resources in leaf clusters.
We currently do not support access to applications, databases, or Kubernetes
clusters in Trusted Clusters configured as leaf clusters.
## Should I define allowed logins as user traits or within roles?
@ -54,4 +54,4 @@ produced by Machine ID from being used to connect to resources.
As a work-around, ensure that per-session MFA is enforced on individual roles
rather than enforced globally, and that it is not enforced for roles that you
will impersonate using Machine ID.
will impersonate using Machine ID.

View file

@ -24,14 +24,14 @@ You will need to be running the Teleport Proxy and Auth Services, version 9.3.0
later.
</ScopedBlock>
If you have not already put your database behind Teleport Database Access,
follow the [Database Access Getting Started Guide](../../database-access/getting-started.mdx).
Database Access supports databases like PostgreSQL, MongoDB, Redis, and much
more. See our [Database Access Guides](../../database-access/guides.mdx) for
a complete list.
If you have not already put your database behind the Teleport Database Service,
follow the [database access getting started guide](../../database-access/getting-started.mdx).
The Teleport Database Service supports databases like PostgreSQL, MongoDB,
Redis, and much more. See our [database access
guides](../../database-access/guides.mdx) for a complete list.
If you have not already set up Machine ID, follow the [Machine ID Getting
Started Guide](../getting-started.mdx) to familiarize yourself with Machine ID.
If you have not already set up Machine ID, follow the [Machine ID getting
started guide](../getting-started.mdx) to familiarize yourself with Machine ID.
You'll need `tctl` access to initially configure the bot.
- (!docs/pages/includes/tctl.mdx!)

View file

@ -16,9 +16,9 @@ description: A tutorial for using Machine ID with GitHub Actions and Kubernetes
GitHub Actions is a popular CI/CD platform that works as a part of the larger
GitHub ecosystem.
In this guide, you will use Teleport Machine ID and Kubernetes Access to allow a
GitHub Actions workflow to securely connect to a Kubernetes cluster without the
need for long-lived secrets.
In this guide, you will use Machine ID and the Teleport Kubernetes Service to
allow a GitHub Actions workflow to securely connect to a Kubernetes cluster
without the need for long-lived secrets.
Teleport supports secure joining on both GitHub-hosted and self-hosted GitHub
Actions runners as well as GitHub Enterprise Server.
@ -28,7 +28,6 @@ Actions runners as well as GitHub Enterprise Server.
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- (!docs/pages/includes/tctl.mdx!)
- A Kubernetes cluster connected to your Teleport cluster. If you do not already
have one configured, try our
[Kubernetes Access getting started guide.](../../kubernetes-access/getting-started.mdx)

View file

@ -81,10 +81,11 @@ This event is called `tbot.start` and contains the following attributes:
- `tbot.helper_version`: the version of the helper that has started `tbot` if
one has been used
- `tbot.destinations_other`: a count of destinations configured that are not
associated with Database Access, Kubernetes Access or Application Access
- `tbot.destinations_database`: a count of Database Access destinations
associated with the Database Service, Kubernetes Service or Application
Service
- `tbot.destinations_database`: a count of Database Service destinations
configured
- `tbot.destinations_kubernetes`: a count of Kubernetes Access destinations
- `tbot.destinations_kubernetes`: a count of Kubernetes Service destinations
configured
- `tbot.destinations_application`: a count of Application Access destinations
- `tbot.destinations_application`: a count of Application Service destinations
configured

View file

@ -20,7 +20,7 @@ fakehost.example.com 127.0.0.1:3022 env=example,hostname=ip-172-31-53-70,aws/Nam
```
<Notice type="note">
For services that manage multiple resources (such as the database service), each resource will receive the
For services that manage multiple resources (such as the Database Service), each resource will receive the
same labels from EC2.
</Notice>

View file

@ -22,13 +22,13 @@ You can find the full list of fixes and features in the [GitHub milestone](https
### Teleport 9
Teleport 9.0 will focus on bringing Desktop Access to GA with support for
session recording, per-session MFA, and clipboard support. Database Access
Teleport 9.0 will focus on bringing desktop access to GA with support for
session recording, per-session MFA, and clipboard support. Database access
will add self-hosted Redis, auto-discovery for Redshift clusers, and
auto-IAM configuration improvements.
In addition, Teleport 9 will include preview releases of Microsoft SQL
Server with AD authentication for Database Access and Teleport Certificate Bot.
Server with AD authentication for database access and Teleport Certificate Bot.
| Version | Date | Description |
| ----------- | ------------------ | -------------------------------- |

View file

@ -627,7 +627,7 @@ $ ssh myuser@node1.example.com
### tsh proxy app
Starts a local TLS proxy for Application Access connections.
Starts a local TLS proxy for Application Service connections.
You can use this proxy to connect to an application repeatedly after a single login to your Teleport cluster,
which is especially useful for interacting with an application via a CLI.
@ -1911,7 +1911,7 @@ $ tctl auth sign -o <filepath> [--user <user> | --host <host>][--format] [<flags
| `--leaf-cluster` | `""` | The name of a leaf cluster. | |
| `--kube-cluster-name` | `""` | Kubernetes Cluster Name | |
| `--app-name` | `""` | application name | Generate a certificate for accessing the specified web application |
| `--db-service` | `""` | database service name | Generate a certificate for accessing the specified database service |
| `--db-service` | `""` | Database Service name | Generate a certificate for accessing the specified Database Service instance |
| `--db-user` | `""` | database user | When `--db-service` is specified, encode this database user in the certificate |
| `--db-name` | `""` | database name | When `--db-service` is specified, encode this database name in the certificate |

View file

@ -99,9 +99,11 @@ This name will be shown to Teleport users connecting to the Kubernetes cluster.
|----------|---------------|-----------|
| `object` | {} | no |
The `teleport-cluster` chart deploys two sets of pods: auth and proxy.
`auth` contains values specific for the auth pods. You can use it to
set specific values for auth pods, taking precedence over chart-scoped values.
The `teleport-cluster` chart deploys two sets of pods, one for the Auth Service
and another for the Proxy Service.
`auth` contains values specific for Auth Service pods. You can use it to set
specific values for auth pods, taking precedence over chart-scoped values.
For example, to override the [`postStart`](#postStart) value only for auth pods:
```yaml
@ -148,8 +150,10 @@ auth:
|----------|---------------|-----------|
| `object` | {} | no |
The `teleport-cluster` charts deploys two sets of pods: auth and proxy.
`proxy` contains values specific to the proxy pods. You can use it to
The `teleport-cluster` charts deploys two sets of pods: one for the Auth Service
and another for the Proxy Service.
`proxy` contains values specific to Proxy Service pods. You can use it to
set specific values for proxy pods, taking precedence over chart-scoped values.
For example, to override the [`postStart`](#postStart) value only for proxy pods:
@ -352,8 +356,9 @@ For possible values, [see the Teleport Configuration Reference](../../reference/
|--------|---------------|-----------|--------------------------------------|
| `bool` | `false` | no | `proxy_service.postgres_listen_addr` |
`separatePostgresListener` controls whether Teleport will multiplex PostgreSQL traffic for Teleport Database Access
over a separate TLS listener to Teleport's web UI.
`separatePostgresListener` controls whether Teleport will multiplex PostgreSQL
traffic for the Teleport Database Service over a separate TLS listener to
Teleport's web UI.
When `separatePostgresListener` is `false` (the default), PostgreSQL traffic will be directed to port 443 (the default Teleport web
UI port). This works in situations when Teleport is terminating its own TLS traffic, i.e. when using certificates from LetsEncrypt
@ -384,7 +389,7 @@ These settings will not apply if [`proxyListenerMode`](#proxylistenermode) is se
|--------|---------------|-----------|-----------------------------------|
| `bool` | `false` | no | `proxy_service.mongo_listen_addr` |
`separateMongoListener` controls whether Teleport will multiplex PostgreSQL traffic for Teleport Database Access
`separateMongoListener` controls whether Teleport will multiplex PostgreSQL traffic for the Teleport Database Service
over a separate TLS listener to Teleport's web UI.
When `separateMongoListener` is `false` (the default), MongoDB traffic will be directed to port 443 (the default Teleport web

View file

@ -472,7 +472,7 @@ You can specify multiple apps by adding additional list elements.
|--------|---------------|--------------------------------------------------------------------------------------|
| `list` | `[]` | When `app` chart role is used at least one of `apps` and `appResources` is required. |
`appResources` is a YAML list object detailing the resource selectors of the applications that should be proxied by Teleport Application Access.
`appResources` is a YAML list object detailing the resource selectors of the applications that should be proxied by the Teleport Application Service.
You can specify multiple selectors by including additional list elements.
@ -739,7 +739,7 @@ You can specify multiple databases by adding additional list elements.
|--------|---------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `list` | `[]` | When the `db` chart role is used at least one of `databases`, `awsDatabases`,<br/> `azureDatabases`, `databaseResources` is required. |
`databaseResources` is a YAML list object detailing the resource selectors of the databases that should be proxied by Teleport Database Access.
`databaseResources` is a YAML list object detailing the resource selectors of the databases that should be proxied by the Teleport Database Service.
You can specify multiple selectors by adding elements to the list.

View file

@ -1,10 +1,10 @@
---
title: Server Access Getting Started Guide
description: Getting started with Teleport Server Access.
description: Getting started with Teleport server access.
videoBanner: 8aiVin0LvmE
---
Server Access involves managing your resources, configuring new clusters, and
Server access involves managing your resources, configuring new clusters, and
issuing commands through a CLI or programmatically to an API.
This guide introduces some of these common scenarios and how to interact with

View file

@ -1,6 +1,6 @@
---
title: Server Access Guides
description: Teleport Server Access guides.
description: Teleport server access guides.
layout: tocless-doc
---

View file

@ -79,10 +79,10 @@ of the Linux distribution being used. See [User/Group Name Syntax](https://syste
<Admonition type="warning">
When a Teleport user accesses a Node, Teleport Server Access checks each of the
user's roles that match the Node. If at least one role matches the Node but does not
include `create_host_user: true`, automatic user creation will be disabled. Roles that
do not match the Node will not be checked.
When a Teleport user accesses an SSH Service instance, Teleport checks each of
the user's roles that match the instance. If at least one role matches the
instance but does not include `create_host_user: true`, automatic user creation
will be disabled. Roles that do not match the Node will not be checked.
</Admonition>

View file

@ -5,7 +5,7 @@ h1: SFTP with JetBrains IDE
---
JetBrain's IDEs, like PyCharm, GoLand, and IntelliJ, allow browsing, copying, and editing files on a remote server
using the SFTP protocol. You can integrate Teleport Server Access with your IDE, so you can copy files to and from a remote
using the SFTP protocol. You can integrate Teleport with your IDE so you can copy files to and from a remote
machine without using a third-party client.
This guide explains how to use Teleport and a JetBrains IDE to access files with SFTP.
@ -15,8 +15,9 @@ This guide explains how to use Teleport and a JetBrains IDE to access files with
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- JetBrains IDE like PyCharm, IntelliJ, GoLand etc. See [Products](https://www.jetbrains.com/products/#type=ide) for a full list of JetBrains IDEs.
- One or more Teleport Nodes with Server Access enabled. If you have not yet
done this, read the [Server Access Getting Started Guide](../getting-started.mdx) to learn how.
- One or more Teleport SSH Service instances. If you have not yet done this,
read the [Server Access Getting Started Guide](../getting-started.mdx) to
learn how.
## Step 1/3. First-time setup

View file

@ -1,12 +1,14 @@
---
title: Teleport Server Access Features and Introduction
description: Teleport Server Access features and introduction.
description: Teleport server access features and introduction.
videoBanner: EsEvO5ndNDI
---
Teleport Server Access consolidates SSH access across all environments, decreases configuration complexity, supports industry best practices and compliance while giving complete visibility over all sessions and events.
Teleport consolidates SSH access across all environments, decreases
configuration complexity, supports industry best practices and compliance while
giving complete visibility over all sessions and events.
Teleport Server Access is designed for the following kinds of scenarios:
Teleport server access is designed for the following kinds of scenarios:
1. When up to a vast number of clusters must be managed using the command-line (`tsh`) or programmatically (through the Teleport API) and you want to simplify your stack, security, and configuration complexity.
2. When security team members must track and audit every user session.
@ -15,7 +17,7 @@ Teleport Server Access is designed for the following kinds of scenarios:
## Getting started
- [Get started](getting-started.mdx): Get started using Teleport Server Access in 10 minutes. Server access for most common SSH use-cases.
- [Get started](getting-started.mdx): Get started using Teleport server access in 10 minutes.
- [Integrate with OpenSSH](guides/openssh.mdx): SSO and short-lived certificates for OpenSSH.
## Guides

View file

@ -1,6 +1,6 @@
---
title: Access Controls for Servers
description: Role-based access control (RBAC) for Teleport Server Access.
description: Role-based access control (RBAC) for Teleport server access.
---
You can use Teleport's role-based access control (RBAC) system to set up

Some files were not shown because too many files have changed in this diff Show more