Skip to content

Commit

Permalink
docs: update rds db access instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenGravy committed Apr 30, 2024
1 parent 08fd33e commit 4bf6b9e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 4 additions & 2 deletions docs/pages/database-access/guides/rds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Teleport Proxy Service or Enterprise Cloud site. Assign <Var name="us-west-1" />
to the region associated with the RDS database.

Run the following command to proxy an AWS Aurora cluster, assigning <Var
name="RDS_URI" /> to your cluster's domain name and port and <Var
name="RDS_URI" /> to your cluster's domain name, port, AWS <Var name="RDS_REGION" /> region and <Var
name="protocol" /> to either `postgres` or `mysql`, depending on the database
you want to proxy:

Expand All @@ -170,11 +170,12 @@ $ sudo teleport db configure create \
--proxy=<Var name="example.teleport.sh:443" /> \
--protocol=<Var name="protocol" /> \
--uri=<Var name="RDS_URI" /> \
--aws-region=<Var name="RDS_REGION" /> \
--token=/tmp/token
```

Run the following command to proxy an AWS RDS instance, assigning <Var
name="RDS_URI" /> to your instance's domain name and port and <Var
name="RDS_URI" /> to your instance's domain name, port, AWS <Var name="RDS_REGION" /> region and <Var
name="protocol" /> to either `postgres` or `mysql`, depending on the database
you want to proxy:

Expand All @@ -185,6 +186,7 @@ $ sudo teleport db configure create \
--proxy=<Var name="example.teleport.sh:443" /> \
--protocol=<Var name="protocol" /> \
--uri=<Var name="RDS_URI" /> \
--aws-region=<Var name="RDS_REGION" /> \
--token=/tmp/token
```

Expand Down
9 changes: 5 additions & 4 deletions docs/pages/includes/database-access/rds-proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,22 @@ Install Teleport on the host where you will run the Teleport Database Service:

Create the Database Service configuration. Replace <Var
name="teleport.example.com" /> with the domain name of your Teleport Proxy
Service or Teleport Cloud account (e.g. `example.teleport.sh`) and
<Var name="DATABASE_URI" /> with the host and port of the database you want to
Service or Teleport Cloud account (e.g. `example.teleport.sh`),

Check failure on line 51 in docs/pages/includes/database-access/rds-proxy.mdx

View workflow job for this annotation

GitHub Actions / Lint docs prose style

[vale] reported by reviewdog 🐶 [messaging.edition-names] "Teleport Cloud" is no longer a recognized Teleport edition. Use "Teleport Enterprise" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., "Teleport Enterprise (self-hosted)" or "Teleport Enterprise (cloud-hosted)". Raw Output: {"message": "[messaging.edition-names] \"Teleport Cloud\" is no longer a recognized Teleport edition. Use \"Teleport Enterprise\" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., \"Teleport Enterprise (self-hosted)\" or \"Teleport Enterprise (cloud-hosted)\".", "location": {"path": "docs/pages/includes/database-access/rds-proxy.mdx", "range": {"start": {"line": 51, "column": 12}}}, "severity": "ERROR"}
<Var name="DATABASE_URI" /> with the host and port of the database, and AWS <Var name="RDS_REGION" /> region you want to
proxy:

```code
$ sudo teleport db configure create \
-o file \
--proxy=<Var name="teleport.example.com"/>:443 \
--uri=<Var name="DATABASE_URI" /> |
--uri=<Var name="DATABASE_URI" /> \
--aws-region=<Var name="RDS_REGION" /> \
--protocol={{ protocol }} \
--token=/tmp/token
```

The command will generate a Database Service configuration with RDS Proxy
instances auto-discovery enabled on the <Var name="us-west-1" /> region and
instances auto-discovery enabled on the <Var name="RDS_REGION" /> region and
place it at the `/etc/teleport.yaml` location.

## Step 2/5. Create an IAM policy for Teleport
Expand Down

0 comments on commit 4bf6b9e

Please sign in to comment.