Differences between revisions 39 and 40
Revision 39 as of 2013-09-03 15:42:26
Size: 15272
Comment: Fixing directory structure.
Revision 40 as of 2013-09-03 19:27:18
Size: 15822
Comment: Added description of version.xml file.
Deletions are marked like this. Additions are marked like this.
Line 242: Line 242:
Update the boinc database,
== Tell the database about the files ==

Sometimes, with multiple files representing binaries for a computation, it gets all a bit complicated. The file version.xml helps out:{{{
if [ -z "$appver" -o -z "$boincplat" ]; then
else
cat<<EOVERSIONXML | sudo tee apps/upper_case/$appver/$boincplat/version.xml
cat version.xml
<version>
  <file>
      <physical_name>upper_case_7.042_x86_64-pc-linux-gnu</physical_name>
      <main_program/>
  </file>
</version>
EOVERSIONXML
fi
}}}
The version.xml file is described in detail on http://boinc.berkeley.edu/trac/wiki/AppVersionNew .

Then update the boinc database,
Line 251: Line 270:
moeller@twin1a:/var/tmp/boinc-server-test/boinctest $ sudo ./bin/update_versions $ sudo ./bin/update_versions

This page explains how to configure the BOINC server side to support and distribute a particular set of applications to its volunteers.

1. How to add a scientific application to a BOINC server

The BOINC project managers need to provide all the binaries for all the supported platforms. This is of some difficulty especially for those platforms that one does not own oneself. This page's first half demonstrates the workflow using xadd for a single platform, i.e. the one we can work with locally. The second half of this page is dedicated to employing the binaries Debian provides for the purpose. Debian supports many platforms, and we just reply on Debian's infrastructure to have built those correctly without our intervention.

With BOINC's wrapper application, every regular command line execution can be run by BOINC. One just needs to distribute the wrapper together with the application. A separate page describes how to substitute the BOINC-prepared example application described here with a triplet of the BOINC-prepared Wrapper application, a description on the invocation and the binary to run. And again, while input data and the invocation are platform agnostic, the platform-dependent applications and specialised libraries can be taken from Debian. This holds for all BOINC projects, not just for those that use the Debian boinc-server-maker package to get started.

1.1. Add a single example app for a single architecture to the BOINC project

The process is as follows. Within the project folder we have all binaries for all platforms for a particular application together. What we have we write into a file named "project.xml". Once done, we invoke the tool "xadd" from the project's bin folder. Once done, the BOINC server is ready to accept workunits for that application.

1.1.1. Get binary of local platform

Install the example application package with the distribution's regular apt-get tool:

$ sudo apt-get install boinc-app-examples

The example application used in the document is upper_case, which converts text inside a file to all capitals. To verify that the package just installed truly shows that binary, it may just have been renamed, use regular Debian command line tools:

$ dpkg -L boinc-app-examples | grep upper_case
/usr/lib/boinc-server/apps/upper_case

1.1.2. Create a directory and add the app to project configuration.

This directory becomes an intrinsic part of your project. It needs to reside in a subdirectory of what is accessible through your project's website. After all, it is that website that is contacted by the BOINC clients.

[ -z "$installroot" -o -z "$projectname" ] && . ~/.boinc_test.conf
if  test -z "$installroot" -o -z "$projectname"; then
   echo "E: ~/.boinc_test.conf does not have all parameters."
else 
   appdir="$installroot"/"$projectname"/apps/upper_case
   echo "I: The application directory is '$appdir'."
   sudo mkdir -p "$appdir"
fi

We now copy the file from the above installed "boinc-app-examples" Debian package into that directory and rename it to distinguish versions and architectures. The naming obeys a particular theme that BOINC expects. In our case, the app_ver variable is that of the BOINC server, the second part of the filename is that of the BOINC architecture. The code below executes the tool 'arch' of the coreutils package to learn about the UNIX platform. The BOINC platforms commonly directly derive from them. The $( .. ) is equivalent to the backticks `  ` that may be more familiar. And when substituting a variable within a larger string, the variable name is enclosed in curly brackets ${...} .

appver=7.042 # adjust to the right version, only have single "."
boincplat=$(arch)-pc-linux-gnu # adjust to your architecture, maybe i686-pc-linux-gnu
binary=$(dpkg -L boinc-app-examples | grep upper_case)
echo "I: Application version: $appver"
echo "I: BOINC platform: $boincplat"
echo "I: binary at: $binary"
if test -z "$appdir" -o -z "$appver" -o -z "$boincplat" -o -z "$binary"; then
   echo "E: Lost onee of the variables appdir, appver, binary or boincplat - please check and try again"
else
   completepath=$appdir/$appver/$boincplat && \
   sudo mkdir -p $completepath && \
   sudo cp $binary $completepath/upper_case_${appver}_${boincplat} && \
   echo "[ok]"
fi

Upstream lists official BOINC architectures here. The hierarchy of directories looks like an overkill at a first sight. But over time, BOINC projects have become increasingly complex and more often than not, one wants to add more than a single binary. And that team of binaries and data files may have version dependencies among themselves.

The official description of that format is on the BOINC wiki for AppVersionNew - just slighty hidden.

1.2. Optional and outdated: Use the Debian-provided script to install binaries for multiple platforms

Some volunteer please bring the script up to speed for the new hieararchical directory structure as explained above. Until that is done, please bear with us and prepare those platform directories manually.

When applications do not have dependencies on non-standard dynamically loaded libraries (test with the tool 'ldd'), then one can use the regular binary from Debian. This should then be functional also for non-Debian/Ubuntu platforms. The boinc-server-maker package provides a shell script that downloads the Debian packages of a given name (the default is the boinc-app-examples package) and unpacks, organizes and signs the binaries readily to be redistributed by the BOINC server.

  1. Obtain the script from /usr/share/doc/boinc-server-maker/examples/fetch_example_applications.sh

    $ mkdir ~/fetch-app && cd ~/fetch-app 
    $ zcat  /usr/share/doc/boinc-server-maker/examples/fetch_example_applications.sh.gz > fetch_example_applications.sh
  2. Edit the script's source to set $projectroot, and run.

The application will now be downloaded, and the directory structure will look somewhat like this. The .sig files may already have been added by the fetch_example_applications.sh tool, if your environment variables suggest an active project. But that is optional.

$ tree ~/fetch-app/apps
 
apps/
|-- 1sec
|   |-- 1sec_6.12_armel-linux-gnu
|   |-- 1sec_6.12_armel-linux-gnu.sig
|   |-- 1sec_6.12_i686-pc-linux-gnu
|   |-- 1sec_6.12_i686-pc-linux-gnu.sig
|   |-- 1sec_6.12_ia64-linux-gnu
|   |-- 1sec_6.12_ia64-linux-gnu.sig
|   |-- 1sec_6.12_mips-linux-gnu
|   |-- 1sec_6.12_mips-linux-gnu.sig
|   |-- 1sec_6.12_s390-linux-gnu
|   |-- 1sec_6.12_s390-linux-gnu.sig
|   |-- 1sec_6.12_sparc-linux-gnu
|   |-- 1sec_6.12_sparc-linux-gnu.sig
|   |-- 1sec_6.12_x86_64-pc-linux-gnu
|   `-- 1sec_6.12_x86_64-pc-linux-gnu.sig
|-- concat
...
|-- upper_case
|   |-- upper_case_6.12_armel-linux-gnu
|   |-- upper_case_6.12_armel-linux-gnu.sig
.
.   [ i686, ia64, mips, s390, sparc not shown]
.
|   |-- upper_case_6.12_x86_64-pc-linux-gnu
|   `-- upper_case_6.12_x86_64-pc-linux-gnu.sig
|-- worker
...
`-- wrapper
    |-- wrapper_6.12_armel-linux-gnu
    |-- wrapper_6.12_armel-linux-gnu.sig
.
.   [ i686, ia64, mips, s390, sparc not shown]
.
    |-- wrapper_6.12_x86_64-pc-linux-gnu
    `-- wrapper_6.12_x86_64-pc-linux-gnu.sig

Not shown are the analogous entries for the example applications concat, uc2, sleeper and worker.

Copy the upper_case app to the project.

$ . ~/.boinc_test.conf && \
  cp ~/fetch-app/apps/upper_case/* $installroot/$fileprojectname/apps/upper_case/

The boinc_test.conf sets the variables $installroot etc. Start at BOINC/ServerGuide if your search engine had brought you here directly.

2. Inform local database of available binaries

2.1. Craft the project's project.xml file

The project.xml file informs the BOINC server about what this project is all about, i.e. what platforms we are supporting with what tools (apps). You can copy and paste the following BASH shell lines to your local console. It will create the file project.xml in the project's root directory or bail out if something goes the unexpected way.

[ -z "$installroot" -o -z "$projectname" ] || . ~/.boinc_test.conf
if [ -z "$installroot" -o -z "$projectname" ]; then
   echo 'Variables $installroot (' $installroot ') and $projectname (' $projectname ') are both required.'
elif [ -d "$installroot/$projectname" ]; then
   if [ -f "$installroot/$projectname"/project.xml ]; then
       sudo gzip -9 --suffix ".$(date +"%Y%m%dT%H%M").gz" "$installroot/$projectname"/project.xml
   fi
   (cat << EOPROJECTXML
<boinc>
 <app>
  <name>upper_case</name>
  <user_friendly_name>upperCASE</user_friendly_name>
 </app>
 <platform>
  <name>i686-pc-linux-gnu</name>
  <user_friendly_name>Linux/x86 32bit</user_friendly_name>
 </platform>
 <platform>
  <name>x86_64-pc-linux-gnu</name>
  <user_friendly_name>Linux/amd64 64bit</user_friendly_name>
 </platform>
</boinc>
EOPROJECTXML
) | sudo tee "$installroot"/"$projectname"/project.xml
fi

This file feed the xadd tool, which in turn feeds the project's MySQL database. The entries say that those applications should be prepared for to be eventually found. Thus, it is OK if only one of the 32 and 64 bit platforms are covered. Please look into standard platform names BOINC follows here to avoid confusion.

Now let us invoke xadd. Change to the $projectroot

cd "$installroot"/"$projectname"

and run initiate the addition of the binary found in the directory structure to the local database

sudo bin/xadd

The local screen output will be similar to

$ sudo bin/xadd
Processing <App#None upper_case> ...
  Committed <App#1 upper_case> ; values:
{'_dirty': False,
 '_lazy_lookups': {},
 'beta': 0,
 'create_time': 1357056725L,
 'deprecated': 0,
 'homogeneous_app_version': 0,
 'homogeneous_redundancy': 0,
 'host_scale_check': 0,
 'id': 1L,
 'locality_scheduling': 0L,
 'min_avg_pfc': 1.0,
 'min_version': 0L,
 'name': 'upper_case',
 'non_cpu_intensive': 0,
 'target_nresults': 0,
 'user_friendly_name': 'upperCASE',
 'weight': 1.0}
Processing <Platform#None i686-pc-linux-gnu> ...
  Committed <Platform#1 i686-pc-linux-gnu> ; values:
{'_dirty': False,
 '_lazy_lookups': {},
 'create_time': 1357056725L,
 'deprecated': 0,
 'id': 1L,
 'name': 'i686-pc-linux-gnu',
 'user_friendly_name': 'Linux/x86 32bit'}
Processing <Platform#None x86_64-pc-linux-gnu> ...
  Committed <Platform#2 x86_64-pc-linux-gnu> ; values:
{'_dirty': False,
 '_lazy_lookups': {},
 'create_time': 1357056725L,
 'deprecated': 0,
 'id': 2L,
 'name': 'x86_64-pc-linux-gnu',
 'user_friendly_name': 'Linux/amd64 64bit'}

This is the output of xadd parsing two platform specifications and a single application. More platforms with more applications make longer outputs. Also it should be noted that currently xadd has no provision to delete from databases. It always appends the entries to database, if you want to remove/change existing entries, you should do it manually. Please indicate any better solution or send us emails.

And when executing that line again, nothing happens since everything here is already inside database, :

# bin/xadd 
Processing <App#None upper_case> ...
  Skipped existing <App#None upper_case>

The file project.xml is not touched.

2.2. Sign the application binary

BOINC signs the application binaries for security reasons. This way, the volunteer's client may rest somewhat assured that the application's binary was not modified by someone with evil intentions, say, on the way from the project's server to the local machine.

privateKeyfile="./keys/code_sign_private"
if [ -z "$appver" -o -z "$boincplat" ]; then
   echo "Please set appver and boincplat variables from above."
elif [ ! -r "$privateKeyfile" ]; then
   echo 'Have your private key ready as created during setup, expected at $privateKeyfile .'
else 
   sudo ./bin/sign_executable apps/upper_case/$appver/$boincplat/upper_case_${appver}_${boincplat} "$privateKeyfile" | sudo tee apps/upper_case/$appver/$boincplat/upper_case_${appver}_${boincplat}.sig
fi

2.3. Tell the database about the files

Sometimes, with multiple files representing binaries for a computation, it gets all a bit complicated. The file version.xml helps out:

if [ -z "$appver" -o -z "$boincplat" ]; then
else
cat<<EOVERSIONXML | sudo tee apps/upper_case/$appver/$boincplat/version.xml
cat version.xml
<version>
  <file>
      <physical_name>upper_case_7.042_x86_64-pc-linux-gnu</physical_name>
      <main_program/>
  </file>
</version>
EOVERSIONXML
fi

The version.xml file is described in detail on http://boinc.berkeley.edu/trac/wiki/AppVersionNew .

Then update the boinc database,

sudo ./bin/update_versions

and prompt yes when asked for confirmation.

Sample output:

$ sudo ./bin/update_versions

Found application version: upper_case 7.042 x86_64-pc-linux-gnu
PHP Warning:  Creating default object from empty value in /var/tmp/boinc-server-test/boinctest/bin/update_versions on line 410
PHP Warning:  Creating default object from empty value in /var/tmp/boinc-server-test/boinctest/bin/update_versions on line 230
cp apps/upper_case/7.042/x86_64-pc-linux-gnu/upper_case_7.42_x86_64-pc-linux-gnu /var/tmp/boinc-server-test/boinctest/download/upper_case_7.42_x86_64-pc-linux-gnu
    Files:
        upper_case_7.42_x86_64-pc-linux-gnu (main program)
    Do you want to add this application version (y/n)? y
    Application version added successfully; ID=1

It should be noted that the app directory is just a staging area for the script to parse the structure and put the binaries to respective places, i.e. the "download" directory. After this, the app directory can be removed safely.

2.4. Inspection of the database (optional)

The database has now seen a single application

$ echo "select * from app" | mysql -u boincadm -p$pw $dbprojectname
Enter password: 
id      create_time     name    min_version     deprecated      user_friendly_name      homogeneous_redundancy  weight  beta    target_nresults min_avg_pfc     host_scale_check
1       1308465648      upper_case      0       0       upperCASE       0       1       0       0       1       0

on multiple platforms

$ echo "select * from platform;"| mysql -u boincadm -p$pw $dbprojectname
Enter password: 
id      create_time     name    user_friendly_name      deprecated
1       1308465648      i686-pc-linux-gnu       Linux running on an Intel x86-compatible CPU    0
2       1308465648      x86_64-pc-linux-gnu     Linux running on an AMD x86_64 or Intel EM64T CPU       0

When you have the leisure, don't shy away from inspecting the database more. Except for app, app_version and platform, all tables are empty at this stage. Straight forward to learn, a very basic tutorial on MySQL will do as a preparation ... if required at all.

3. References


Back to BOINC/ServerGuide