Skip to content

Commit

Permalink
docs: include sudo for db configure create examples (#31039)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenGravy authored Aug 25, 2023
1 parent b7cbfcd commit a8cd22c
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 19 deletions.
6 changes: 4 additions & 2 deletions docs/pages/database-access/guides/aws-cassandra-keyspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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 \
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/aws-opensearch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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=<Var name="proxy-address" /> \
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/database-access/guides/azure-postgres-mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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 \
Expand All @@ -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 \
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/database-access/guides/azure-redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Create the Database Service configuration, specifying a region like this:
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=tele.example.com:443 \
--token=/tmp/token \
Expand All @@ -55,7 +55,7 @@ $ teleport db configure create \
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=teleport.example.com:3080 \
--token=/tmp/token \
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/database-access/guides/azure-sql-server-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Generate a configuration file at `/etc/teleport.yaml` for the Database Service:
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--token=/tmp/token \
--proxy=teleport.example.com \
Expand All @@ -199,7 +199,7 @@ $ teleport db configure create \
</TabItem>
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">
```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--token=/tmp/token \
--proxy=mytenant.teleport.sh:443 \
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/database-access/guides/postgres-redshift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ On the node that is running the Database Service, create a configuration file:
<TabItem scope={["oss", "enterprise"]} label="Self-Hosted">

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=teleport.example.com:3080 \
--token=/tmp/token \
Expand All @@ -58,7 +58,7 @@ $ teleport db configure create \
<TabItem scope={["cloud"]} label="Teleport Enterprise Cloud">

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=mytenant.teleport.sh:443 \
--token=/tmp/token \
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/rds-proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ your Teleport Proxy address or Teleport Cloud tenant (e.g. `mytenant.teleport.sh
and replace <Var name="us-west-1" /> with your preferred region:

```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=<Var name="teleport.example.com"/>:443 \
--token=/tmp/token \
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/rds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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=<Var name="example.teleport.sh:443" /> \
--token=/tmp/token \
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/database-access/guides/redis-aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Create the Database Service configuration:
<Tabs>
<TabItem label="ElastiCache">
```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=teleport.example.com:3080 \
--token=/tmp/token \
Expand All @@ -58,7 +58,7 @@ Create the Database Service configuration:
</TabItem>
<TabItem label="MemoryDB">
```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=teleport.example.com:3080 \
--token=/tmp/token \
Expand All @@ -73,7 +73,7 @@ Create the Database Service configuration:
<Tabs>
<TabItem label="ElastiCache">
```code
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=mytenant.teleport.sh:443 \
--token=/tmp/token \
Expand All @@ -82,7 +82,7 @@ Create the Database Service configuration:
</TabItem>
<TabItem label="MemoryDB">
```
$ teleport db configure create \
$ sudo teleport db configure create \
-o file \
--proxy=mytenant.teleport.sh:443 \
--token=/tmp/token \
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/redshift-serverless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down

0 comments on commit a8cd22c

Please sign in to comment.