Partek Flow Documentation

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section provides additional tools that may be useful for system administrators who maintain the Partek Flow server.

Verifying that Partek Flow is Running on the Server

At anytime, you wish to know the status of Partek Flow:
$ service partekflowd status
Possible outputs are RUNNING or STOPPED.

Changing the Temporary Folder Location

By default, temporary files resulting from genomic data uploads to Flow are stored in /opt/partek_flow/temp and are removed upon upload completion. If Flow is installed on a small root partition (<20GB), exceedingly large uploads may fill the root partition and necessitate moving this temporary directory to a larger partition. In order to select a new Flow temp folder, complete the following logged in as root:

  1. Shutdown Flow
    # service partekflowd stop

  2. For this example we will use the new temporary folder location of /home/flow/partek_flow/temp. Adjust this path to meet your needs.

  3. Open the configuration file /etc/partekflow.conf and append the following line to the end of the file:
    CATALINA_TMPDIR=/home/flow/partek_flow/temp

  4. Ensure the new temporary directory exists and is writeable by Flow. If you use a different Linux user account to run Flow, make sure this folder can be modified by this user.
    # mkdir -p /home/flow/partek_flow/temp
    # chown flow:flowuser /home/flow/partek_flow/temp

  5. Start Flow
    # service partekflowd start

Diagnosing and Reporting Installation Issues with flowstatus.sh

Partek Flow comes with a standalone diagnostic script that reports how Flow is installed and detects common installation problems. This script can be run independently of Flow as installation issues or crashes can prevent Partek Flow from starting. This utility gathers Flow log files and server information which, upon customer approval, will be sent to Partek so our support team has all requisite information to address the issue. Some examples of when this script should be run include:

...

Numbered figure captions
SubtitleTextTask details page of a failed task. Warning information section is optional, the content of the Error message section depends on the type of error. The Send logs to Partek button sends the log files to Partek Technical Support
AnchorNameFailed task details

Running flowstatus.sh via the command line

  1. Locate the Flow installation directory. This is defined as the FLOWhome variable in the file /etc/partekflow.conf.
    $ grep FLOWhome /etc/partekflowd.conf
    For this example, we assume the Flow install directory is /opt/partek_flow. Replace this with the directory found in step 1.

  2. Run the script
    $ bash /opt/partek_flow/flowstatus.sh
    After the script is run, a report will appear on the screen, then you will be asked if you wish to upload this report to Partek. If this report is uploaded, you will be contacted by support personnel who will assist with your issue. 

    If you are unable to find the flowstatus.sh script on your system or you want to run the most recent version of this script, then execute the following:
    $ wget https://customer.partek.com/flowstatus.sh
    $ bash flowstatus.sh

Interpreting flowstatus.sh reports

When running the flowstatus.sh script, you will see a report similar to Figure 8.

...

After displaying Partek Flow configuration information, several installation checks are performed. This covers common issues that can break a Partek Flow installation such as full disks or running Partek Flow under the wrong user account.

Converting a Zip Installation to Use the Package Manager

If you have used a .zip file to install a previous build of Partek Flow and you wish to convert your installation to a package manager, we recommend that you contact the Partek Licensing Support (licensing@partek.com) for assistance in this process. Briefly, we describe the conversion steps below.

  1. Log in to the existing Linux user account used to run Partek Flow. Next, stop the Partek Flow server.
    $ cd
    $ ~/partek_flow/stop_flow.sh

  2. Ensure Partek Flow is no longer running. If the output contains only "grep bin/flow" this requirement is met.
    $ ps aux | grep bin/flow

  3. If Partek Flow is running and repeating step 1 above does not shut down the Partek Flow server, then use the following command where PID is the process ID of Partek Flow. The PID is found from the output of step 2 above, column two
    $ kill -9 PID

  4. Backup the existing Partek Flow database and installation directories. Substitute the example paths below with those specific to the Partek Flow installation.
    $ cp -r ~/.partekflow ~/.partekflow_backup
    $ mv ~/partek_flow ~/partek_flow_backup

  5. Follow the Installation steps relevant to the Linux distribution on the Partek Flow server.

    For Debian/Ubuntu:
    Upon reaching Configure Partek Flow installation settings enter
    $ sudo dpkg-reconfigure partekflow

    For Redhat/Fedora/Centos:
    Edit the following file: /etc/partekflow.conf 

    These prompts set the existing Linux account name and home directory used to run the previous Partek Flow server installation. 

Transferring Partek Flow to a new machine

Contact your Account Manager or email licensing@partek.com to request for transfer and to obtain a new license.dat file based on the Host ID of your new machine. Follow the steps below to move the Partek Flow license and database:

On OLD MACHINE
  1. Shutdown existing Partek Flow installation:
    $ sudo service partekflowd stop

  2. Backup Partek Flow database:
    $ sudo su - flow
    $ tar cvfz partekflowdb.bkup.tgz /home/flow/.partekflow

  3. Copy partekflowdb.bkup.tgz to new machine

  4. Remove existing Partek Flow installation:
    Debian/Ubuntu:
    $ sudo apt-get remove partekflow partekflow-bin

    RedHat/Fedora/CentOS
    $ sudo yum remove partekflow partekflow-bin 
On NEW MACHINE
  1. Install Partek Flow as described earlier in this document.
    When prompted for license, paste the license generated for the new machine. 

  2. Shutdown Partek Flow to install previous database:
    $ sudo service partekflowd stop

  3. Unpack partekflowdb.bkup.tgz:
    $ sudo su - flow
    $ tar xvfoz partekflowdb.bkup.tgz
    $ exit

  4. Restart Partek Flow
    $ sudo service partekflowd start 

...