Build from Source with Docker
This section describes how to build HELM with Docker.
You can compile HELM from source with a Docker build image:
Check out the repository, compile the code, and install the plugin:
docker build -t myopennmshelmimage .
Run the image:
docker run -p 3000:3000 -t myopennmshelmimage
Log in to your HELM instance with the default admin credentials (
Navigate to Plugins and enable the OpenNMS Helm plugin.
The Grafana plugin directory location is changed from
If you want to build a HELM image based on a specific GitHub fork or branch, you can use
docker build -t mycustomforkbranch \ --build-arg OPENNMS_HELM_GIT_URL=https://github.com/OpenNMS/opennms-helm.git \ --build-arg OPENNMS_HELM_GIT_BRANCH_REF=myBranch
This creates the plugin based on the GitHub URL and branch that you provide.
Build service stack with Docker Compose
The HELM package includes an example
docker-compose.yml, which builds a service stack with a compiled Grafana OpenNMS HELM plugin that you can test.
You can modify the build arguments in
docker-compose.yml if you want to build from a specific GitHub fork, branch, or version tag.
When you first run
docker-compose up -d, the Grafana HELM plugin is compiled from the source.
Subsequent runs will use the compiled image from your local system.
If you want to rebuild the image, run
docker-compose build --no-cache.
The URL for your Horizon or Meridian datasource is
Configure Docker for PDF reports
Horizon and Meridian include templates from which you can create PDF reports. They use an existing Grafana dashboard (see Grafana Dashboard in the main OpenNMS documentation). If you want to use this feature, and you are running HELM through Docker, you must complete additional configuration. Refer to Grafana’s Remote rendering service documentation for more information.