Skip to content

Commit 1c167b9

Browse files
committed
Merge pull request #445 from tombh/improve-vagrant-docs-for-niccolox
Doc improvements following @niccolox's feedback
2 parents 8cdba92 + a3aa6d4 commit 1c167b9

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

contrib/vagrant/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,16 @@ bear in mind that a local Chef Server VM will take up at least 1GB of RAM.
3535
berks upload [--ssl-verify=false] # Upload the cookbooks to the Chef Server
3636
```
3737

38-
4. Use the provision script to boot the deis controller.
38+
4. The Controller needs to be able to run Vagrant commands on your host machine. It does this via SSH. Therefore
39+
you will need a running SSH server open on port 22 and a means to broadcast your hostname to local DNS.
40+
* On Debian-flavoured Linux you just need to;
41+
`sudo apt-get install openssh-server`
42+
* On Mac OSX you just need to go to **System Preferences -> Sharing** and enable 'Remote Login'.
43+
* [Mac OSX user's should already be broadcasting their hostname](http://support.apple.com/kb/ht3473).
44+
* Linux user's will need to install avahi-daemon, so that their machine is accessible via
45+
[hostname].local. Eg; `sudo apt-get install avahi-daemon`.
46+
47+
5. Use the provision script to boot the Deis Controller.
3948
* If you don't already have the deis-node Vagrant box installed (~1GB). This step might take a long time! If for some reason
4049
you want to manually add it, use:
4150
`vagrant box add deis-node https://s3-us-west-2.amazonaws.com/opdemand/deis-node.box`
@@ -50,15 +59,6 @@ bear in mind that a local Chef Server VM will take up at least 1GB of RAM.
5059
click the 'edit' link on the 'admins' row and then under the 'clients' heading toggle the
5160
'deis-controller' radio button to be enabled. Then confirm the change by saving the group.
5261

53-
5. The Controller needs to be able to run Vagrant commands on your host machine. It does this via SSH. Therefore
54-
you will need a running SSH server open on port 22 and a means to broadcast your hostname to local DNS.
55-
* On Debian-flavoured Linux you just need to;
56-
`sudo apt-get install openssh-server`
57-
* On Mac OSX you just need to go to **System Preferences -> Sharing** and enable 'Remote Login'.
58-
* [Mac OSX user's should already be broadcasting their hostname](http://support.apple.com/kb/ht3473).
59-
* Linux user's will need to install avahi-daemon, so that their machine is accessible via
60-
[hostname].local. Eg; `sudo apt-get install avahi-daemon`.
61-
6262
6. If you want to hack on the actual codebase, you can mount your local codebase onto the VM
6363
by using the custom Vagrantfile.local.
6464
* `cp Vagrantfile.local.example Vagrantfile.local` (don't worry it's in .gitignore)

docs/contributing/localdev.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,12 @@ and a means to broadcast your hostname to local DNS.
133133
Install the Client
134134
------------------
135135
In a development environment you'll want to use the latest version of the client.
136-
Install it by symlinking ``client/deis.py`` to ``deis`` on your local workstation.
136+
Install its dependencies by using the Makefile and symlinking ``client/deis.py`` to ``deis`` on your local workstation.
137137

138138
.. code-block:: console
139139
140+
$ cd $DEIS_DIR/client
141+
$ make install
140142
$ ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
141143
$ deis
142144
Usage: deis <command> [<args>...]

0 commit comments

Comments
 (0)