Overview

This guide helps migrate an existing installation of Grafana from using the OpenNMS Data Source plugin to using Helm to interface with OpenNMS.

The tutorial assumes that you have:

  • an instance of Grafana with the OpenNMS Data Source installed.

  • a data source configured with type OpenNMS, and one or more dashboards using the data source.

Installation

Both the OpenNMS Data Source plugin and Helm can be installed at the same time while you complete the migration.

If you have not already done so, you may install Helm using your prefered method. See Installing Helm for detailed instructions.

Application Setup

Once Helm is installed, you need to enable the application in Grafana to make the provided panels and data sources available:

  1. Navigate to the home page of your Grafana instance. In the top-left corner of the page, click on the Grafana icon, and then click Plugins:

    Plugins
  2. Next, navigate to the Apps tab, and click on the OpenNMS Helm application.

    If the OpenNMS Helm is application is not listed on the Apps tab, try restarting the Grafana server. If the issue persists, make sure the application is installed correctly.

  3. Enable the application by clicking on the Enable button.

    If you see a Disable button, then the application is already enabled and you can skip to the next step.

Migrating Data Sources

Once the Helm application is enabled, you can convert your existing OpenNMS data sources to use the OpenNMS Perfomance type. When switching the type, you may need to re-enter the URL and authentication details.

Helm provides two data source types. The OpenNMS Performance type is equivalent to the previous OpenNMS data source.

Verify Dashboards

Once the existing data sources have been converted to use the new OpenNMS Performance type, you should verify your existing dashboards to make sure they continue to render properly.

If you encounter any errors when switching, you can revert to the previous data source type.

Plugin Removal

Once you have verified that your dashboards continue to work with the new data source, you can remove the previous plugin.

Use the grafana-cli tool to remove the OpenNMS Data Source plugin from the commandline:

sudo grafana-cli plugins remove opennms-datasource

Restart Grafana for the plugin to be completely unregistered:

sudo service grafana-server restart