Skip to content

Commit a5bd11b

Browse files
committed
Small fixes to the docs
1 parent a75a213 commit a5bd11b

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ __pycache__/
22
*pyc
33
.dropbox.attr
44
ansible/setup.retry
5-
my.key
65
my.key.pub

rtd/user-guide/installation.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ its dependencies on a dedicated machine. The files therein define an
2828
#### What is Ansible
2929

3030
Ansible is a deployment tool that allows an automatic provisioning of machines
31-
on the cloud (it can be used on AWS, DigitalOcean, Google Cloud Platform etc.)
32-
The user installs ansible on a local machine (this can be your old laptop),
33-
defines ansible commands in specific files and uses them to set up a remote
34-
machine.
31+
on the cloud (it can be used on AWS, DigitalOcean, Google Cloud Platform etc.).
32+
The user installs it on a local machine (this can be your old laptop), defines
33+
commands in specific files and uses them to set up a remote machine.
3534

3635
In the following we will assume that you have installed ansible on your local
3736
laptop and you want to set up MinVar on a remote machine running Linux Ubuntu 16.04.
3837
The access to this machine is provided by private-public SSH key pair that must be
39-
set up. Good instructions for this task can be found in this [help](https://help.ubuntu.com/community/SSH/OpenSSH/Keys).
38+
set up. Good instructions for this task can be found in this
39+
[help](https://help.ubuntu.com/community/SSH/OpenSSH/Keys).
4040

4141
#### How to proceed
4242

@@ -46,10 +46,10 @@ set up. Good instructions for this task can be found in this [help](https://help
4646
or download/unzip it,
4747
3. move to the directory `ansible` in the cloned repository and identify the file
4848
`hosts`. This file contains two lines `[minvarmachine]` and a fake ip address.
49-
Adapt to the name of the machine you want to setup and its address,
49+
Edit the address to the one of the machine you want to setup,
5050
4. in the same directory edit the file `setup-hosts.sh`: adapt
51-
`--key-file=path_to_your_private_key` to point to your personal *private* key,
52-
5. copy your personal *public* key into `my.key`,
51+
`--key-file=path_to_your_private_key` to point to your personal **private** key,
52+
5. copy your personal **public** key into `my.key`,
5353
6. run `./setup-hosts.sh`.
5454

5555
#### What can go wrong
@@ -60,6 +60,11 @@ Oracle in order to run `picard`. You can find
6060
[here](https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-get-on-ubuntu-16-04)
6161
a good tutorial on this.
6262

63+
`UNREACHABLE!` usually means that the private/public key pair does not work.
64+
You must be able to ssh into the remote machine with this command (edit accordingly)
65+
66+
ssh -i path_to_your_private_key ubuntu@remote_ip_address
67+
6368
### If you don't want to use ansible
6469

6570
The ansible [playbook](https://github.com/ozagordi/MinVar/blob/master/ansible/setup.yml)

0 commit comments

Comments
 (0)