Skip to content

Commit

Permalink
[v15] update teleport start descriptions (#50694)
Browse files Browse the repository at this point in the history
* update teleport start descriptions

* verbiage update for description
  • Loading branch information
stevenGravy authored Jan 2, 2025
1 parent 8c3b26f commit 94e84e1
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions tool/teleport/common/usage.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,26 @@ const (
--uri="http://localhost:8080" \
--labels=group=dev
Same as the above, but the app server runs with "group=dev" label which only
allows access to users with the role "group=dev".`
allows access to users with the application label "group: dev" in an assigned role.`

dbUsageExamples = `
> teleport db start --token=xyz --auth-server=proxy.example.com:3080 \
--name="example-db" \
--protocol="postgres" \
--uri="localhost:5432"
Starts a database server that proxies PostgreSQL database "example-db" running
at localhost:5432. The database must be configured with Teleport CA and key
pair issued by "tctl auth sign --format=db".
Starts a database server that proxies PostgreSQL database "example-db" running
at localhost:5432. The database must be configured with Teleport CA and key
pair issued by "tctl auth sign --format=db".
> teleport db start --token=xyz --auth-server=proxy.example.com:3080 \
--name="aurora-db" \
--protocol="mysql" \
--uri="example.cluster-abcdefghij.us-west-1.rds.amazonaws.com:3306" \
--aws-region=us-west-1 \
--labels=env=aws
Starts a database server that proxies Aurora MySQL database running in AWS
region us-west-1 which only allows access to users with the role "env=aws".`
Starts a database server that proxies Aurora MySQL database running in AWS
region us-west-1 which only allows access to users with the database label
"env: aws" in an assigned role.`

systemdInstallExamples = `
> teleport install systemd
Expand Down

0 comments on commit 94e84e1

Please sign in to comment.