forked from gravitational/teleport
-
Notifications
You must be signed in to change notification settings - Fork 0
/
usage.go
34 lines (25 loc) · 1.05 KB
/
usage.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
package common
const (
usageNotes = `Notes:
--roles=node,proxy,auth
This flag tells Teleport which services to run. By default it runs all three.
In a production environment you may want to separate them.
--token=xyz
This token is needed to connect a node to an auth server. Obtain it by running
"tctl nodes add" on the auth server. It's used once and ignored afterwards.
`
usageExamples = `
Examples:
> teleport start
By default without any configuration, teleport starts running as a single-node
cluster. It's the equivalent of running with --roles=node,proxy,auth
> teleport start --roles=node --auth-server=10.1.0.1 --token=xyz --nodename=db
Starts a node named 'db' running in strictly SSH mode role, joining the cluster
serviced by the auth server running on 10.5.0.2
> teleport start --roles=node --auth-server=10.1.0.1 --labels=db=master
Same as the above, but the node runs with db=master label and can be connected
to using that label in addition to its name.`
sampleConfComment = `#
# Sample Teleport configuration file.
#`
)