Chapter 4 Service Manager Installation
Prev |  | Next

## Chapter 4 Service Manager Installation

This chapter describes the installation of the MySQL Enterprise Service Manager.

Important

Due to changes in TLS support, as of MySQL Enterprise Monitor 3.0.22, it is not possible for the MySQL Enterprise Service Manager to communicate with earlier versions of the MySQL Enterprise Monitor Agent.

MySQL Enterprise Service Manager 3.1.0 cannot communicate with any MySQL Enterprise Monitor Agent earlier than version 3.0.22. It is strongly recommended you use 3.1 agents with the 3.1 Service Manager.

The MySQL Enterprise Service Manager installer installs the following components:

- Apache Tomcat: mandatory component. Servlet container and web server which hosts the MySQL Enterprise Service Manager.

- Java Runtime Environment (JRE): mandatory component. Required by Tomcat.

- MySQL Server: optional component. Used to store the data from the monitored hosts and instances. Referred to, throughout this document, as the repository. It is also possible to use another MySQL instance as the repository.

## 4.1 MySQL Enterprise Monitor Installation Types

The MySQL Enterprise Service Manager installer enables you to choose your installation type. This choice sets parameters which suit your installation type.

The following are the possible installation types:

- Small: 1 to 5 MySQL Servers monitored from a laptop or low-end server with no more than 4GB of RAM.

- Medium: Up to 100 MySQL Servers monitored from a medium-sized, but shared, server with 4 to 8GB of RAM.

- Large: More than 100 MySQL Servers monitored from a high-end server, dedicated to MySQL Enterprise Service Manager, with more than 8GB RAM.

These parameters are set in the following configuration files:

- `setenv.sh`/ `setenv.bat`:

  - Tomcat Heap Size (`-Xms` and `-Xmx`): defines the minimum (`-Xms`) and maximum (`-Xmx`) amount of RAM available to Tomcat's JVM. `-Xmx` and `-Xms` are set to the same value.

  - Tomcat `MaxPermSize`: defines the maximum size of the pool containing the data used by Tomcat's JVM.

- `my.cnf`/`my.ini`:

  - `table_definition_cache`: defines the number of table definitions that can be stored in the definition cache.

  - `innodb_buffer_pool_size`: defines the size, in megabytes, of the InnoDB buffer pool.

Table 4.1 Installation Parameters

Parameter | Small | Medium | Large
--- | --- | --- | ---
Tomcat Heap Size | 512MB | 768MB | 2048MB
Tomcat MaxPermSize | 200MB | 512MB | 1024MB
table_definition_cache | 800 | 2048 | 2048
innodb_buffer_pool_size | 100MB | 768MB | 8096MB

Important

These values are not hard-coded. You can change them, if your installation requires it, by editing `setenv.sh`/`setenv.bat`, or `my.cnf`/`my.ini`.

## 4.2 MySQL Enterprise Service Manager Graphical Installation Wizard

This section describes how to install the MySQL Enterprise Service Manager using the Installation Wizard. This process is identical across all supported platforms.

Note

On UNIX and Linux platforms, ensure the installer is executable before you begin.

Important

It is recommended to install MySQL Enterprise Service Manager as root, but not to run MySQL Enterprise Service Manager as root. If you install as root, you are prompted to create a user for MySQL Enterprise Service Manager. If you do not install as root, MySQL Enterprise Service Manager cannot start automatically on system boot and must be started manually.

To install MySQL Enterprise Service Manager, do the following:

1. Run the installer as required by the operating system.

2. The language selection dialog is displayed. Choose a language and click OK.

   The following information is displayed:

   Note

   During the installation process you must enter usernames and passwords for components of the Enterprise Monitor. Make note of these in a secure location so you can recover them in case they are forgotten.

3. Click OK to continue.

4. On the Welcome dialog, click Forward.

   The Installation Directory dialog is displayed.

5. Change the installation directory or accept the default path and click Forward.

   The Select Requirements dialog is displayed.

6. Select the size of installation required. For more information, see Section 4.1, “MySQL Enterprise Monitor Installation Types”.

   Click Forward.

   The Tomcat Server Options dialog is displayed.

7. Complete the following fields as required:

   - Tomcat Server Port: Default value is 18080. This port is required by the upgrade from version 2.3 to 3.1, only. It enables the 2.3 Agents to communicate with MySQL Enterprise Service Manager 3.0. 2.3 Agents did not support SSL.

     Note

     If you are performing a clean installation of 3.1, and no 2.3 Agents are present, clear this field.

   - Tomcat SSL Port: Default value is 18443. This port is mandatory for communication with 3.0 Agents, which must use SSL to communicate with the MySQL Enterprise Service Manager.

   Click Forward.

   The Service Manager User Account dialog is displayed.

8. Enter the name of the user account MySQL Enterprise Service Manager will run under. If this user account does not exist, it is created by the installer.

   Click Forward.

   The Database Installation dialog is displayed.

9. Select one of the following options:

   - I wish to use the bundled MySQL database: select to install a MySQL server.

     Important

     If you choose the bundled server option, the Service Manager user defined by the installation procedure is granted complete control of the repository. This is done using `GRANT ALL PRIVILEGES ON . TO 'SM_UserName'@'localhost' IDENTIFIED BY 'password' WITH GRANT OPTION;`.

   - I wish to use an existing MySQL database: select to use an existing MySQL server as the repository.

     Important

     If you choose the existing server option, you must ensure the prerequisites listed in Section 3.2.3, “MySQL Enterprise Monitor Repository” are met before installing MySQL Enterprise Service Manager.

   Click Forward.

   The Repository Configuration dialog is displayed.

10. Complete the following fields:

    - Repository Username: enter the username used by MySQL Enterprise Service Manager to connect to the repository. If you chose to use an existing database, this user must already exist on the target MySQL instance.

      The default username is `service_manager`.

    - Password/Re-enter: enter the password and confirm in the Re-enter field.

    - MySQL Hostname or IP address: (Displayed if you chose to use an existing MySQL database, only) enter the hostname or IP address of the MySQL instance.

    - MySQL Database Port: enter the port MySQL Enterprise Service Manager uses to connect to the MySQL instance. If you chose the bundled repository, the default port number is 13306. If you chose to use an existing instance, the default port number is 3306.

    - MySQL Database Name: enter the name of the MySQL Enterprise Service Manager repository. This is useful if you intend to use multiple MySQL Enterprise Service Manager installations, but want to host their repositories on a single MySQL server. Each MySQL Enterprise Service Manager must have a uniquely named repository. It is not possible for MySQL Enterprise Service Managers to share a repository.

    - Use SSL when connecting to the database: enables SSL encryption for all communication between MySQL Enterprise Service Manager and the repository.

    - On Mac OS X platforms, you are prompted to optionally install MySQL Enterprise Service Manager as a service. This setting enables MySQL Enterprise Service Manager to start when the machine is started. You must provide the Administrator password to install MySQL Enterprise Service Manager as a service.

    Click Forward.

    The Configuration Report dialog is displayed.

11. Click Forward to install MySQL Enterprise Service Manager.

### Installation Log

The installation log file is written to the root of the installation directory.

The installation log uses the following naming convention: `install.log`.

The log file records all files installed and all actions taken by the installer, such as starting services, filling database tables, and so on. A similar log file is also created by the uninstall process.

If the installation is upgraded, the existing installation log is backed up to the backup directory and replaced by the installation log for the upgrade.

## 4.3 Text-Based Installation

The steps and options of the text-based installation are identical to those described in Section 4.2, “MySQL Enterprise Service Manager Graphical Installation Wizard”.

Note

There is no text-mode installation available for Microsoft Windows platforms.

To start the text-based installer, do the following:

1. Run the installer with the following option:

       --mode text

   The following example shows how to start the text-mode installation on a 64-bit Linux system:

       shell>./mysqlmonitor-3.0.18.3095-linux-x86-64bit-installer.bin --mode text

   The text installation process starts.

2. Follow the instructions onscreen. The options and values are identical to those described in Section 4.2, “MySQL Enterprise Service Manager Graphical Installation Wizard”.

After the Service Manager is installed, you can configure the MySQL Enterprise Monitor User Interface, as explained in Section 4.5, “MySQL Enterprise Service Manager Configuration Settings”.

## 4.4 Starting/Stopping the MySQL Enterprise Monitor Services

This section describes how to control the MySQL Enterprise Service Manager services on UNIX, Linux and Mac platforms. Microsoft Windows supports several additional methods, which are described in Starting/Stopping the MySQL Enterprise Monitor Services on Windows.

The following services are installed by MySQL Enterprise Service Manager:

- MySQL Server

- Tomcat Server.

Access the MySQL Enterprise Service Manager services using the script `mysqlmonitorctl.sh`/`mysqlmonitor.bat` which is installed in the root of your MySQL Enterprise Service Manager installation directory. To see the available options, run the command `mysqlmonitorctl.sh help` .

The `help` parameter produces the following output:

    usage: ./mysqlmonitorctl.sh help
    ./mysqlmonitorctl.sh (start|stop|status|restart)
    ./mysqlmonitorctl.sh (start|stop|status|restart) mysql
    ./mysqlmonitorctl.sh (start|stop|status|restart) tomcat

    help       - this screen
    start      - start the service(s)
    stop       - stop  the service(s)
    restart    - restart or start the service(s)
    status     - report the status of the service

To autostart all the Service Manager components, call the `mysqlmonitorctl.sh start` from your start-up script.

To start the service:

    shell> ./mysqlmonitorctl.sh start
    ./mysqlmonitorctl.sh : mysql  started
    nohup: redirecting stderr to stdout
    Starting mysqld daemon with databases from /opt/mysql/enterprise/monitor/mysql/data/
    Using CATALINA_BASE:   /opt/mysql/enterprise/monitor/apache-tomcat
    Using CATALINA_HOME:   /opt/mysql/enterprise/monitor/apache-tomcat
    Using CATALINA_TMPDIR: /opt/mysql/enterprise/monitor/apache-tomcat/temp
    Using JRE_HOME:       /opt/mysql/enterprise/monitor/java

If you try to start the service and it is already running, you are warned that the services are already running.

The `restart` command is equivalent to executing a `stop` and then `start` operation.

Important

The Service Manager can take some time to start and become usable after `mysqlmonitorctl.sh start` completes.

This script can also check the status of the Tomcat web server or the MySQL repository.

    shell> ./mysqlmonitorctl.sh status
    MySQL Network MySQL is running
    MySQL Network Tomcat is running

After the Service Manager is installed, you can configure the MySQL Enterprise Monitor User Interface, as explained in Section 4.5, “MySQL Enterprise Service Manager Configuration Settings”.

### Starting/Stopping the MySQL Enterprise Monitor Services on Windows

You can stop or start the MySQL Enterprise Service Manager services in the following additional ways:

- The Start/Stop MySQL Enterprise Monitor Services items on the Windows Start menu.

- The Services pane of the Microsoft Management Console. Right-click on the either of the MySQL Enterprise services to display the available options.

- The Windows command line, using the `sc` or `net` commands.

  From the command line, the service names are mysqlenterprisetomcat and mysqlenterprisemysql.

  For example:

      sc start mysqlenterprisemysql

  Note

  The command line terminal must be started using the Run as Administrator option.

## 4.5 MySQL Enterprise Service Manager Configuration Settings

The MySQL Enterprise Monitor User Interface is the web-based interface to the Service Manager. The procedure for starting the Monitor UI is identical for all platforms.

If you installed the Service Manager using a graphical interface, you have the option of launching the Monitor UI on the final installation screen (as long as the Launch MySQL Enterprise Monitor Now checkbox is checked, which it is by default).

Otherwise, you can view the MySQL Enterprise Monitor User Interface by typing `https://localhost:`18443`/` ("18443" is the default port number, adjust accordingly if you altered this configuration), into the address bar of your web browser. To see the host name and port to use, check the `configuration_report.txt` file.

Under Microsoft Windows, you can also open the Monitor UI by choosing the `MySQL` menu item and finding the `MySQL Enterprise Monitor` entry. Under this entry, choose `Start Service Manager`.

Important

On first start, MySQL Enterprise Service Manager can take some time to start while the services and database initialize.

Prev | Up | Next
Chapter 3 Installation Prerequisites | Home | Chapter 5 Monitor Agent Installation