Installation

This document describes how to install the Sawmill software package for versions 8.5+. This software is the main component of the Report Service for the PDS 2010 system. The following topics can be found in this document:

System Requirements

This software will be installed with its own standalone web server, so there is no additional installations required. However, there are some general memory, CPU, and disk space requirements outlined in the Sawmill documentation.

Initial Setup

This installation assumes /report_service is a mounted drive containing the configuration and node logs. A few directories and symbolic links are then assumed to be setup on the machine with pds as the owner:

% # Create report directory
% mkdir /usr/local/report
%
% # Create symbolic link to logs
% ln -s /report_service/logs /usr/local/report/logs
%
% # Create symbolic links to config
% ln -s /report_service/LogAnalysisInfo /usr/local/report/LogAnalysisInfo
%
% # Create symbolic link to old configurations
% ln -s /report_service/old_config /usr/local/report/old_config
%
% # Create directory for run logs
% mkdir /usr/local/report/sawmill_logs
      

Software Installation

Download Software

This section details how to download the software package from the Sawmill web site.

  1. Go to http://www.sawmill.net/downloads.html.
  2. Select the Proceed button (the form fields are optional).
  3. Select the desired version from the drop-down box, and select the Proceed button (latest and greatest preferred).
  4. Select the appropriate operating system for the host machine, and select the Proceed button.
  5. Select the appropriate hardware for the host machine, and select the Proceed button.
  6. The download will begin automatically.
  7. Verify that the Operating System and Hardware Architecture noted at the top of the page match that of the host machine.

Web Server Mode Installation

This section details the web server mode installation where Sawmill runs on its own standalone web server.

Machine NamePurpose
pdsrpt1operations
pdsrpt2operations

Note: The following procedure needs to be completed for pdsrpt1 only. The instructions will explicitly denote instructions for upgrading pdsrpt2.

  1. Log onto pdsrpt1.
  2. Change to pds user:
    % sudo su pds
    	    
  3. Place the Sawmill tar in the /home/pds directory
  4. Navigate to /home/pds and enter the following command from the command line:
    % gunzip -c (sawmill.tar.gz) | tar xf -
                

    A directory called sawmill is created containing the software and configuration.

  5. Move the directory to a more version-specific location so it is maintained:
    % mv sawmill sawmill8.6.3.1
    	    
  6. Create a symbolic link to the current installation:

    % ln -s /home/pds/sawmill8.6.3.1 /usr/local/report/sawmill
    	    
  7. Run install-sawmill to remove the Sawmill default configurations and checkout the PDS Engineering-specific configurations from the repository.

    % # Usage: install-sawmill <new-LogAnalysisInfo>
    % #  - <new-LogAnalysisInfo> - the LogAnalysisInfo directory within the new installation
    % 
    % ./install-sawmill /usr/local/report/sawmill/LogAnalysisInfo
    	    
  8. To run Sawmill, execute the following commands:
    % cd /usr/local/report/sawmill
    % nohup ./sawmill -ws t -v e > /usr/local/report/sawmill_logs/<current_date_in_YYYYMMDD_formate>.log 2>&1&
                

    Note: This command works in Bash shell. Modify accordingly for other shells.

  9. Update $APACHE_HOME/conf/httpd.conf as follows in order to redirect the URL to the Sawmill installation:
    ProxyPass / http://localhost.jpl.nasa.gov:8988/
    ProxyPassReverse / http://localhost.jpl.nasa.gov:8988/
    
    ProxyPass /picts/ http://localhost.jpl.nasa.gov:8988/picts/
    ProxyPassReverse /picts/ http://localhost.jpl.nasa.gov:8988/picts/
    	    
  10. Log onto pdsrpt2
  11. Complete steps 1-6 from above on pdsrpt2
  12. Perform the following in the bash shell:

    % rm -fr /usr/local/report/sawmill/LogAnalysisInfo
    % ln -s /usr/local/report/LogAnalysisInfo /usr/local/report/sawmill/LogAnalysisInfo
                

    Note: Modify directories as needed to reflect actual installation directories.

  13. Complete step 7 and 8 from above on pdsrpt2.
  14. Restart Apache.
  15. Open a web browser and go to http://<machine-name>/ to open Sawmill.
  16. Verify you can login using your PDS username and password.