Steps for downloading and installing Oracle Solaris Preflight Application Checker v11.0.1

This document contains instructions to download, install/configure and run the “Oracle Solaris Preflight Application Checker“ (version 11.0.1).

To install the Oracle Solaris Preflight Application Checker on an x86 or SPARC system running Oracle Solaris 10, please follow the step-by-step instructions given below

1. Create a directory for the Oracle Solaris Preflight Checker Tool

# mkdir /export/home/preflightcheck/demo

2. Download the Solaris Preflight Checker Tool installable from Solaris Preflight Checker Download Page

For SPARC systems download PreflightCheckerTool-v11-0-1-SPARC.zip

or

For X86 systems download PreflightCheckerTool-v11-0-1-X86.zip

3. Unzip the installable in the new directory

# unzip PreflightCheckerTool-v11-0-1-SPARC.zip

or

# unzip PreflightCheckerTool-v11-0-1-X86.zip

4. Run the setup script, and provide the required inputs. The following example shows the data needed to check Apache.

# cd /export/home/preflightcheck/demo/scripts

# chmod +x setup.sh

# ./setup.sh

Enter Application Name (Required) :

Apache Web Server

Application Version (Required) :

2.0

Enter Application Vendor (ISV) Name (Required) :

Apache

Does the application use a database? (yes or no) :

no

Does the application uses web server or application servers? (yes or no) :

no

Do you intend to check application binaries for potential issues? (yes or no) :

yes

Enter the top level folder(s) containing the installed application

( Use comma to separate multiple folders ) :

/usr/apache2,/etc/apache2,/var/apache2

Do you intend to check application sources for potential issues? (yes or no) :

yes

Enter the folder(s) containing application sources

( Use comma to separate multiple folders ) :

/export/home/sourcecode/httpd-src/httpd

Runtime Library Path (LD_LIBRARY_PATH) used by the application

(Use ':' to separate multiple paths. Press <return> if none is used) : <return>

Runtime Path (PATH) used by the application

(Use ':' to separate multiple paths. Press <return> if none is used.) : <return>

Do you intend to check Solaris 10 Application processes for potential issues? (yes or no) :

yes

Enter the path of the folder where the Oracle Solaris Preflight Application Checker reports are to be stored.

[Press <return> to use the default path: /export/home/preflightcheck/demo/reports] :

<return>

Oracle Solaris Preflight Application Checker Tool Installed Successfully

Run /export/home/preflightcheck/demo/bin/preflightcheckerGUI.sh or

preflightchecker.sh to start tests.

5. Here is the sample run output, when the “Oracle Solaris Preflight Application Checker” is used for doing binary scan (using “default values” for all the parameters)

demo@toolcvs :~/demo/bin# ./preflightchecker.sh -b

==========================================;

Preflight checker will run with following parameters :

Application Details -

Application Name :Apache

Application Vendor :Apache

>Application Version :2.0

LD_LIBRARY_PATH =>

PATH =>

Binary scan details -

Preflight checker will scan binaries in the following directories :

/usr/apache2

Output Details -

The logs are available at /export/home/preflightcheck/demo/logs/S11preflightcheckTool-16-59-09_24-01-2011.log

Preflight check run report (XML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightcheckReport-16-59-14_24-01-2011.xml

Preflight check run report (HTML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightcheckReport-16-59-14_24-01-2011.html

==========================================;

Do you want to proceed? [y/n] y

S11preflightcheck run started at 16-59-14_24-01-2011

Compatibility issues were found in the run.

Please go through the report /export/home/preflightcheck/demo/reports/S11preflightcheckReport-16-59-14_24-01-2011.html for more details.

demo@toolcvs :~/demo/bin#

6. Run the Oracle Solaris Preflight Application Checker on the application binaries

For example, the following commands will run the binary scan on Apache binaries, specified during installation.

# cd /export/home/preflightcheck/demo/bin

# ./preflightchecker.sh –h (will provide all the command line options available with the tool)

To run binary scan, run the command:

# ./preflightchecker.sh -b

This example will run the scan on Staroffice 8.

# cd /export/home/preflightcheck/demo/bin

#./preflightchecker.sh -b /opt/staroffice8

7. Run the Oracle Solaris Preflight Application Checker: to do the runtime analyses of the currently running processes on solaris 10

Prerequisites for using Oracle Solaris Preflight Application Checker Runtime analysis:

Privileges: The user running the PreflightChecker Tool's runtime analysis module must

have following oracle solaris privileges

- basic

- dtrace_user

- dtrace_proc

- dtrace_kernel

To set these privileges: Please login as root and run the below mentioned script

/export/home/preflightcheck/demo/scripts/setPriv.sh <username>

Kernel Parameters: Following kernel parameters must be updated before using runtime analysis module

1. Add following line in /etc/system file
set dtrace:dtrace_dof_maxsize=0x800000

2. Add following line in /kernel/drv/fasttrap.conf
fasttrap-max-probes=2500000;
fasttrap-hash-size=65535;

(Please Note: system needs to be rebooted after setting the above kernel parameters)

# cd /export/home/preflightcheck/demo/bin

# ./preflightchecker.sh –h (will provide all the command line options available with the tool)

For example, the following commands will do the runtime analyses of all the non system

process run by user oracle

# ./preflightchecker.sh -t -user oracle

This example will do the runtime analysis for all the non system process running under zone1

# cd /export/home/preflightcheck/demo/bin

#./preflightchecker.sh -t -zone zone1

8. The following example, will run the Oracle Solaris Preflight Application Checker GUI.

# export DISPLAY=<My Display>:0.0

# cd /export/home/preflightcheck/demo/bin

# ./preflightcheckerGUI.sh

View the generated HTML reports.

9. The log files are created at /export/home/preflightcheck/demo/logs folder.

By default the logging level is set to "INFO". More detailed logs can be generated by

changing the log level to "DEBUG". To use the DEBUG logging level, edit the

compat.logging.level property declaration in the file

/export/home/preflightcheck/demo/conf/CompatConfig.properties to be

“compat.logging.level=DEBUG”.

10. The “Oracle Solaris Preflight Application Checker” now also bundles “Oracle Solaris Preflight Kernel Checker “.

Here is the sample run output, when the “Oracle Solaris Preflight Kernel Checker” is used for doing binary scan on the kernel modules.

# cd /export/home/preflightcheck/demo/bin

#./kernelchecker.sh –h (will provide all the command line options available with the tool)

demo@toolcvs :~/demo/bin# ./kernelchecker.sh -b /usr/drv/

==========================================;

Preflight checker will run with following parameters :

Application Details –

Application Name : my_device_drivers

Application Vendor :IHV

Application Version :2.0>

Binary scan details -

PreFlightChecker will scan binaries in the following directories :

/usr/drv/

Output Details -

The logs are available at /export/home/preflightcheck/demo/logs/S11preflightkernelcheckTool-17-00-01_30-04-2012.log

Preflight check run report (XML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-17-00-01_30-04-2012.xml

Preflight check run report (HTML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-17-00-01_30-04-2012.html

==========================================;

Do you want to proceed? [y/n] y

S11preflightkernelcheck run started at 17-00-01_30-04-2012

Compatibility issues were found in the run.

Please go through the report /export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-17-00-01_30-04-2012.html for more details.

demo@toolcvs :~/demo/bin#

11. Here is the sample run output, when the “Oracle Solaris Preflight Kernel Checker” is used for doing srouce code scan on

C/C++ source code of kernel / driver modules.

# cd /export/home/preflightcheck/demo/bin

#./kernelchecker.sh –h (will provide all the command line options available with the tool)

demo@toolcvs :~/demo/bin# ./kernelchecker.sh -i /usr/drv_source_code/ -m SOLARIS=True,_REENTRANT=True

==========================================;

Preflight checker will run with following parameters :

Application Details –

Application Name : my_device_drivers

Application Vendor :IHV

Application Version :2.0

Source scan details -

PreflightChecker will scan source code in the following directories :

/usr/drv_source_code/

Output Details -

The logs are available at /export/home/preflightcheck/demo/logs/S11preflightkernelcheckTool-20-00-03_30-04-2012.log

Preflight check run report (XML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-20-00-03_30-04-2012.xml

Preflight check run report (HTML format) will be available at :

/export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-20-00-03_30-04-2012.html

==========================================;

Do you want to proceed? [y/n] y

S11preflightkernelcheck run started at 20-00-03_30-04-2012

Compatibility issues were found in the run.

Please go through the report /export/home/preflightcheck/demo/reports/S11preflightkernelcheckReport-20-00-03_30-04-2012.html for more details.

demo@toolcvs :~/demo/bin#

12. Please report any issues or make any suggestions to : isvsupport_ww@oracle.com