diff --git a/docs/pages/auto-discovery/databases.mdx b/docs/pages/auto-discovery/databases.mdx index 9676f945ae835..eec0c3ae7aa53 100644 --- a/docs/pages/auto-discovery/databases.mdx +++ b/docs/pages/auto-discovery/databases.mdx @@ -26,15 +26,7 @@ discover AWS-hosted databases automatically. ## Step 1/4. Generate a join token -The Discovery Service requires a valid join token to connect to the cluster. - -Generate a join token by running the following command against your Teleport -Auth Service and save it in `/tmp/token` on the host that will run the -Discovery Service. - -```code -$ tctl tokens add --type=discovery -``` +(!docs/pages/includes/tctl-token.mdx serviceName="Discovery" tokenType="discovery" tokenFile="/tmp/token" !) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/database-access/enroll-aws-databases/aws-cassandra-keyspaces.mdx b/docs/pages/database-access/enroll-aws-databases/aws-cassandra-keyspaces.mdx index 6ea700d2eae1e..aa9bbdcfc936c 100644 --- a/docs/pages/database-access/enroll-aws-databases/aws-cassandra-keyspaces.mdx +++ b/docs/pages/database-access/enroll-aws-databases/aws-cassandra-keyspaces.mdx @@ -30,7 +30,7 @@ description: How to configure Teleport database access with Amazon Keyspaces (Ap ## Step 1/5. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/database-access/enroll-aws-databases/aws-dynamodb.mdx b/docs/pages/database-access/enroll-aws-databases/aws-dynamodb.mdx index 074fb1b93f7c0..0d3c94008ac95 100644 --- a/docs/pages/database-access/enroll-aws-databases/aws-dynamodb.mdx +++ b/docs/pages/database-access/enroll-aws-databases/aws-dynamodb.mdx @@ -155,7 +155,7 @@ the correct STS endpoint. (!docs/pages/includes/database-access/alternative-methods-join.mdx!) -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) ### Install and start Teleport diff --git a/docs/pages/database-access/enroll-aws-databases/aws-opensearch.mdx b/docs/pages/database-access/enroll-aws-databases/aws-opensearch.mdx index e7590adcd5a14..61c9510f52b1b 100644 --- a/docs/pages/database-access/enroll-aws-databases/aws-opensearch.mdx +++ b/docs/pages/database-access/enroll-aws-databases/aws-opensearch.mdx @@ -190,7 +190,7 @@ Teleport: -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Use the token provided by the output of this command in the next step. diff --git a/docs/pages/database-access/enroll-aws-databases/postgres-redshift.mdx b/docs/pages/database-access/enroll-aws-databases/postgres-redshift.mdx index a018a2217e08e..89d51eb064639 100644 --- a/docs/pages/database-access/enroll-aws-databases/postgres-redshift.mdx +++ b/docs/pages/database-access/enroll-aws-databases/postgres-redshift.mdx @@ -42,7 +42,7 @@ automatically enroll all AWS databases in your infrastructure. ## Step 2/6. Create a Database Service configuration -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/database-access/enroll-aws-databases/redis-aws.mdx b/docs/pages/database-access/enroll-aws-databases/redis-aws.mdx index 2b402925b2638..c2898082c0413 100644 --- a/docs/pages/database-access/enroll-aws-databases/redis-aws.mdx +++ b/docs/pages/database-access/enroll-aws-databases/redis-aws.mdx @@ -58,7 +58,7 @@ databases in your infrastructure. ## Step 2/6. Create a Database Service configuration -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/database-access/enroll-aws-databases/redshift-serverless.mdx b/docs/pages/database-access/enroll-aws-databases/redshift-serverless.mdx index 9dc780caf38e8..fdd96612815ab 100644 --- a/docs/pages/database-access/enroll-aws-databases/redshift-serverless.mdx +++ b/docs/pages/database-access/enroll-aws-databases/redshift-serverless.mdx @@ -134,7 +134,7 @@ role 'redshift-serverless-access' has been created ## Step 3/4. Install and start the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/database-access/enroll-aws-databases/sql-server-ad.mdx b/docs/pages/database-access/enroll-aws-databases/sql-server-ad.mdx index 745e7b373cb6d..ba0fd4c8bf7db 100644 --- a/docs/pages/database-access/enroll-aws-databases/sql-server-ad.mdx +++ b/docs/pages/database-access/enroll-aws-databases/sql-server-ad.mdx @@ -205,7 +205,7 @@ KVNO Principal ## Step 4/7. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/install-linux.mdx!) diff --git a/docs/pages/database-access/enroll-azure-databases/azure-postgres-mysql.mdx b/docs/pages/database-access/enroll-azure-databases/azure-postgres-mysql.mdx index f3987c00cea28..a3c05ded2899a 100644 --- a/docs/pages/database-access/enroll-azure-databases/azure-postgres-mysql.mdx +++ b/docs/pages/database-access/enroll-azure-databases/azure-postgres-mysql.mdx @@ -37,7 +37,7 @@ database. ## Step 1/5. Install the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install Teleport on the host where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-google-cloud-databases/mysql-cloudsql.mdx b/docs/pages/database-access/enroll-google-cloud-databases/mysql-cloudsql.mdx index e45544c14be22..25e216eb19a1f 100644 --- a/docs/pages/database-access/enroll-google-cloud-databases/mysql-cloudsql.mdx +++ b/docs/pages/database-access/enroll-google-cloud-databases/mysql-cloudsql.mdx @@ -122,7 +122,7 @@ Cloud documentation for more info. ### Create a join token -(!docs/pages/includes/database-access/token.mdx tokenFile="/tmp/token" !) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token" !) ### (Optional) Download the Cloud SQL CA certificate diff --git a/docs/pages/database-access/enroll-google-cloud-databases/postgres-cloudsql.mdx b/docs/pages/database-access/enroll-google-cloud-databases/postgres-cloudsql.mdx index 21369e48d3586..e1ef7bf30f261 100644 --- a/docs/pages/database-access/enroll-google-cloud-databases/postgres-cloudsql.mdx +++ b/docs/pages/database-access/enroll-google-cloud-databases/postgres-cloudsql.mdx @@ -78,7 +78,7 @@ in Google Cloud documentation for more info. ### Create a join token -(!docs/pages/includes/database-access/token.mdx tokenFile="/tmp/token"!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) ### (Optional) Download the Cloud SQL CA certificate diff --git a/docs/pages/database-access/enroll-google-cloud-databases/spanner.mdx b/docs/pages/database-access/enroll-google-cloud-databases/spanner.mdx index 4357abbee1558..9c4c8cd9003e5 100644 --- a/docs/pages/database-access/enroll-google-cloud-databases/spanner.mdx +++ b/docs/pages/database-access/enroll-google-cloud-databases/spanner.mdx @@ -110,7 +110,7 @@ Select the "Service Account Token Creator" role and save the change: ## Step 4/8. Configure the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx tokenFile="/tmp/token" !) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token" !) Provide the following information and then generate a configuration file for the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-managed-databases/mongodb-atlas.mdx b/docs/pages/database-access/enroll-managed-databases/mongodb-atlas.mdx index 819d73fd25e87..edb812574a14c 100644 --- a/docs/pages/database-access/enroll-managed-databases/mongodb-atlas.mdx +++ b/docs/pages/database-access/enroll-managed-databases/mongodb-atlas.mdx @@ -36,7 +36,7 @@ forwards user traffic to MongoDB Atlas. ## Step 1/4. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install Teleport on the host where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-managed-databases/snowflake.mdx b/docs/pages/database-access/enroll-managed-databases/snowflake.mdx index b4282daa2f21a..ac5b844c34655 100644 --- a/docs/pages/database-access/enroll-managed-databases/snowflake.mdx +++ b/docs/pages/database-access/enroll-managed-databases/snowflake.mdx @@ -39,7 +39,7 @@ forwards the user's requests to Snowflake as Teleport-authenticated messages. ## Step 1/5. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx index b825c7199ddef..5d6f759042167 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/cassandra-self-hosted.mdx @@ -31,7 +31,7 @@ description: How to configure Teleport database access with Cassandra and Scylla ## Step 1/5. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx index 5235289a98c58..e9fa8d0005087 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/clickhouse-self-hosted.mdx @@ -58,7 +58,7 @@ choose: ## Step 1/5. Create a Teleport token and user -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/create-user.mdx!) diff --git a/docs/pages/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted.mdx index ba608510a9dd8..b7878caf8750d 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/cockroachdb-self-hosted.mdx @@ -37,7 +37,7 @@ description: How to configure Teleport database access with self-hosted Cockroac ## Step 1/4. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/elastic.mdx b/docs/pages/database-access/enroll-self-hosted-databases/elastic.mdx index a7e35ae2d469c..50a63a0131367 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/elastic.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/elastic.mdx @@ -26,7 +26,7 @@ description: How to configure Teleport database access with Elasticsearch. ## Step 1/5. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx index 24e1441a48350..b3ba4a8614597 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/mongodb-self-hosted.mdx @@ -44,7 +44,7 @@ videoBanner: 6lgVObxoLkc ### Set up the Teleport Database service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/mysql-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/mysql-self-hosted.mdx index ca1f5d3fc6fbe..2b50366f31018 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/mysql-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/mysql-self-hosted.mdx @@ -32,7 +32,7 @@ description: How to configure Teleport database access with self-hosted MySQL/Ma ## Step 1/4. Create the Teleport Database Token -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) ## Step 2/4. Create a certificate/key pair diff --git a/docs/pages/database-access/enroll-self-hosted-databases/oracle-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/oracle-self-hosted.mdx index cab1b23341378..69842ac20b986 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/oracle-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/oracle-self-hosted.mdx @@ -30,7 +30,7 @@ description: How to configure Teleport database access with Oracle. ## Step 1/6. Create a Teleport token and user -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) diff --git a/docs/pages/database-access/enroll-self-hosted-databases/postgres-self-hosted.mdx b/docs/pages/database-access/enroll-self-hosted-databases/postgres-self-hosted.mdx index 68da546d0375c..4278706303541 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/postgres-self-hosted.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/postgres-self-hosted.mdx @@ -33,7 +33,7 @@ description: How to configure Teleport database access with self-hosted PostgreS ## Step 1/5. Create a Teleport token and user -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) ### Create a Teleport user diff --git a/docs/pages/database-access/enroll-self-hosted-databases/redis-cluster.mdx b/docs/pages/database-access/enroll-self-hosted-databases/redis-cluster.mdx index 9efeed1c961b8..5b5fc7e1a2890 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/redis-cluster.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/redis-cluster.mdx @@ -44,7 +44,7 @@ If you want to configure Redis Standalone, please read [Database Access with Red ## Step 1/6. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx b/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx index 284daf6768057..df4b5f151b781 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/redis.mdx @@ -44,7 +44,7 @@ If you want to configure Redis Cluster, please read [Database Access with Redis ## Step 1/5. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install and configure Teleport where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit.mdx b/docs/pages/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit.mdx index 1cddebd5856d5..aa4ce33048d1a 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/sql-server-ad-pkinit.mdx @@ -208,7 +208,7 @@ from there, you can copy and use it on your database configuration. ## Step 4/7. Set up the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) Install Teleport on the host where you will run the Teleport Database Service: diff --git a/docs/pages/database-access/enroll-self-hosted-databases/vitess.mdx b/docs/pages/database-access/enroll-self-hosted-databases/vitess.mdx index c2df5709bc1b3..3b6cf827dce18 100644 --- a/docs/pages/database-access/enroll-self-hosted-databases/vitess.mdx +++ b/docs/pages/database-access/enroll-self-hosted-databases/vitess.mdx @@ -37,7 +37,7 @@ description: How to configure Teleport database access for Vitess (MySQL protoco ## Step 1/4. Create the Teleport Database Token -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) ## Step 2/4. Create a certificate/key pair diff --git a/docs/pages/database-access/getting-started.mdx b/docs/pages/database-access/getting-started.mdx index c029988ef29da..b440d9c10c61f 100644 --- a/docs/pages/database-access/getting-started.mdx +++ b/docs/pages/database-access/getting-started.mdx @@ -87,7 +87,7 @@ See the [Automatic User Provisioning](./rbac.mdx) guide for how to configure Tel ## Step 2/5. Configure the Teleport Database Service -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/includes/database-access/rds-proxy.mdx b/docs/pages/includes/database-access/rds-proxy.mdx index 8989a51dcf7b9..bfaccfbc4809b 100644 --- a/docs/pages/includes/database-access/rds-proxy.mdx +++ b/docs/pages/includes/database-access/rds-proxy.mdx @@ -40,7 +40,7 @@ automatically enroll all AWS databases in your infrastructure. ## Step 2/7. Create a Teleport Database Service configuration -(!docs/pages/includes/database-access/token.mdx!) +(!docs/pages/includes/tctl-token.mdx serviceName="Database" tokenType="db" tokenFile="/tmp/token"!) (!docs/pages/includes/database-access/alternative-methods-join.mdx!) diff --git a/docs/pages/includes/database-access/token.mdx b/docs/pages/includes/database-access/token.mdx deleted file mode 100644 index 294564661f3f6..0000000000000 --- a/docs/pages/includes/database-access/token.mdx +++ /dev/null @@ -1,9 +0,0 @@ -{{ tokenFile="/tmp/token" }} - -The Database Service requires a valid join token to join your Teleport cluster. -Run the following `tctl` command and save the token output in `{{ tokenFile }}` -on the server that will run the Database Service: - -```code -$ tctl tokens add --type=db --format=text -``` diff --git a/docs/pages/includes/tctl-token.mdx b/docs/pages/includes/tctl-token.mdx new file mode 100644 index 0000000000000..a2f1ad05eee6f --- /dev/null +++ b/docs/pages/includes/tctl-token.mdx @@ -0,0 +1,8 @@ +The {{ serviceName }} Service requires a valid join token to join your Teleport cluster. +Run the following `tctl` command and save the token output in `{{ tokenFile }}` +on the server that will run the {{ serviceName }} Service: + +```code +$ tctl tokens add --type={{ tokenType }} --format=text +(=presets.tokens.first=) +```