If you’ve set up your FireServer, this tutorial will help you to:
Like the previous tutorial, our purpose is to get you set up as quickly as possible; it isn’t intended to demonstrate the features of FireWorks or explain things in great detail. This tutorial can be safely completed from the command line, and requires no programming.
In the Introductory tutorial, we entered a FireWork (job) in the LaunchPad (database) on the FireServer (central server). We then launched a Rocket that fetched the FireWork from the database and executed it, all within the same machine.
A more interesting use case of FireWorks is to store FireWorks in the FireServer, but execute them on one or several outside ‘worker’ machine (FireWorkers). We’ll next configure a worker machine.
On the worker machine, follow the instructions listed at Basic FireWorks Installation.
Back at the FireServer, let’s reset our database and add a FireWork:
lpad reset
cd <INSTALL_DIR>/fw_tutorials/worker
lpad add fw_test.yaml
Make sure to keep the MongoDB running on the FireServer, and do not launch a Rocket yet!
The FireWorker needs to know the login information for the FireServer. On the FireWorker,
Navigate to the worker tutorial directory:
cd <INSTALL_DIR>/fw_tutorials/worker
where <INSTALL_DIR> is your FireWorks installation directory.
Modify the my_launchpad.yaml to contain the credentials of your FireServer. In particular, the host parameter must be changed to the IP address of your FireServer.
Tip
If you do not know the IP address of your FireServer and you are on a Linux machine, you can try running /sbin/ifconfig.
Note
The name my_launchpad.yaml is a special filename that contains your database credentials. By default, FireWorks checks for this file in the current directory. You can also specify its location manually using the -l parameter of lpad, or you can set up your configuration to set the location of this file once and for all.
Confirm that you can query the FireServer from your FireWorker:
lpad get_fws -i 1 -d all
This should print out the description of a FireWork that is READY to run.
Tip
If you cannot connect to the database from a remote worker, you might want to check your Firewall settings and ensure that port 27017 (the default Mongo port) is open/forwarded on the central server. For Macs, you might try the Port Map application to easily open ports. If you’re still having problems, you can use telnet to check if a port is open: telnet <HOSTNAME> <PORTNAME>, where <HOSTNAME> is your FireServer hostname and <PORTNAME> is your Mongo port (probably 27017).
The FireWorker file contains information about this worker’s configuration. Staying in the worker tutorial directory on the FireWorker, modify your my_fworker.yaml by changing the name parameter to something that will help you identify the worker that ran your FireWork later on. For example, you might want to use the hostname of the worker machine.
Note
The name my_fworker.yaml is a special filename that contains your FireWorker’s credentials. By default, FireWorks checks for this file in the current directory. You can also specify its location manually using the -w parameter of lpad, or you can set up your configuration to set the location of this file once and for all.
Staying in the worker tutorial directory on your FireWorker, type:
rlaunch singleshot
This should successfully launch a rocket that finds and runs your FireWork from the central server.
Tip
Remember that we are getting database and FireWorker credentials automatically from my_launchpad.yaml and my_fworker.yaml.
Confirm that the FireWork was run:
lpad get_fws -i 1 -d all
You should notice that the FireWork is listed as being COMPLETED. In addition, the name parameter under the launches.fworker field should match the name that you gave to your FireWorker in my_fworker.yaml. If you have multiple FireWorkers, this can help you identify where your job ran later on.
Just like on the central server, you can run in rapidfire mode on the FireWorker to process many jobs.
Staying in the worker tutorial directory on your FireWorker, clean up your directory:
rm FW.json howdy.txt
Add three more FireWorks. Let’s do this from the FireWorker this time instead of the FireServer:
lpad add fw_test.yaml
lpad add fw_test.yaml
lpad add fw_test.yaml
Run Rockets in rapidfire mode:
rlaunch rapidfire
You’ve now run multiple jobs on your FireWorker! You could even try running the Rocket Launcher in --nlaunches infinite mode - then, you would have FireWorker that continuously ran new jobs added to the LaunchPad on the FireServer.
A central FireServer and one or more FireWorkers pulling jobs in rapidfire mode might be all that you need to automate your application. However, if your FireWorker is a shared resource you might want to run jobs through an external queuing system rather than directly run rlaunch on your FireWorker. A description of how to run through a queue is given here: Launching Rockets through a queue. Or, you might return to the home page and pursue a different tutorial.