Basic features: First experiment tutorial ========================================= Logging in ---------- There a 2 basic methods to log into jFed: Authority Login (recommended): Either start jFed from the button on the site that provided your account, or start jFed and click on either "Login with Fed4Fire credentials" or "Login with GENI credentials". jFed might will ask your account info and password. (After the first login, you'll only need your password) Manual Login: Alternatively you can start jFed, then click "Login with PEM-certificate". You will need the "certificate file" (a PEM file containing your certificate and private key) that you can find at the website that provided your account. Then, on the next screen, open the "certificate file", provide your password and press the login button. .. figure:: _static/images/5.7/jfed_5.7.0_login.png :width: 400 .. figure:: _static/images/5.7/jfed_5.7.0_login_withPEM.png :width: 400 After you login for the first time, a dialog box will pop up to say that you have to configure jFed for this initial run. You do typically do not need to make any changes, but it might be good to check out some settings. Check Windows Preferences (optional) ++++++++++++++++++++++++++++++++++++ .. figure:: _static/images/5.7/jfed_5.7.0_prefs_putty.png :width: 400 In this preferences settings you should point jFed to the PuTTY installation directory (see :ref:`putty`). You should see all green checkmarks. If not, then please install PuTTY from here: http://the.earth.li/~sgtatham/putty/latest/x86/putty-0.64-installer.exe. Click on ``Use pageant to manage SSH keys`` to enable the PuTTY ssh agent which makes that you only once have to type the passphrase on your ssh key. Click ``Save`` at the bottom right to save these settings. Check Unix/Mac Preferences (optional) +++++++++++++++++++++++++++++++++++++ .. figure:: _static/images/5.7/jfed_5.7.0_prefs_terminal.png :width: 400 In this preferences settings, jFed should have a reasonable terminal configuration, so only change the default if it doesn't work when logging in. .. figure:: _static/images/5.7/jfed_5.7.0_prefs_sshkey.png :width: 400 Secondly, you can click ``Use custom key-pair`` and point jFed to a :ref:`private and public SSH key ` you have saved on your PC. This is not required, as your account is associated with an SSH key that jFed will use. Click ``Save`` at the bottom right to save these settings. Create your first experiment ---------------------------- When you have logged in, and checked your preferences, you see jFed with no experiments loaded. .. figure:: _static/images/5.7/jfed_5.7.0_empty.png :width: 400 When you click ``New``, you get a blank canvas where you can draw your experiment. Let's drag in a ``Generic node`` from the left side to the canvas. .. figure:: _static/images/5.7/jfed_5.7.0_addnode.png :width: 400 For more specific experiments you can right click and configure the node, but for now let it in the default settings. .. figure:: _static/images/5.7/jfed_5.7.0_configurenode.png :width: 400 Run the experiment ------------------ Let's run this experiment, by clicking the tab ``General`` at the top, and then the ``Run`` button. We will now have to choose a name for the experiment (= ``slice name``) and choose a maximum duration. .. figure:: _static/images/5.7/jfed_5.7.0_run.png :width: 400 It will now take a couple of minutes to get the node prepared Login on a node of the experiment --------------------------------- When the node becomes green, we can right click on the node, and click ``Open SSH terminal``. .. figure:: _static/images/5.7/jfed_5.7.0_openterminal.png :width: 400 And then you should be automatically logged in. If the node says ``Key refused`` or another error it means something has gone wrong. See :ref:`connectivity`. Ending the experiment --------------------- To release your resources before the end time of your experiment, you can click the ``Terminate`` button at the top in jFed. After that the nodes will become black and if your ssh connection is still open, you can see that the node will be shutdown. .. figure:: _static/images/5.7/jfed_5.7.0_terminated.png :width: 400 .. _connectivity: Note on connectivity -------------------- As in Europe public IPv4 addresses are scarce, we have the following problems for getting connected to the nodes: * Testbeds as Virtual Wall or w-iLab.t are only accessible through IPv6 * Some testbeds have only a limited number of public IPv4 addresses, which is minimal in relation to the number of virtual machines they run. * Other testbeds assign only private IPv4 address to their nodes, and access is possible through a gateway node (with a single public IPv4 address). We are currently working around this in several ways. For the scenario in this tutorial, this is how it works: * The default node that was selected is at the Virtual Wall testbed (which is only accessible through IPv6). * If you have IPv6 all will be okay and you will be able to login on the node. * If you don't have IPv6, go to jFed preferences. Click ``Run Proxy Test`` at the bottom right, and then click ``Always`` next to ``Proxy for SSH connections`` followed by ``Save``. You can now right click the node to login through SSH and you will be proxied through an IPv4 server. * Alternatively, if you don't have IPv6, you can register for an IPv6 address and tunnel, e.g. at `Sixxs `_ (choose AYIYA tunnel) and install `Aiccu `_. .. * Instead of a Generic node, you can draw a Virtual Machine on your canvas, and you can choose a Planetlab Europe node or a BonFIRE Virtual Machine with a public IPv4 address. for BonFIRE, you need an additional account (see :ref:`bonfire`). Test connectivity ----------------- You can test your connectivity with jFed by clicking the small `globe` button on the bottom. And you will see a connectivity report: .. figure:: _static/images/5.7/jfed_5.7.0_connectivity_tester.png :width: 400 Feedback and Bug reports in jFed -------------------------------- In case you cannot get a green node on your canvas (e.g. at the bottom of jFed you see problems passing by), click the ``Feedback / Bugreport`` button in jFed and fill in a bug report. This will send all relevant information on calls and connectivity to jFed staff, so they can investigate the problem and report back to you. The reporter email address is standard filled in with your certificate email address and this is forwarded by the authority to your own email address. You don't have to change this, but you can if you like. Besides bug reports, you can also send question, feature requests, ... .. figure:: _static/images/5.7/jfed_5.7.0_bugreport.png :width: 400