[docs] generalize tctl token partial (#43385)

* use --format=text for discovery guide join token * generalize the tctl join token include * remove default tokenFile from partial
gravitational · Jun 25, 2024 · 40055a8 · 40055a8
1 parent 15f916d
commit 40055a8
Show file tree

Hide file tree

Showing 29 changed files with 35 additions and 44 deletions.
diff --git 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/configuring-access.mdx) guide for h
 
 ## 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/database-access/guides/aws-cassandra-keyspaces.mdx b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx
@@ -29,7 +29,7 @@ Teleport `v11.0`.
 
 ## 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/guides/aws-discovery.mdx b/docs/pages/database-access/guides/aws-discovery.mdx
@@ -15,15 +15,7 @@ description: How to configure Teleport to discover AWS-hosted databases.
 
 ## 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/guides/aws-dynamodb.mdx b/docs/pages/database-access/guides/aws-dynamodb.mdx
@@ -148,7 +148,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/guides/aws-opensearch.mdx b/docs/pages/database-access/guides/aws-opensearch.mdx
@@ -150,7 +150,7 @@ $ tctl create -f aws-opensearch-access.yaml
 
 ## Step 3/4. 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"!)
 
 (!docs/pages/includes/database-access/alternative-methods-join.mdx!)
 

diff --git a/docs/pages/database-access/guides/azure-postgres-mysql.mdx b/docs/pages/database-access/guides/azure-postgres-mysql.mdx
@@ -29,7 +29,7 @@ Teleport `12.0`.
 
 ## 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/guides/cassandra-self-hosted.mdx b/docs/pages/database-access/guides/cassandra-self-hosted.mdx
@@ -28,7 +28,7 @@ Database access for Cassandra & ScyllaDB is available starting from Teleport
 
 ## 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/guides/clickhouse-self-hosted.mdx b/docs/pages/database-access/guides/clickhouse-self-hosted.mdx
@@ -53,7 +53,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/guides/cockroachdb-self-hosted.mdx b/docs/pages/database-access/guides/cockroachdb-self-hosted.mdx
@@ -33,7 +33,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/guides/elastic.mdx b/docs/pages/database-access/guides/elastic.mdx
@@ -19,7 +19,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/guides/mongodb-atlas.mdx b/docs/pages/database-access/guides/mongodb-atlas.mdx
@@ -27,7 +27,7 @@ videoBanner: mu_ZKTjnFJ8
 
 ## 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/guides/mongodb-self-hosted.mdx b/docs/pages/database-access/guides/mongodb-self-hosted.mdx
@@ -39,7 +39,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/guides/mysql-cloudsql.mdx b/docs/pages/database-access/guides/mysql-cloudsql.mdx
@@ -118,7 +118,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/guides/mysql-self-hosted.mdx b/docs/pages/database-access/guides/mysql-self-hosted.mdx
@@ -26,7 +26,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/guides/oracle-self-hosted.mdx b/docs/pages/database-access/guides/oracle-self-hosted.mdx
@@ -24,7 +24,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"!)
 
 <Admonition type="tip">
 

diff --git a/docs/pages/database-access/guides/postgres-cloudsql.mdx b/docs/pages/database-access/guides/postgres-cloudsql.mdx
@@ -74,7 +74,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/guides/postgres-redshift.mdx b/docs/pages/database-access/guides/postgres-redshift.mdx
@@ -34,7 +34,7 @@ videoBanner: UFhT52d5bYg
 
 ## Step 2/5. 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/guides/postgres-self-hosted.mdx b/docs/pages/database-access/guides/postgres-self-hosted.mdx
@@ -27,7 +27,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/guides/redis-aws.mdx b/docs/pages/database-access/guides/redis-aws.mdx
@@ -34,7 +34,7 @@ description: How to configure Teleport database access with AWS ElastiCache and
 
 ## Step 2/7. 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/guides/redis-cluster.mdx b/docs/pages/database-access/guides/redis-cluster.mdx
@@ -40,7 +40,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/guides/redis.mdx b/docs/pages/database-access/guides/redis.mdx
@@ -37,7 +37,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/guides/redshift-serverless.mdx b/docs/pages/database-access/guides/redshift-serverless.mdx
@@ -125,7 +125,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/guides/snowflake.mdx b/docs/pages/database-access/guides/snowflake.mdx
@@ -31,7 +31,7 @@ description: How to configure Teleport database access with Snowflake.
 
 ## 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/guides/sql-server-ad-pkinit.mdx b/docs/pages/database-access/guides/sql-server-ad-pkinit.mdx
@@ -198,7 +198,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/guides/sql-server-ad.mdx b/docs/pages/database-access/guides/sql-server-ad.mdx
@@ -196,7 +196,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"!)
 
 Install Teleport on the host where you will run the Teleport Database Service:
 

diff --git a/docs/pages/database-access/guides/vitess.mdx b/docs/pages/database-access/guides/vitess.mdx
@@ -31,7 +31,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/includes/database-access/rds-proxy.mdx b/docs/pages/includes/database-access/rds-proxy.mdx
@@ -28,7 +28,7 @@ Teleport currently supports RDS Proxy instances with engine family
 
 ## Step 1/5. 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/includes/database-access/token.mdx b/docs/pages/includes/database-access/token.mdx
diff --git a/docs/pages/includes/tctl-token.mdx 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=)
+```