Run Hyperic Installer

About this page...

This page has instructions for performing a new installation of Hyperic components using the Hyperic installer. Before running the installer, see Hyperic Installation and Startup Process for information about where installation fits in the implementation process. For production environments, there are several steps to perform before installing the Hyperic Server and Hyperic Agent, including database setup and SSL configuration.

If you wish to upgrade an existing Hyperic deployment, please see Hyperic Upgrade Processes.

Obtain Hyperic Installer

If you have not done so already, download the Hyperic installer. See Select and Download an Installer.

About the Setup Script

The setup script, setup.bat for Windows or, setup.sh for Unix-like environments, is in the Hyperic installation package. You can use to install the Hyperic Server, the Hyperic Agent, or both.

When you run the setup script, you can supply a qualifier that sets the installation mode.

  • none — Run the setup script with no qualifier to perform a quick install. Selected components will be installed with default values for most configuration options. If you install the Hyperic Server, it will be configured to use its built-in PostgreSQL database. A quick install is useful when you evaluate Hyperic.

  • -full — In "full" mode, the installer dialog will prompt for all setup configuration options. Use this option if you plan to configure the Hyperic Server to use an SSL keystore that you manage yourself, rather than a Hyperic-generated keystore.

  • -upgrade — Use "upgrade" mode if you have an existing Hyperic Server installation. The server configuration and the contents of the existing Hyperic database are preserved. See Hyperic Upgrade Processes before doing an upgrade installation.

  • -postgresql — Quick install when using a standalone (not the Hyperic built-in) PostgreSQL database; installer will prompt you for database connection information and use defaults for other configuration settings.

  • -oracle — Quick install mode for Oracle; installer will prompt you for database connection information and use defaults for other configuration settings.

  • -mysql — Quick install mode for MySQL; installer will prompt you for database connection information and use defaults for everything else.

Configuration Options for Database-Specific Quick Installs

When you do a database-specific quick install (-postgresql, -oracle, or -mysql) the installer does not:

  • Prompt for the ports on which the Hyperic Server listens for agent and user interface requests — the default ports are automatically configured.

  • Allow you to specify the location and password for a user-managed server keystore — instead, the Hyperic Server will use a Hyperic-managed keystore.

  • Allow you to select a different database type.

Run the Setup Script

This section describes the dialog that the installation script presents if you run it in -full mode. If you us a different mode, some of the prompts described below will not appear — default values will be applied to those options.

  1. Create a directory for the Hyperic installation.

    • The installation dialog assumes your Hyperic installation directory is /home/hyperic on Unix-like systems and c:\Program Files on Windows.

  2. Unpack the tarball or zip archive.

    • Use GNU Tar to unpacking Hyperic tarballs. Use of proprietary Unix Tar utilities will result in warnings. GNU Tar is available at http://www.gnu.org

      tar zxvf hyperic-hq-installer-4.x.y-xxx.tgz
    • If you are installing Hyperic components on a Windows platform, you must run the installer on a local drive.

  3. Open a command shell.

    • On Unix-based platforms, enter:

      PathToInstaller/setup.sh -mode
    • On Windows platforms, enter:

      PathToInstaller\setup.bat -mode
    • where mode is one of the values in the table above, with the exception of upgrade — if you are upgrading an existing Hyperic deployment, see Hyperic Upgrade Processes.

  4. The VMware License agreement is displayed.

    • Accept the license agreement to proceed.

  5. Choose which software to install 1: Hyperic HQ Server  2: Hyperic HQ Agent

    • To install both the server and the agent, enter:

      1,2
  6. HQ server installation path [default '.....']:

    • Accept the default, or enter a directory location. You must have write access the location.

  7. What port should the HQ server's web-based GUI listen on for http communication? [default '7080']:

    • Accept the default, or enter a different (unused) port.

  8. What port should the HQ server's web-based GUI listen on for secure https communication? [default '7443']

    • Accept the default, or enter a different (unused) port.

  9. Would you like us to use your own java keystore? [default '2']  1: Yes  2: No

    • Enter "1" if you wish to configure the Hyperic Server to use a certificate you manage, rather than generate its own, and proceed to the next step.

    • If you accept the default "2", a default keystore will be generated at: ServerHome/conf/hyperic.keystore with the password hyperic, and the next three prompts will not appear.

  10. What is the file path to your java keystore?

    • This prompt appears if you are configuring Hyperic Server for a user-managed keystore.

    • Enter the path to your keystore.

  11. What is the file password to your java keystore?

    • This prompt appears if you are configuring Hyperic Server for a user-managed keystore.

    • Enter the path to your keystore.

  12. Enter the base URL for the Hyperic server's web-based GUI [default...]

    • The URL used to access the Hyperic Server. This value is used in alert notification emails. This value can be changed on the Administration page in the Hyperic Portal.

  13. Enter the fully qualified domain name of the SMTP server that Hyperic will use to send email messages [default FQDN.local]

    • If the installer does not find a local SMTP server, and you do not specify one, Hyperic cannot send alert notifications. Other alert functionality is unaffected.

    • You can configure Hyperic for an external SMTP server after installing Hyperic Server. See Configuring Hyperic Server for SMTP Server.

  14. Enter the email address that HQ will use as the sender for email messages [default...]

    • The email address of the Hyperic Administrator. Note that most mail servers will not deliver mail without a valid domain name in the From field.

  15. What is the installation profile? default '1':]
    1: small (less than 50 platforms)
    2: medium (50-250 platforms)
    3: large (larger than 250 platforms)

    • Select the profile that fits your deployment. For more information, see About Sizing Profiles in vFabric Hyperic.

      The sizing prompt is only presented in vFabric Hyperic, and only when you are running a -full installation.

      If you plan to use the embedded PostgreSQL database, rather than an external database (required for production environments), select the "small" sizing profile. The "medium" and "large" profiles are not supported unless you use an external Hyperic database.

  16. What backend database should the HQ server use? [default '1']:Choices:
    1: HQ Built-in Database
    2: Oracle 10g/11g
    3: PostgreSQL
    4: MySQL Enterprise / Community Server 5.x

    • Select the database you wish to use and:

      • If you entered "1", proceed to step 16.

      • If you entered "2", "3", or "4", proceed to step 17.

  17. What port should HQ's built-in database use? [default '9432']:

  18. Dialog for external database:

    1. Enter the JDBC connection URL.

      • The prompt supplies a default URL, which assumes the external database is on localhost.

      • Supply a URL in the form shown, editing as appropriate to identify the connection details, such as host and name.

    2. Enter the username to use to connect to the database:

      • Enter the database username that was set up when the Hyperic database was created.

    3. Enter the password to use to connect to the database:

      • Enter the database password that was set up when the Hyperic database was created.

  19. Would you like to use an auto generated encryption key to encrypt the database password? [default '1']

    • If you accept the default, the installer will generate a key for encrypting the database password. Enter 2 if you prefer to supply the string yourself, and when prompted, enter a string of at least 8 characters.

  20. What should the username be for the initial admin user? [default 'hqadmin']:

    • Accept the default, or enter a different username.

  21. What should the password be for the initial admin user?:

    • The installer will not echo the password but will prompt for it twice.

  22. What should the email address be for the initial admin user? [default...]

    • Accept the default, or enter a different email address.

  23. If the installer detects a database from a previous Hyperic installation, it will prompt you to:

    • 1: Upgrade the HQ server database — Choose this option to preserve your existing Hyperic data, then follow the instructions in Upgrade Hyperic Server.

    • 2: Overwrite the HQ server database — This option erases all of the data in your Hyperic database. If you do not want to preserve the contents of the database, it would be quicker to drop and recreate the database prior to installing Hyperic Server.

    • 3: Exit the installer

  24. HQ agent installation path [default '......']:

    • Accept the default, or enter a different path.

    • The installer indicates the installation was successful, provides the URL for the Hyperic Portal along with the default username and password, and returns you to the command prompt.

After installing the Hyperic Server, proceed with license installation (for vFabric Server only) and start the server, as described in the Install License and Start the Hyperic Server steps of Hyperic Installation and Startup Process.