Moab Viewpoint
Home Up Previous Next
Installing Moab Viewpoint

Installing Moab Viewpoint

The following offers an explanation for how to install Moab Viewpoint 2.0.2. This page is composed of the following sections:

Compatibility

Viewpoint 2.0.2 is designed to work in concert with a number of other technologies. For the best experience, please use the following list of components with this version of Viewpoint:

  • Moab Workload Manager 6.0
  • Oracle Java SE 6.0
    • Note Viewpoint requires the Java Runtime Environment from Sun/Oracle version 6.0 or higher. Other implementations of the Java Runtime Environment, such as OpenJDK or GIJ, will not run on Viewpoint as expected.
  • Apache Tomcat 6.0
  • Database
    • MySQL 5.1
    • MS SQL Server 2008
    • Oracle 10g Express
    • PostgreSQL 8.0
  • Web Browser
    • Mozilla Firefox 3.0-3.6
    • Internet Explorer 7-8

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 /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@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 viewpoint@127.0.0.1 IDENTIFIED BY 'p@ssw0rd';
Query OK, 0 rows affected (0.31 sec)

    Note Verify that it ran correctly using a query such as mysql -u viewpoint 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 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.
    Note Reporting 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).

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):

  • http://[hostname]:8080/moab/install

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

  • Local - For use when Moab and Viewpoint exist on the same server.
    • Local Connection
    Click to enlarge

    SSH - Password - Selecting this connection type loads another form that allows you to specify the secure connection details.

    SSH Password Connection
    Click to enlarge

    SSH - Public Key - Selecting this connection type loads another form that allows you to specify the secure connection details.

    SSH Key Connection
    Click to enlarge

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.

Database Settings

Database Settings
Click to enlarge

Viewpoint supports connections to four different databases.

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.

Security

Viewpoint Security
Click to enlarge

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

Viewpoint Login

Viewpoint Login
Click to enlarge

Selecting Viewpoint Login at the Security screen allows you to specify a password for the Viewpoint administrator. This password is stored in the Viewpoint database.

LDAP

Viewpoint LDAP
Click to enlarge

Selecting LDAP at the Security screen allows you to specify an LDAP server as your authentication mechanism.

This only sets up the connection to the LDAP server, but does not allow the LDAP users to authenticate. To configure your LDAP users to authenticate to Viewpoint, you must configure the permissions map.

Single Sign-on (SSO)

SSO Security
Click to enlarge

Selecting SSO at the Security screen allows you to specify your SSO configuration.

Summary

Summary
Click to enlarge

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

  • writes configuration files to the $VIEWPOINT_HOME path.
  • initializes the database with the necessary tables.
  • creates the Viewpoint "admin" user and password and adds it to the database.

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

  • http://[hostname]:8080/moab
Note Viewpoint logs to /tmp/viewpoint.log if the logging configuration can't be parsed.

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".
Home Up Previous Next