Vagrant environment for OpenNMS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cookbooks
.gitignore
.gitmodules
LICENSE
README.md
Vagrantfile

README.md

vagrant-opennms

Vagrant provides a good environment for testing, debugging OpenNMS. It can also provide you an environment to migrate your configuration to newer versions or test new functionalities from feature branches and future versions. The Vagrant box of OpenNMS requires the following:

Hint: If you want to use Microsoft based operating system, please make sure you use Git under cygwin like http://msysgit.github.io. You will have issues with different line break handling between *NIX and Windows.

By default the virtual machine uses a no-worry-NAT network interface. To give you access to the virtual machine there is some preconfigured port forwarding:

  • TCP guest 8980 to your host 8980 for the OpenNMS WebUI
  • TCP guest 8001 to your host 8001 JPDA debugging support
  • TCP guest 22 to your host 2222 for SSH access you can also just run vagrant ssh

Usage

  1. Install VirtualBox and Vagrant on your computer
  2. Checkout this repository with git clone https://github.com/opennms-forge/vagrant-opennms.git
  3. Change into vagrant-opennms
  4. Update cookbook dependencies with git submodule init and then git submodule update --remote
  5. Run vagrant up to start the virtual machine
  6. Connect in your browser to http://localhost:8980
  7. Username is vagrant with password vagrant you can get root access with sudo -i

Under the hood

The Vagrantfile allows you to control the behavior of your virtual machine. On first run Vagrant will download a Vagrant basebox based on a minimal Centos 6.5. from the following location: http://mirror.informatik.hs-fulda.de/pub/vagrant/CentOS-6-x86_64-minimal.box

Based on this machine a setup of OpenNMS will be executed through Chef recipes. The OpenNMS depends on the following receipes:

  • postgresql::server
  • apt
  • build-essential
  • openssl
  • java

What does the recipe:opennms:

  • Installing Java environment
  • Install a preconfigured opennms-datasources.xml with authentication
  • Install preconfigured opennms.conf
  • Configure Java environment for OpenNMS with runjava -s
  • Install OpenNMS database schema and libraries with install -dis
  • Start opennms and add to runlevel for automatic start on boot

Customization through Vagrantfile

It is possible to change some parameter through the Vagrantfile.

  • postgresql.password.postgres: initialize the password by default to opennms_pg. If you change the password, the opennms-datasources.xml will also be changed
  • opennms.release: Install OpenNMS as current stable release. You can change to testing,snapshot, unstable, bleeding or branches/{branchname}. With branches you can install feature branches which can be find in http://yum.opennms.org/branches
  • opennms.jpda: allows to open the Java Remote debugging port to the JVM. You can connect with your IDE for example debugging issues
  • opennms.home has to be set for Ubuntu to /usr/share/opennms and for CentOS to /opt/opennms

The following example configures, CentOS with Oracle JDK instead of OpenJDK and uses the european mirror for the OpenNMS repository. It switches also from JRobin to RRDtool. The setting storeByForeignSource is enabled and RRD data is stored in $OPENNMS_HOME/share/rrd/snmp/fs/foreignid instead of the internal node id.

# Use the centos-7.0 base image
config.vm.box = "centos-7.0"

chef.json = {
  :"java" => {
    :"install_flavor" => "oracle",
    :"jdk_version" => "7",
    :"oracle" => {
      "accept_oracle_download_terms" => true
    }
  },
  :"postgresql" => {
    :"password" => {
      :"postgres" => "opennms_pg"
    }
  },
  :"opennms" => {
    :"release" => "stable", #stable, testing, unstable, snapshot, bleeding
    :"jpda" => "false",
    :"home" => "/opt/opennms",
    :"java_heap_space" => "1024",
    :"repository" => {
      :"yum" => "yum.opennms.eu"
    },
    :"library" => {
      :"jrrd" => "/usr/lib/jni/libjrrd.so"
    },
    :"rrd" => {
      :"strategyClass" => "org.opennms.netmgt.rrd.rrdtool.JniRrdStrategy",
      :"interfaceJar" => "/usr/share/java/jrrd.jar"
    },
    :"storeByForeignSource" => "true"
  }
}