Sun N1 Grid Engine 6.1 Installation Guide

ProcedureHow to Install the Accounting and Reporting Console

  1. Change directory to sge-root/reporting.


    # cd sge-root/reporting
    
  2. Use the inst_reporting script to install the software.


    # ./inst_reporting
    
    Welcome to the  GE ARCo reporting module installation
    ----------------------------------------------------
    The installation will take approximately 5 minutes
    
    Hit <RETURN> to continue >> 

    The install script checks for the existence of the SGE_ROOT directory and SGE_CELL name. If you already created these parameters, the script continues.

  3. Enter the path to your Java Software Development Kit.

    Version 1.4.2 or higher is required. If your JAVA_HOME environment variable is set, the script will use that as a default value.


    Please enter the path to your Java 1.4 installation [] >> /opt/j2sdk1.4.2_06
    
  4. Specify the directory where the accounting and reporting software can store its results.

    If this directory does not exist, it will be created for you.


    Spool directory
    ---------------
    
    In the spool directory the N1 SGE reporting module will
    store all queries and results
    
    Please enter the path to the spool directory [/var/spool/arco] >> 
  5. Specify the parameters for the database connection.


    Database Setup
    --------------
    
    Enter your database type ( o = Oracle, p = PostgreSQL ) [p] >> o
    
    
    Please enter the name of your oracle db host [] >> my-host
    
    Please enter the port of your oracle db [1521] >> 
    
    Please enter the name of your oracle database [arco] >> 
  6. Specify an accounting and reporting database user.

    Do not use the same database user as you did for the dbwriter application. For security reasons, the database user for accounting and reporting should have only read permission for the database tables.


    Please enter the name of the database user [arco_read] >> 
    
    Please enter the password of the database user >> 
    Please retype the password >> 
    
    Please enter the name of the database schema [arco_write] >> 
    
    Search for the jdbc driver oracle.jdbc.driver.OracleDriver 
    in directory /opt/n1ge/reporting/WEB-INF/lib ...
    found in /opt/n1ge/reporting/WEB-INF/lib/classes12.jar
    Should the connection to the database be tested? (y/n) [y] >> y
    
    Test db connection to 'jdbc:oracle:thin:@my-system:1521:arco' ... OK
    h150

    The name of the database schema depends on your database. For a PostgresSQL database, the database schema name should be public. For Oracle, the name of the database schema should the same as the name of the user account which is used by the dbwriter (arco_write).


    Please enter the name of the database schema [arco_write] >> 
    
    Searching for the jdbc driver oracle.jdbc.driver.OracleDriver 
    
    OK, jdbc driver found
    
    Should the connection to the database be tested? (y/n) [y] >> y
    
    Test db connection to 'jdbc:oracle:thin:@my-system:1521:arco' ... OK

    Note –

    The JDBC driver should be also located in $SGE_ROOT/reporting/WEB-INF/lib directory.


  7. Enter the login names of users who are allowed to store the queries and results.


    Configure users with write access
    
    Users: sge-admin
    Enter a login name of a user (Press enter to finish) >> user2
    Users: sge-admin user2
    Enter a login name of a user (Press enter to finish) >> 
    ---------------------------------

    Note –

    After installation, you can add or delete authorized users by editing the config.xml file. See the information at the end of this chapter.


  8. Verify the information.


    All parameters are now collected
    --------------------------------
           SPOOL_DIR=/var/spool/arco
              DB_URL=jdbc:oracle:thin://my-system:1521/arco
             DB_USER=arco_read
    ARCO_WRITE_USERS=user1 user2
    
    Are this settings correct? (y/n) [y] >> y
    
    Shutting down Sun(TM) Web Console Version 2.2.1...
  9. If a previous version of ARCo is installed, you will be asked to remove it:


    GE reporting module already registered at Java Web Console
    ----------------------------------------------------------
    
    The GE reporting modules can only be installed
    if no previous version is registered.
    
    Should the GE reporting module com.sun.grid.arco_6.0-Maintrunc be unregistered? (y/n) [n] >> y
  10. Install pre-defined queries.

    If the query directory already does not exist, it will be created. The example queries will be installed in sge-root/reporting/database/example_queries/queries. Existing queries will not be replaced.


    Directory /var/spool/arco does not exist, create it? (y/n) [y] >> y
    
    Create directory /var/spool/arco
    Create directory /var/spool/arco/queries
    Copy examples queries into /var/spool/arco/queries
    Copy query Accounting_per_Department.xml ... OK
    Copy query Accounting_per_Project.xml ... OK
    Copy query Accounting_per_User.xml ... OK
    Copy query Average_Job_Turnaround_Time.xml ... OK
    Copy query Average_Job_Wait_Time.xml ... OK
    Copy query DBWriter_Performance.xml ... OK
    Copy query Host_Load.xml ... OK
    Copy query Job_Log.xml ... OK
    Copy query Number_of_Jobs_completed.xml ... OK
    Copy query Queue_Consumables.xml ... OK
    Copy query Statistic_History.xml ... OK
    Copy query Statistics.xml ... OK
    Create directory /var/spool/arco/results
  11. Confirm that reporting module is set up.


    ARCo reporting module setup
    ---------------------------
    Copying ARCo reporting file into /opt/n1ge6/default/arco/reporting
    
    Setting up ARCo reporting configuration file. After registration of
    the ARCo reporting module at the Java Web Console you can find
    this file at
    
          /var/opt/webconsole/webapps/reporting/config.xml
    
    
    Hit <RETURN> to continue >>
  12. Confirm that reporting module is registered to the web console and the console starts.


    Registering the GE reporting module in the Java Web Console
    -----------------------------------------------------------
    
        Registering com.sun.grid.arco_6.0-Maintrunc.
    
    
    Hit <RETURN> to continue >>
    
    Java Web Console startup
    ------------------------
    
    Starting Java Web Console ... OK
    
    Hit <RETURN> to continue >>
    
    GE ARCo reporting successfully installed
  13. Check the log file for error or warning messages.


    # more /var/log/webconsole/console_debug_log
    

    The accounting and reporting logs are written to the /var/log/webconsole/console_debug_log file. The default log level is INFO, but you can modify the log level from the command line:


    # smreg add -p -e arco_logging_level=FINE
    

    The new log takes effect the next time the console is started or restarted. The possible log levels are WARNING, INFO, FINE, FINER, and FINEST.

  14. Connect to the Sun Java Web Console by accessing the following URL in your browser. Replace hostname with the name of your master host.


    https://hostname:6789
  15. Login with your UNIX account.

  16. Select N1 Grid Engine 6 Accounting and Reporting Console.