Installation Guide

Installing Hawkular

cassandra | installation

Basic installation of Hawkular Server

There are two main components to install Hawkular server, the server itself and Cassandra. Fortunately both are easy to install.

Please do not use the root user for installation; create and use a non-root user.

Apache Cassandra

You need a running Cassandra cluster to get started, they are various ways to install it, any would do and you only need to know the IP/Hostname and port of your Cassandra server.

Developers of Hawkular Services all have their own preference depending on the operating system they use and experience, here is one option, using ccm:

  1. First install ccm

  2. Create a cluster (of one for now) of Cassandra 3.0.12 for Hawkular, (with start_rpc enabled) and start it:

ccm commands
ccm create hawkular -v 3.0.12 -n 1
ccm updateconf "start_rpc: true"
ccm start

Now Cassandra should be running on your machine on the default port.

Hawkular Services

  1. Grab the latest distribution of Hawkular Services, the file name should look like: hawkular-services-dist-x.y.z.Final.zip (or .tar.gz)

  2. Unzip the package in the directory of your choice, we’ll call it $HS_HOME

  3. Create as many users as you need (replace myUsername and myPassword by the values of your choice):

    sh $HS_HOME/bin/add-user.sh -a -u myUsername -p myPassword -g read-write,read-only

  4. Hawkular Services is ready to start assuming Cassandra is running on the same machine, on the same port.

If Cassandra in running on a different machine, on non standard port or if you have a cluster of Cassandra nodes, you may need to do export CASSANDRA_NODES="cassandra_host1,cassandra_host2,…​" prior to start Hawkular Services. The CASSANDRA_NODES environment variable should be a comma-delimited list of Cassandra node endpoint addresses. The value for each address should match the value of the rpc_address in the cassandra.yaml configuration file. You do not actually have to specify the address of every Cassandra node. As long as Hawkular is able to connect to one node, it will discover all of the other cluster nodes.

  1. To just start Hawkular Services:

sh $HS_HOME/bin/standalone.sh

  1. To start Hawkular Services with the embedded WildFly agent (this is used to monitor itself since Hawkular Services is based on WildFly and the embedded agent can push metrics and inventory to Hawkular Services). Replace myUsername and myPassword, with a userame/password combination as defined in the step 3.

sh $HS_HOME/bin/standalone.sh -Dhawkular.rest.user=myUsername -Dhawkular.rest.password=myPassword -Dhawkular.agent.enabled=true

  1. Hawkular Services should be starting, and soon you should be able to access: http://localhost:8080 to get confirmation that all the services are running

Status page
Figure 1. Hawkular Services Status page

Using SSL / HTTPS

If you want to enable secure communications between browsers, Hawkular servers, and agents/feeds, see Secure Communications.

redhatlogo-white

© 2016 | Hawkular is released under Apache License v2.0