Skip to content

Commit 8113660

Browse files
committed
Merge pull request #2648 from mboersma/docs-sshpkey-is-path
docs(deisctl): add examples and sshPrivateKey=path to config usage
2 parents f9363f0 + a02102d commit 8113660

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

deisctl/cmd/cmd.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,12 +579,20 @@ A configuration value is stored and retrieved from a key/value store
579579
values are typically used for component-level configuration, such as
580580
enabling TLS for the routers.
581581
582+
Note: "deisctl config platform set sshPrivateKey=" expects a path
583+
to a private key.
584+
582585
Usage:
583586
deisctl config <target> get [<key>...] [options]
584587
deisctl config <target> set <key=val>... [options]
585588
586589
Options:
587590
--verbose print out the request bodies [default: false]
591+
592+
Examples:
593+
deisctl config platform set domain=mydomain.com
594+
deisctl config platform set sshPrivateKey=$HOME/.ssh/deis
595+
deisctl config controller get webEnabled
588596
`
589597
// parse command-line arguments
590598
args, err := docopt.Parse(usage, argv, true, "", false)

0 commit comments

Comments
 (0)