Skip to content

Funnel

Follow these instructions if you wish to deploy a TES endpoint in front of your HPC/HTC cluster (currently tested with Slurm and OpenPBS.

  • Make sure the build dependencies make and Go 1.21+ are installed, GOPATH is set and GOPATH/bin is added to PATH.

    For example, in Ubuntu this can be achieved via:

    sudo apt update
    sudo apt install make golang-go
    export GOPATH=/your/desired/path
    export PATH=$GOPATH/bin:$PATH
    go version
    
  • Clone the repository:

    git clone https://github.com/ohsu-comp-bio/funnel.git
    
  • Build Funnel:

    cd funnel
    make
    
  • Test the installation by starting the Funnel server with:

    funnel server run
    

If all works, Funnel should be ready for deployment on your HPC/HTC.

Alternatively, you can install Funnel via Homebrew:

brew tap ohsu-comp-bio/formula
brew install funnel@0.11

Source: Funnel website

Slurm

For the use of Funnel with Slurm, make sure the following conditions are met:

  1. The funnel binary must be placed in a server with access to Slurm.
  2. A config file must be created and placed on the same server. This file can be used as a starting point.
  3. If we would like to deploy Funnel as a Systemd service, this file can be used as a template. Set the correct paths to the funnel binary and config file.

If successful, Funnel should be listening on port 8080.

OpenPBS

Under construction

More info coming soon...