ESM Server Installation Guide - Unix

Note

It is recommended that you review the document titled Functional Overview of ESM before continuing with the tasks outlined here. Likewise, after completing the tasks here, further configuration of SAS will be required before session-level detail is reported. The further configuration steps required are covered in Configuring SAS for ESM.

System Requirements

Supported versions of Linux/Unix

System requirements

Hardware Requirements

Boemska recommend a dedicated (virtual or physical) machine on which to run the ESM Server. The ESM database can run on the same host, or if preferred on a dedicated database server. Communication between the ESM Server and the database is facilitated by the relevant JDBC driver.

  • Minimum 1 x Quad Core CPU
  • 8GB RAM
  • Approximately 1.5GB Diskspace for the ESM Server installation
  • 50 – 100GB Storage (Table) Space for the underlying ESM Database

Note

Large deployments with a high number of end users may require a higher specification and increased disk space. Contact Boemska for further details on sizing._

Supported Versions of Unix/Linux

  • 64 bit Linux (RHEL4 or newer recommended)

Supported Databases

MySQL 5.6 or newer

Installation Wizard settings

The following settings for MySQL are recommended:

  • the installed server type is 'Server Machine'
  • with 20 concurrent connections to the database
Post-Install Database Configuration

The following configuration changes are recommended for the MySQL database:

max_allowed_packet=512M
innodb_buffer_pool_size=512M

In addition, MySQL 5.7 and newer requires the following:

sql_mode=STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
These changes should be made in MySQL's my.cnf config file (default /etc/my.cnf on most distributions). Refer to the official MySQL documentation for further details.

Oracle 11g or newer

Oracle 11g is supported as a target database for ESM. If you intend to deploy ESM on Oracle, contact Boemska for latest best practice recommendations.

Installation Requirements

  • Approximately 1.5GB disk space for the ESM Server installation files:

    • ESM Server Installer compressed (318MB)
    • ESM Server Installer unpacked (390MB)
    • ESM Server Installed (775MB)
  • 50GB – 100GB disk space/tablespace for selected database storage:

    • Storage requirements vary depending on the number of nodes and sessions/jobs monitored
    • ESM data collection intervals and metric resolutions are configurable, both of which affect the storage required
    • ESM has a configurable, automated maintenance schedule to manage and maintain data storage
    • Where possible, Boemska recommends dynamically sized disk space/tablespace which can be adjusted according to demand
    • For a more detailed break down of storage requirements, or if you have a complex/large environment please contact Boemska for further information
  • Ports – If a firewall is configured, the following ports will need to be opened for communication between the ESM Agent(s) and the ESM Server. The default ports are listed below. Custom ports can be specified during installation if required:

    • 18080 – default HTTP port for ESM communication
    • 18181 – default HTTPS port for ESM communication
    • 14848 – default ESM administration port
  • If the ESM Server instance is running on a different host to the database, one of the following ports (Database Vendor dependant) will need to be opened for communication between the ESM Server and the Database over the configured JDBC connection. The default ports are listed below, change as appropriate if configured differently

    • MySQL - default port 3306
    • Oracle - default port 1521
  • An Operating System account under which to run ESM Server. ESM requires an account with the following privileges:

    • Sudo privileges (only required when choosing to utilise the Administrative SAS Session Management capability and for the measurement of private SASWORK directories)
    • A centrally managed or non-expiring password (recommended)
    • Read/Write access to the target installation directory and subdirectories
  • Access to a web browser


Third-party Components

Java

The ESM Server is supplied with its own Java Runtime Environment (JRE) and is automatically configured to use the bundled version.

To configure ESM to use a different JRE, please consult our online knowledge base or contact support@boemskats.com

Database Object Creation

Complete the following steps for the appropriate database. The database (and tablespace for Oracle) and required users must exist prior to starting the ESM Server installation.

Important: Make a note of, and keep safe, the username and password for the newly created database user as it will be required for installation and access to the ESM Server Database.

MySQL

  1. Log in to your instance of the MySQL database as root or an administrative user, for example by running the following from the bin directory of your MySQL installation:

    [user@ESMServer mysql]$ -uroot -p
    Enter password:
    Welcome to the MySQL monitor.
    
  2. Create the user that the ESM Server application will use:

    create user 'esm'@'hostname' identified by 'esmPass';
    

    Where:

    esm is the name of the user the ESM Server application will use.

    hostname is the name of the host where the ESM Server will be installed.

    esmPass is the password you want to set for the ESM Server user.

    Note

    If the ESM Server is being installed on the same host as the Database, it is safe to use 'localhost' as the hostname variable here. However, this will only function correctly if 'localhost' is also used as the target hostname in the JDBC connection string configured as part of the ESM Installation Wizard.

  3. Create the database that the ESM Server application will use:

    create database esm CHARACTER SET utf8 COLLATE utf8_unicode_ci;
    

    Note: ESM requires utf8 character encoding.

  4. Grant the new database user permissions on the newly created database:

    grant all on esm.* to 'esm'@'hostname';
    

    Where:

    esm is the name of the user you'd like the ESM Server application to use.

    hostname is the name of the host where you will be installing the ESM Server.

Oracle

  1. Log in to your instance of Oracle as an administrative user, or a user with tablespace and user creation rights.

  2. Create the TS_ESM tablespace, minimum 50 GB in size (or as instructed by Boemska for large environments)

  3. Create the user that the ESM Server application will use:

    CREATE USER esm IDENTIFIED BY esmPass DEFAULT TABLESPACE TS_ESM;
    

    Where:

    esm is the name of the user you'd like the ESM Server application to use.

    esmPass is the password you want to set for the ESM Server user.

  4. Grant the required privileges to the newly created user:

    GRANT CONNECT, RESOURCE, CREATE VIEW TO esm;
    

    Where:

    esm is the username of the database user created for the ESM Server application to use.


ESM Server Installation

Unpacking the ESM Server Installation package

  1. Download the appropriate ESM Server installation package for your Linux/Unix operating system. Installation packages can be obtained by signing in to the Boemska Customer Area at https://boemskats.com or by contacting your Boemska representative. For help please email support@boemskats.com

  2. Unpack the archive to your desired location. This guide assumes a target location of

    /filesystem/esm-server-installer
    

Installing the ESM Server

  1. Log on to the server using the nominated account with the required installation privileges (see installation requirements for more details)

  2. Change directory to the destination of the unpacked installation package (//filesystem/esm-server-installer/) and execute the setup.sh script to start the ESM Server Installation Wizard.

    cd //filesystem/esm-server-installer/
    ./setup.sh
    
  3. The ESM Server installation wizard will now start. You will first be prompted to select your database:

========================================================================

NOTE: Before installing esm server, make sure that you have installed

  MySQL 5.6 or higher, or Oracle 10g or higher.

1) Embedded (pgsql, most common option)

2) MySQL

3) Oracle

4) PostgreSQL

Please, select your database:

Select your database by entering 1 or 2 or 3 or 4 and press enter. If you selected 1 (Embedded database), proceed to the next steps:

  1. Enter the hostname or IP address of the Embedded database, or press enter to accept the default setting of 'localhost'

  2. Now confirm the JDBC connection URL for the database, only updating if required: Embedded database

Enter the database port number for Embedded database: [default: 15432]

Enter the JDBC connection URL for Embedded database: [default: jdbc:postgresql://localhost:15432/esm]

  1. Enter the username of the ESM database user created at the user/database creation step. Press enter to proceed to the next step. Enter the Embedded database username: [default: esm]

  2. Enter the password of the ESM database user created at the user/database creation step. Press enter to proceed to the next step.

Enter the Embedded database password (type 'none' for blank password): [default: esm]

  1. You will now be prompted for the server installation path. Press enter to proceed. Please, insert esm-server install path: [default: /home/marija]

  2. Enter the Embedded database installation directory, or press enter to accept the default setting. Enter the Embedded database installation directory: [default: /home/marija/esm-server/pgsql]

  3. Enter the Embedded database data directory or press enter to accept default setting.

Enter the Embedded database data directory: [default: /home/marija/esm-server/pgsql/data]

  1. Enter the Embedded database logs directory or press enter to accept default setting.

Enter the Embedded database logs directory: [default: /home/marija/esm-server/pgsql/logs]

Extracting embedded postgres database to /home/marija/esm-server/pgsql ... Initializing embedded database...

Checking database connection... Embedded database successfully checked.

  1. Enter the port that the esm server will use. Leave blank to accept the default port 18080 (recommended). Press enter to proceed. Enter the port that esm server will use: [default: 18080]

  2. Enter the port that the esm admin will use. Leave blank to accept the default port 14848 (recommended). Press enter to proceed. Enter the port that esm admin will use: [default: 14848]

  3. Enter the port that the esm will use. Leave blank to accept the default port 18181(recommended). Press enter to proceed. Enter the port that esm will use for secure connection: [default: 18181]

  4. Enter the port that the JMS service will use. Leave blank to accept the default port 17676 (recommended). Press enter to proceed. Enter the port that esm admin will use for JMS service: [default: 17676]

  5. Enter the port that the EJB service will use. Leave blank to accept the default port 13700 (recommended). Press enter to proceed. Enter the port that esm admin will use for EJB service: [default: 13700]

  6. Enter the username for the ESM Administrator, or leave blank to accept the default of 'sasadm'. Press enter to proceed. Enter the esm admin settings username: [default: sasadm]

  7. Enter the password for the ESM Administrator, or leave blank to accept the default of 'sasadm123' (not recommended). Press enter to proceed. Enter the esm admin settings password: [default: sasadm123]

Important- keep the ESM Administrator username and password details safe The ESM server will now be extracted and installed. On successful completion, you should see a message similar to the following:

Extracting server to /home/marija ...

Configuring server installation...

Configuring server database connection...

Configuring esm admin user...

Exporting selected database...

Exporting database scripts...

ESM server installation complete:

Successfully installed to: /home/marija/esm-server

NOTE: Make sure that port 18080 is open for agents connections.

You can start ESM Server by running this command:

/home/marija/esm-server/bin/esm-server.sh start

You can access to your server at: http://localhost:18080/esm-1.0/

Your esm administration username: sasadm

Your esm administration password: sasadm123

Do you want to start it now? (y/n):

  1. Enter 'y' and press enter to start the ESM Server

The ESM Server will now start and a message similar to the following should be displayed:

Starting embedded database... waiting for server to start.... done server started Waiting for domain1 to start ..... Successfully started the domain : domain1 domain Location: /home/marija/esm-server/esm-core/glassfish/domains/domain1 Log File: /home/marija/esm-server/esm-core/glassfish/domains/domain1/logs/server.log Admin Port: 14848 Command start-domain executed successfully.