Changes between Version 5 and Version 6 of Documentation/Howto/SetupHiveSlave


Ignore:
Timestamp:
10/20/15 13:47:13 (7 years ago)
Author:
ascheibe
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/Howto/SetupHiveSlave

    v5 v6  
    22
    33HeuristicLab Hive is a distributed computing software that follows the master - slave model: The master (or server) holds the jobs that should be calculated and is responsible for scheduling these. The slaves (or clients) are computers that poll the server for these jobs: they fetch them, run them and send the results back.
    4 The HeuristicLab Hive Slave is a modular application that is compromised of the core application logic and some views for visualization. These parts can be run in different ways and combinations:
     4The HeuristicLab Hive Slave is a modular application that is comprised of the core application logic and UIs. These parts can be run in different ways and combinations:
    55* Console client with text output
    66* HeuristicLab app with visualization
    77* Windows service with optional tray icon
    88
    9 The following gives an overview:
    109
    1110== Console client ==
     
    1918If you compile the `HeuristicLab.Clients.Hive.Slave.App-3.3` project, you get a new icon ''Hive Slave'' in the HL starter:
    2019\\ [[Image(starter.png)]] \\
    21 When starting this application, the hive slave is startet together with an UI that shows some statistics and a log window. This again does not need any special privileges to run.
     20When starting this application, the hive slave is started together with an UI that shows some statistics and a log window. This again does not need any special privileges to run.
    2221
    2322
     
    2928=== HeuristicLab.Clients.Hive.Slave.WindowsService ===
    3029This needs to be compiled to get the binaries for the Hive Slave Windows service. After doing that, an installer can be generated that installs the slave and registers it as a windows service on the client computer. The installer is created with the NSIS (Nullsoft Scriptable Install System). Download and install NSIS from http://nsis.sourceforge.net/. The installer scripts are located in the `Installers` directory in the source tree. Right-click on the file `HiveSlaveInstaller.nsi` and select ''Compile NSIS Script''. If everything works, you get, in the same directory, a file called ''HeuristicLab Hive Slave Installer.exe''. You can now copy and install this file on your clients. Please note that you have to compile the HeuristicLab Slave Windows Services solution before as the installer just takes the binaries and creates the installer out of them. You can open *.nsi files with a text editor to see what's actually happening. You can also find there at the beginning of the file that BUILDCONFIGURATION is set to Debug. If you want to package Release binaries change this in the nsi file and rebuild the solution using Release mode.
    31 When installed, the service runs in the background and connects to the Hive server, from which it fetches jobs and calculates them. If you don't want the slave to always calculate jobs, you can install the Slave Tray Icon where you can control the behavior of the service. Or you can use the Hive Administrator to define times when slaves or groups of slaves are not allowed to calculate jobs.
     30When installed, the service runs in the background and connects to the Hive server, from which it fetches jobs and calculates them. If you don't want the slave to always calculate jobs, you can install the Slave tray icon where you can control the behavior of the service. Or you can use the Hive Administrator to define times when slaves or groups of slaves are not allowed to calculate jobs.
    3231Please note that you need local administration privileges on your computer to execute the installer.
    3332\\ [[Image(installer.png)]] \\
     
    3938
    4039=== HeuristicLab.Clients.Hive.Slave.TrayIcon ===
    41 This is an application which sits in the Windows taskbar and shows you information about your locally installed slave. Besides the information it shows, you can use the Tray Icon to pause or stop the Slave service.
     40This is an application which sits in the Windows taskbar and shows you information about your locally installed slave. Besides the information it shows, you can use the tray icon to pause or stop the Slave service.
    4241[[BR]]
    4342
    4443\\ [[Image(trayicon.png)]] \\
    4544
    46 The Slave Tray Icon application shows on the first page an overview of the slave.
     45The Slave tray icon application shows on the first page an overview of the slave.
    4746The Kill button lets you stop the Windows service. If you are not logged in as administrator, UAC asks you to confirm this operation and the tray icon restarts with administration privileges. You may notice that the icon on the kill button changed and if you click it now, the service is stopped.
    4847The Stop button can be used to pause the Slave. This means that the slave is still connected to the Hive, but the server doesn't send new jobs to the slave.