You are here: 1.0 Administrative Topics > Installing Moab Viewpoint

1.1 Installing Moab Viewpoint

This section explains how to install Moab Viewpoint 6.1. The following is a brief outline of the contents:

1.1.1 Compatibility

For the best experience, use only components from the following list:

1.1.2 Before Installing

A few steps are required before the automated installation can take place:

  1. Create the Viewpoint Home directory "/opt/viewpoint" and give the Tomcat user read/write privileges to the directory.

    2. As an example, you could run the following commands:

    mkdir /opt/viewpoint
chown tomcat6:tomcat6 /opt/viewpoint
    Note This is necessary if you are using the package-manager version of Tomcat. "tomcat6" is the standard user for Tomcat 6.0. You should use the same owner as "/var/lib/tomcat" chown tomcat6:tomcat6 /opt/viewpoint.

    By default, the Viewpoint configuration files are written to "/opt/viewpoint". To override the default configuration location, define the environment variable VIEWPOINT_HOME with a path such as /home/name/viewpoint. The Viewpoint home directory must be empty in order for the installation to occur correctly. Even hidden files will cause the installation to fail.

  2. Create the Viewpoint database and give the Viewpoint user full access to that database.

    3. The following example uses MySQL. For information on creating databases and granting access with other database vendors, consult the documentation for that vendor. 
    adaptive@viewpointMoab Viewpoint:~$ mysql -uadmin -p
Enter password:
mysql> CREATE DATABASE viewpoint;
Query OK, 1 row affected (0.08 sec)
mysql> GRANT ALL ON viewpoint.* TO viewpoint@localhost IDENTIFIED BY 'p@ssw0rd';
Query OK, 0 rows affected (0.31 sec)
mysql> GRANT ALL ON viewpoint.* TO [email protected] IDENTIFIED BY 'p@ssw0rd';
Query OK, 0 rows affected (0.31 sec)

    Verify that it ran correctly using a query such as mysql -u viewpoint -p viewpoint.
  3. Moab 6.0 needs to be running with a Viewpoint user configured as a level 1 administrator and proxy enabled. If Moab and Viewpoint are running on the same machine, that user needs to be named "tomcat6" or be the Tomcat user on your system.

    4. For example, the following addition to the Moab.cfg file would be correct if "tomcat6" is the Viewpoint user: 
    ADMINCFG[1] USERS=root,tomcat6
ADMINCFG[1] ENABLEPROXY=TRUE

    For more information, see ADMINCFG in Appendix F: Scheduler Parameters in the Moab Workload Manager documentation.

  4. Copy Moab.war and reporting.war to the Tomcat /webapps directory and restart the Tomcat server.
    NoteReporting is an optional feature. If you do not want to use the reporting feature, do not copy the reporting.war file as it runs as a service and increases Viewpoint's memory footprint.

In order to avoid potential java.lang.OutOfMemoryError issues, if you're going to use the reporting feature, or if you are going to view high volumes of jobs (around 10,000), you should increase Tomcat's memory. Add the following configuration setting to your other JAVA_OPTS settings in your Tomcat init script:

JAVA_OPTS="$JAVA_OPTS -XX:MaxPermSize=256m"

Note If you are using MySQL, you must download the MySQL database connection library, untar it, and copy the mysql-connector-java-x.x.x-bin.jar file to Tomcat's lib directory (normally $Catalina-Home/lib; for example, /usr/share/tomcat6/lib).

1.1.3 Starting the Installer

When all the prerequisites have been met, you can start the Viewpoint installer by visiting this URL ([hostname] is the hostname of the Tomcat server):

The initial screen requests your Moab suite and the type of connection Viewpoint has to the Moab server. Viewpoint can communicate with the Moab server in one of three ways:

Fill out the form and click Next to test the Moab connection. Clicking Next loads the Database Settings page only if the Moab connection test is successful.

1.1.4 Database Settings

Viewpoint supports connections to MySQL, SQL Server, PostgreSQL, and Oracle databases. See Configuring the Viewpoint Database for more information.

Fill out the form and click Next to test the database connection. Clicking Next loads the Security page only if the database connection test is successful.

1.1.5 Security

On the Security page you can choose how to authenticate Viewpoint users. You can use Viewpoint Login security, LDAP, or Single sign-on (SSO).

1.1.5.1 Viewpoint Login

Selecting Viewpoint Login at the Security screen will store usernames and passwords in the Viewpoint database. The next page will ask you to specify a password for the Viewpoint administrator. This is the simplest way to authenticate because it doesn't require external configuration.

1.1.5.2 LDAP

Selecting LDAP at the Security screen allows you to authorize LDAP users to perform actions in Viewpoint.

When the Viewpoint Role Mapping section is complete, the Security screen allows you to specify an LDAP server as your authentication mechanism. Your LDAP server may already contain authentication information you can use. If you need help understanding your set up, talk to your LDAP administrator. Common LDAP servers include Active Directory and OpenLDAP.

If a different security type is chosen, LDAP authentication can be configured manually by following the instructions given in the Integrating with LDAP/Active Directory documentation.

1.1.5.3 Single Sign-on (SSO)

Selecting SSO at the Security screen allows you to specify your SSO configuration. SSO allows multiple sites to be accessed with one login. Use SSO if you want to use the same login name and password that are already used for other sites. An external SSO solution must be installed in order to use this functionality.

1.1.6 Summary

The Summary page provides a review of the settings you've entered throughout the installer. You can now click Install which:

If these actions are successful, a message instructs you to restart Tomcat. After Tomcat is restarted, you can connect to Viewpoint at:

Note Viewpoint logs are written to /tmp/viewpoint.log if the logging configuration can't be parsed.

1.1.7 Troubleshooting

  1. If the message "Not Installing Viewpoint..." appears when you are trying to install Viewpoint, one of the following reasons may apply:
    1. To successfully install, the $VIEWPOINT_HOME directory must be empty. If it isn't empty, move or remove all files and directories, including hidden files, from that directory.
    2. The WEB-INF/.install directory must exist and may be missing. It originates from the Moab.war file and contains pre-installed configuration files.
    3. For debugging purposes only, a "debug.properties" file may be improperly configured. If it exists, it resides in the $VIEWPOINT_HOME directory.
  2. If a database installation fails because of MySQLSyntaxErrorException: Unknown database 'viewpoint' manually create a database called "viewpoint".
To increase Viewpoint's performance, see Enhancing Performance.

1.1.8 Upgrading from Viewpoint 2.0 to 6.1

To upgrade to Viewpoint 6.1, you must add the EventFilter table and modify the existing AbstractPendingAction and VM tables in the Viewpoint database. The examples below demonstrate how to perform the upgrade for a MySQL database:

 

  1. Create the EventFilter table to store filters from the Events page.

    CREATE TABLE `EventFilter` (   `id` varchar(255) NOT NULL,   `name`
varchar(255) DEFAULT NULL,   `query` longtext,   `user` varchar(255)
DEFAULT NULL,   `viewState` longtext,   PRIMARY KEY (`id`) )
ENGINE=InnoDB DEFAULT CHARSET=latin1;

  2. Ensure that the failureDetails column of the AbstractPendingAction table can successfully store Moab pending action failure messages by increasing its capacity. 

    alter table AbstractPendingAction change column failureDetails failureDetails longtext;

  3. Add columns vcID and trackingJob to the VM table. 

    alter table VM add column vcId varchar(255);
    alter table VM add column trackingJob varchar(255);

NoteWhen you install Viewpoint 6.1 normally, Viewpoint will correctly configure the database. Only make the modifications above if you are upgrading from Viewpoint 2.0.