From a8cd22c35fa4810338a133876311705a9048b24a Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Fri, 25 Aug 2023 17:37:44 -0400 Subject: [PATCH] docs: include sudo for db configure create examples (#31039) --- .../database-access/guides/aws-cassandra-keyspaces.mdx | 6 ++++-- docs/pages/database-access/guides/aws-opensearch.mdx | 2 +- .../pages/database-access/guides/azure-postgres-mysql.mdx | 6 +++--- docs/pages/database-access/guides/azure-redis.mdx | 4 ++-- docs/pages/database-access/guides/azure-sql-server-ad.mdx | 4 ++-- docs/pages/database-access/guides/postgres-redshift.mdx | 4 ++-- docs/pages/database-access/guides/rds-proxy.mdx | 2 +- docs/pages/database-access/guides/rds.mdx | 2 +- docs/pages/database-access/guides/redis-aws.mdx | 8 ++++---- docs/pages/database-access/guides/redshift-serverless.mdx | 2 +- 10 files changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx index 699691d440e2..3bf225230eb2 100644 --- a/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx +++ b/docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx @@ -51,7 +51,8 @@ Create a configuration for the Teleport Database Service, pointing the `--proxy` flag to the address of your Teleport Proxy Service: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ + -o file \ --token=/tmp/token \ --proxy=teleport.example.com:443 \ --name=keyspaces \ @@ -68,7 +69,8 @@ Create a configuration for the Teleport Database Service, pointing the `--proxy` flag to the address of your Teleport Proxy Service: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ + -o file \ --token=/tmp/token \ --proxy=mytenant.teleport.sh:443 \ --name=keyspaces \ diff --git a/docs/pages/database-access/guides/aws-opensearch.mdx b/docs/pages/database-access/guides/aws-opensearch.mdx index 66fb6cc5fc06..1871f8f2f8c8 100644 --- a/docs/pages/database-access/guides/aws-opensearch.mdx +++ b/docs/pages/database-access/guides/aws-opensearch.mdx @@ -204,7 +204,7 @@ your terminal, and manually adjust `/etc/teleport.yaml`. Generate a configuration file at `/etc/teleport.yaml` for the Database Service: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy= \ diff --git a/docs/pages/database-access/guides/azure-postgres-mysql.mdx b/docs/pages/database-access/guides/azure-postgres-mysql.mdx index fa16f5ac5ddd..2338e1e16896 100644 --- a/docs/pages/database-access/guides/azure-postgres-mysql.mdx +++ b/docs/pages/database-access/guides/azure-postgres-mysql.mdx @@ -56,7 +56,7 @@ Create the Database Service configuration. URI (e.g. `mytenant.teleport.sh:443`): ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:443 \ --token=/tmp/token \ @@ -72,7 +72,7 @@ Create the Database Service configuration. URI (e.g. `mytenant.teleport.sh:443`): ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:443 \ --token=/tmp/token \ @@ -86,7 +86,7 @@ Create the Database Service configuration. Run the following command on your Database Service host: ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:443 \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/azure-redis.mdx b/docs/pages/database-access/guides/azure-redis.mdx index cac9f5622ec8..8a451b9cb80a 100644 --- a/docs/pages/database-access/guides/azure-redis.mdx +++ b/docs/pages/database-access/guides/azure-redis.mdx @@ -45,7 +45,7 @@ Create the Database Service configuration, specifying a region like this: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=tele.example.com:443 \ --token=/tmp/token \ @@ -55,7 +55,7 @@ $ teleport db configure create \ ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:3080 \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/azure-sql-server-ad.mdx b/docs/pages/database-access/guides/azure-sql-server-ad.mdx index d733b809f703..3b8e3c805e42 100644 --- a/docs/pages/database-access/guides/azure-sql-server-ad.mdx +++ b/docs/pages/database-access/guides/azure-sql-server-ad.mdx @@ -189,7 +189,7 @@ Generate a configuration file at `/etc/teleport.yaml` for the Database Service: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy=teleport.example.com \ @@ -199,7 +199,7 @@ $ teleport db configure create \ ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy=mytenant.teleport.sh:443 \ diff --git a/docs/pages/database-access/guides/postgres-redshift.mdx b/docs/pages/database-access/guides/postgres-redshift.mdx index beee759d8a96..d88d6033e6c3 100644 --- a/docs/pages/database-access/guides/postgres-redshift.mdx +++ b/docs/pages/database-access/guides/postgres-redshift.mdx @@ -47,7 +47,7 @@ On the node that is running the Database Service, create a configuration file: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:3080 \ --token=/tmp/token \ @@ -58,7 +58,7 @@ $ teleport db configure create \ ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=mytenant.teleport.sh:443 \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/rds-proxy.mdx b/docs/pages/database-access/guides/rds-proxy.mdx index 0b1baf6960ea..a7738155d138 100644 --- a/docs/pages/database-access/guides/rds-proxy.mdx +++ b/docs/pages/database-access/guides/rds-proxy.mdx @@ -47,7 +47,7 @@ your Teleport Proxy address or Teleport Cloud tenant (e.g. `mytenant.teleport.sh and replace with your preferred region: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=:443 \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/rds.mdx b/docs/pages/database-access/guides/rds.mdx index 8e1d1ec055dd..7cd968704241 100644 --- a/docs/pages/database-access/guides/rds.mdx +++ b/docs/pages/database-access/guides/rds.mdx @@ -141,7 +141,7 @@ the region associated with the RDS databases you would like Teleport to discover. ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy= \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/redis-aws.mdx b/docs/pages/database-access/guides/redis-aws.mdx index 105fe4b609b2..ef68cb1418c0 100644 --- a/docs/pages/database-access/guides/redis-aws.mdx +++ b/docs/pages/database-access/guides/redis-aws.mdx @@ -49,7 +49,7 @@ Create the Database Service configuration: ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:3080 \ --token=/tmp/token \ @@ -58,7 +58,7 @@ Create the Database Service configuration: ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:3080 \ --token=/tmp/token \ @@ -73,7 +73,7 @@ Create the Database Service configuration: ```code - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=mytenant.teleport.sh:443 \ --token=/tmp/token \ @@ -82,7 +82,7 @@ Create the Database Service configuration: ``` - $ teleport db configure create \ + $ sudo teleport db configure create \ -o file \ --proxy=mytenant.teleport.sh:443 \ --token=/tmp/token \ diff --git a/docs/pages/database-access/guides/redshift-serverless.mdx b/docs/pages/database-access/guides/redshift-serverless.mdx index 83da04989d03..0b9738d3f74c 100644 --- a/docs/pages/database-access/guides/redshift-serverless.mdx +++ b/docs/pages/database-access/guides/redshift-serverless.mdx @@ -203,7 +203,7 @@ Install Teleport on the host where you will run the Teleport Database Service: On the same host, create a Teleport configuration file: ```code -$ teleport db configure create \ +$ sudo teleport db configure create \ -o file \ --proxy=teleport.example.com:443 \ --token=/tmp/token \