Skip to content

Commit 25b4217

Browse files
committed
docs(*): clarify that auth SSH key for clusters cannot have a password
1 parent 49c52ba commit 25b4217

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ The parameters to `deis clusters:create` are:
126126
* cluster name (`dev`) - the name used by Deis to reference the cluster
127127
* cluster hostname (`local.deisapp.com`) - the hostname under which apps are created, like `balancing-giraffe.local.deisapp.com`
128128
* cluster members (`--hosts`) - a comma-separated list of cluster members -- not necessarily all members, but at least one (for cloud providers, this is a list of the IPs like `--hosts=10.21.12.1,10.21.12.2,10.21.12.3`)
129-
* auth SSH key (`--auth`) - the SSH private key used to provision servers (for cloud providers, this key is likely `~/.ssh/deis`)
129+
* auth SSH key (`--auth`) - the SSH private key used to provision servers -- cannot have a password (for cloud providers, this key is likely `~/.ssh/deis`)
130130

131131
The `dev` cluster will be used as the default cluster for future `deis` commands.
132132

client/deis.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -885,8 +885,8 @@ def clusters_create(self, args):
885885
--hosts=<hosts>
886886
a comma-separated list of the cluster members' private IP addresses.
887887
--auth=<auth>
888-
a local file path to a SSH private key. This is the key used to provision and
889-
connect to the cluster members.
888+
a local file path to an SSH private key. This is the key used to provision and
889+
connect to the cluster members. This key must not have a password.
890890
891891
NOTE: for EC2 and Rackspace, this key is likely `~/.ssh/deis`.
892892
@@ -1013,9 +1013,10 @@ def clusters_update(self, args):
10131013
a domain under which app hostnames will live. See `deis help clusters:create`
10141014
for more information.
10151015
--hosts=<hosts>
1016-
a comma-separated list of cluster members.
1016+
a comma-separated list of the cluster members' private IP addresses.
10171017
--auth=<auth>
1018-
a local file path to a SSH private key used to connect to cluster members.
1018+
a local file path to an SSH private key. This is the key used to provision and
1019+
connect to the cluster members. This key must not have a password.
10191020
--type=<type>
10201021
cluster type (default: coreos).
10211022
--id=<id>

docs/installing_deis/create-cluster.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The parameters to `deis clusters:create` are:
1414
* cluster name - the name used by Deis to reference the cluster
1515
* cluster hostname - the hostname for the cluster -- applications are accessible under this domain
1616
* cluster members (`--hosts`) - a comma-separated list of IP addresses of cluster members -- not necessarily all members, but at least one
17-
* auth SSH key (`--auth`) - the SSH private key used to provision servers (for cloud providers, this key is likely `~/.ssh/deis`)
17+
* auth SSH key (`--auth`) - the SSH private key used to provision servers -- cannot have a password (for cloud providers, this key is likely `~/.ssh/deis`)
1818

1919
For example, to create a cluster on a local Deis installation:
2020

0 commit comments

Comments
 (0)