aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarco Capitani <m.capitani@nextworks.it>2017-05-31 17:31:27 +0200
committerMarco Capitani <m.capitani@nextworks.it>2017-05-31 17:31:27 +0200
commit95cfb3169e69b7771eef9d77cf6cd99c5357ad16 (patch)
treee59b395e4cf4ee4f2ec7ccc921c81a74278b1548 /README.md
parent49c09c68da6b99c1c3b9b61df5547fbaf5ada712 (diff)
parent24c375545c6ef7d03e8a18dea2cb06763059b1b9 (diff)
downloadrumba-95cfb3169e69b7771eef9d77cf6cd99c5357ad16.tar.gz
rumba-95cfb3169e69b7771eef9d77cf6cd99c5357ad16.zip
Merge branch 'master' into jfed-irati-fixes
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 28 insertions, 9 deletions
diff --git a/README.md b/README.md
index d6e0839..9bd7d38 100644
--- a/README.md
+++ b/README.md
@@ -37,12 +37,19 @@ a look at the examples/ folder.
## Installation
+ For Debian and Ubuntu, the following command will ensure that the
+ required dependencies are installed (replace python-dev with python3-dev
+ if using Python 3):
+
+ # apt-get install build-essential libssl-dev libffi-dev python-dev
+
Rumba can be found on the
[PyPi](https://pypi.python.org/pypi/Rumba) and can thus be
installed through pip, by using `pip install rumba`. However, to
install the latest version, after cloning the repository, a user
can also issue `python setup.py install`.
+
## Supported prototypes
* [IRATI](https://github.com/IRATI/stack) is an open source
@@ -82,16 +89,28 @@ a look at the examples/ folder.
Here the experiment name is rochefort10, the user's name is
ricksanchez, and the certificate can be found in
- /home/morty/cert.pem. Please use an absolute path for cert_file for
- now.
+ /home/morty/cert.pem. An absolute path must be used for cert_file.
- Before running the experiment it is wise to use an SSH agent to
- avoid having to enter the passphrase for every login to a node by
- the framework if you are not on an IPv6 enabled network. (Apart
- from asking for the passphrase to login to the nodes, the framework
+ Before running the rumba you must run an SSH agent in same terminal.
+ This will also avoid you having to enter the passphrase for every
+ login to a node by the framework if you are not on an IPv6 enabled network.
+ (Apart from asking for the passphrase to login to the nodes, the framework
will always ask for the passphrase since it is needed by the jFed
CLI as well.) In order to start an SSH agent and to add the
- certificate, simply perform the following commands:
+ certificate, type the following commands:
+
+ $ eval `ssh-agent`
+ $ ssh-add /home/morty/cert.pem
+
+ To access a node once the experiment swapped in, use the following
+ command (in the same terminal where ssh-agent was run):
+
+ $ ssh -A -oProxyCommand="ssh -i $CERTPATH
+ -o StrictHostKeyChecking=no $USER@bastion.test.iminds.be
+ nc $NODENAME.$EXP.wall2-ilabt-iminds-be.wall2.ilabt.iminds.be 22"
+ $USER@$NODENAME.$EXP.wall2-ilabt-iminds-be.wall2.ilabt.iminds.be
- eval `ssh-agent`
- ssh-add /home/morty/cert.pem
+ where $CERTPATH is the absolute path of the certificate (e.g.
+ /home/morty/cert.pem), $USER is the jFed username (e.g. "ricksanchez"),
+ $NODENAME is the name of the node you want to access (e.g. "a"),
+ and $EXP is the name of the experiment (e.g. "rochefort10").