Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update teleport start descriptions #50536

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update teleport start descriptions #50536

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33c06b9
update teleport start descriptions
stevenGravy Dec 21, 2024
47d1a08
verbiage update for description
stevenGravy Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions tool/teleport/common/usage.go
View file
Open in desktop
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
Loading