EPP JON / RHQ plugin how-to

Note that these instructions will only work for RHQ > 4.2.0 since the EAP 5 plugin bundled with RHQ 4.2.0 will fail to properly discover EPP 5.2. If you're using RHQ 4.2.0, please use the attached EAP 5 plugin and follow the same process with it as you did to install the GateIn plugin. Do not forget to update the plugins on the agent!

Installing the RHQ server

  1. Download RHQ from http://rhq-project.org/display/RHQ/Download
  2. Unzip it, let's call the resulting directory rhq-server
  3. cd rhq-server/bin
  4. Type: ./rhq-server.sh start
  5. Go to: http://localhost:7080/installer/
  6. Click on "Click here to continue the installation"
  7. Use the appropriate database from the "Database Type" dropdown. For quick testing, use the unsupported H2 (embedded)
  8. Input your database information. If you used the H2 version, nothing else is needed. If you test your database connection, your password will be lost, make sure to re-input it in the field!
  9. Once you're set, click on "Install server"
  10. Wait for the install process to finish and click on the "Done! Click here to get started!" link. It might not work (i.e. loop forever on the welcome page). If that happens, go directly to http://localhost:7080/coregui
  11. Log in with rhqadmin/rhqadmin
  12. If everything went well, you should see the RHQ dashboard.

Installing the GateIn JON plugin

  1. Get the code from https://github.com/gatein/gatein-rhq
  2. Choose right portal platform
    1. GateIn 3.5 on as7 or EPP 6.x: git checkout master
    2. GateIn 3.x on as5/6 or EPP 5.2.x: git checkout as5-plugin
  3. Compile using: mvn install
  4. Copy jar in target to the rhq-server/plugins directory.
    1. target/gatein-as7-rhq-plugin.jar for GateIn 3.5 on as7 or EPP 6.x
    2. target/gatein-rhq-plugin.jar for GateIn 3.x on as5/6 or EPP 5.2.x
  5. If the server was running, you can upload the plugin jar from the Administration tab, selecting Configuration/Agent Plugins in the left pane and then clicking on the "Choose File" button at the bottom of the main pane. Alternatively, if you copied the plugin jar to the server plugins directory while it was running, you can do a Scan For Updates on that same screen.

Installing the RHQ agent

  1. With the RHQ server running, go to http://localhost:7080/agentupdate/download. This will download the agent installer.
  2. Run: java -jar <agent-download.jar> --install[=<new agent directory>] This command will install a new agent. If you do not specify the new agent directory, the default will be "." and will create a new directory called rhq-agent
  3. cd rhq-agent/bin
  4. ./rhq-agent.sh and wait for the prompt to appear. You can type help at the prompt to see the available commands. Tab completion also works when inputting commands.
  5. Type plugins update at the prompt. You should see something like "The plugin [GateIn] has been updated at [gatein-jon-plugin.jar].".

Preparing GateIn / EPP

GateIn 3.5 on as7 or EPP 6.x

By default the admin console is secured and you need to allow RHQ/JON to access it. Easiest way to add a managed user is to startup the sever and then run the $JBOSS_HOME/bin/add-user.sh|bat script and follow the instructions to add a managed user.

 

GateIn 3.x on as5/6 or EPP 5.2.x

By default, the JMX console is secured and you need to allow RHQ/JON to acces it. This can easily be done by uncommenting #admin=admin in $JBOSS_HOME/server/default/conf/props/jmx-console-users.properties. After this has been done startup up the server.

Accessing the GateIn plugin from RHQ

  1. After the instance is running, it should appear in the Autodiscovery Queue (http://localhost:7080/coregui/#Inventory/Resources/AutodiscoveryQueue) of the RHQ GUI. This will be the one having the proper Resource Key (path to your GateIn/EPP install).
    • For GateIn 3.x / EPP 5.2.x several plugins will recognize the instance so be sure to select the one that says "JBoss Application Server 5" in its descriptions. The other one actually uses the AS 4 plugin and that won't work.
  2. Select the recognized instance by clicking on the checkbox for it and then click on "Import" at the bottom.
  3. The GateIn/EPP instance should now be available as a "Servers" resource at http://localhost:7080/coregui/#Inventory/Resources/Servers.
    1. If the instance is not available (i.e. you see it under the Unavailable Servers resources in the Inventory), please make sure that you followed instructions Preparing GateIn / EPP
    2. Go to the Inventory tab in RHQ and locate your unavailable EPP instance in the list of unavailable servers.
    3. Right-click on it in the left pane to display the contextual menu and select "Connection Settings" (or go to http://localhost:7080/coregui/#Resource/<resource id>/Inventory/ConnectionSettings if you know the resource id for your server).
    4. Uncheck the "Unset?" checkboxes for the "Principal" and "Credentials" properties in the "Connection Info" section and put in the credentials you added to the GateIn/EPP instance either via jmx-console-users.properties or add-user script.
    5. Click on "Save" at the top.
    6. Your GateIn/EPP instance should now be available!
  4. Select the instance at http://localhost:7080/coregui/#Inventory/Resources/Servers by clicking on it in the main pane. It should now be displayed in the main pane while the left pane should have changed to display the currently selected resource.
  5. You should see a child resource for the GateIn/EPP instance which should list all available portal instances. Clicking on one should display information for that particular portal!
    1. For GateIn 3.x / EPP 5.2.x the child resource is named "Portals"
    2. For GateIn 3.5 / EPP 6.x the child resource is named gatein and under that is "Portals".