Quick Start Guide
HQ Quick Installation for Non-Windows
This page will help you install HQ in a non-Windows environment and get it running as quickly as possible. If you are installing in a Windows environment, use these Windows-specific instructions. For the complete installation guide, please see the Full Installation Guide.
 | Recommended for First-Time Users These quick-installation instructions are recommended for first-time users and users evaluating HQ. |
To install Hyperic HQ in a non-Windows environment:
- Download the HQ package.
- Unpack the HQ package.
- Install the HQ server and agent.
- Start the HQ server.
- Start the HQ agent.
If necessary, consult the list of supported platforms to determine which non-Windows environments are supported.
Download HQ
The first step is to download HQ from the Hyperic HQ Download Page. Download the HQ "installer" bundle specific to your environment. If you already have a JRE and want to use that, you can download the noJRE or "Platform Neutral" version. If you are using the noJRE package, be sure that your JAVA_HOME environment variable is set correctly. If you have a particular JRE you want HQ to run on, you can set an HQ_JAVA_HOME environment variable.
Unpack the HQ package
Now that you have downloaded the package, you must unpack it. The .tgz packages are gnuzipped tar archive files and can be unpacked using gnu tar:
tar zxvf hyperic-hq-installer-3.0.2-xxx.tgz
Install the HQ Server and Agent
To install the Server and Agent:
- Run setup.sh
hyperic@hq$ ./hyperic-hq-installer/setup.sh Initializing Hyperic HQ Installation... Choose which software to install: 1: Hyperic HQ Server 2: Hyperic HQ Shell 3: Hyperic HQ Agent You may enter multiple choices, separated by commas.
- Select the HQ Server and Agent for installation:
1,3
- Specify where to install the HQ Server:
HQ server installation path [default '/home/hyperic']:
Install the HQ Server to any location you wish. You must have write access to that location, of course. The Agent install path can be the same as the Server install path (they install themselves to different subdirectories). At this point, the installer will begin installing the Server and Agent. When the installation has completed, the installer will exit.
Start the HQ Server
When the installer has successfully exited from the previous step, it will display the full path to the startup script.
<path to server-version#>/bin/hq-server.sh start
What a Successful Server Start-Up Looks Like. The following is the output from a successful Server start-up.
Starting HQ server... Initializing HQ server configuration... Starting HQ built-in database... HQ built-in database started. Booting the HQ server... HQ server booted. Login to HQ at: http://127.0.0.1:7080/
This should be displayed quickly. The Server will start up in the background. Depending on the hardware, the HQ Server can take several minutes to completely boot. The HQ UI will display this start-up status until the server is completely booted; then it will display the login page.
Start the HQ Agent
The first time the HQ Agent starts, it needs some information to be able to connect to the HQ Server.
- Run the hq-agent.sh startup script:
/home/hyperic/agent-2.6.*/bin/hq-agent.sh start
This is displayed:
Starting agent - Unable to load agent token file. Generating a new one ... Done - Invoking agent Agent successfully started [ Running agent setup ] What is the HQ server IP address:
- Specify the HQ Server IP address. Assuming the HQ Server and HQ Agent are installed on the same machine, the address is 127.0.0.1. If the Agent is on a remote host, specify the IP address of the HQ Server.
- Specify whether the Agent will communicate with the Server via SSL.
Should Agent communications to HQ always be secure [default=no]:
It is generally safe to take the default of 'no'. In the case where the Agent and Server are on the same machine, it is very safe to say 'no'. SSL is useful if the Agent and Server need to use the open internet to communicate with each other.
- Accept the default HTTP HQ Server port (7080).
What is the HQ server port [default=7080]:
Check Firewall Configuration
Make sure no firewalls are blocking TCP port 7080 (or 7443) on the HQ Server host. If there is a firewall device between the HQ Agent and HQ Server:
- Specify the IP address of the device as the "HQ server IP address" above.
- Configure the device to forward traffic on TCP port 7080 (or 7443) to the host running the HQ Server.
- Accept the default login and password (both are hqadmin) or specify other values:
- Testing insecure connection ... Success What is your HQ login [default=hqadmin]: What is your HQ password:
- Specify the IP address that the Server will use to contact the Agent.
What IP should HQ use to contact the agent [default=127.0.0.1]:
Accept the default value (127.0.00.1) if the Agent and Server are on the same machine, making communication over the loopback device the most efficent. If the Agent is running on a remote host, instead specify the IP the HQ Server will use to contact this agent; the value depends on network configuration, but it is usually the IP address of the external interface of the machine.
- Accept the default port (2144) the HQ Agent listens on.
What port should HQ use to contact the agent [default=2144]:
Check Firewall Configuration
Make sure any firewalls are not blocking incoming TCP port 2144. If there is a firewall device between the HQ Agent and HQ Server:
- Enter the IP of the device as the IP address the HQ server will use to contact the agent (as specified above).
- Configure the device to forward traffic on TCP port 2144 to the host running the HQ Agent.
What a Successful Agent Start-Up Looks Like. The following is the output from a successful Agent start-up.
- Received temporary auth token from agent
- Registering agent with HQ
- HQ gave us the following agent token
1104817706987-8534327776788402831-4021000845020676153
- Informing agent of new HQ server
- Validating
- Successfully setup agent
The Hyperic HQ Server and Agent are now up and running.
|
Next Steps
|
Related Topics |