Horizon Quick Start Guide

As part of our goal to make our Horizon/Meridian documentation more task-based, we plan to add a “Quick Start” section to the documentation. This guide would provide clear, minimal steps to start monitoring with OpenNMS using the default configuration, or minor tweaks to the default if required. The guide assumes that users have already installed Horizon. Each section would include the following:

  • Intro/overview
  • What works by default (or minor configuration you need to do to make feature work)
  • One example of how to modify the default behaviour (TBD for each feature)
  • Link to deeper dive section in the docs that provides information on all of the types of configuration one can do with the feature

We’ve determined that these are the minimal steps required to get up and running.

  1. Login and create a user
  2. Turn on default notifications
  3. Import inventory
  4. Collect performance data
  5. Set up a threshold
  6. Establish your baseline
  7. Determine service availability
  8. Configure notifications
  9. Visualize your data

We’d love to know if we are missing anything. Also interested in examples for something users change from the default that we can include with each section/step. For example, with “collect performance data” users might want to set up performance collection for another protocol. We would include an example for how to do that within the quick start, and a link to any other performance data configuration tasks in the deep-dive section.

Proposed outline

Login and create a user

  • First-time login and data choices
  • Admin user setup (changing your password)
  • Create a user
  • Beyond quick start, you can create groups, schedules, assign user permissions, etc., link to Deep Dive section.

Turn on default notifications

  • You might want to see notifications while you are provisioning - what works by default
  • Beyond quick start, you can configure notifications, use chat client notification methods, etc., link to section later in quick start

Import inventory

  • OpenNMS provides service-level monitoring and reporting as soon as you provision managed nodes
    – Brief overview of provisioning, save details for deep-dive section
  • Configure SNMP for provisioning
  • Create requisition with default foreign source definition and policies
  • Beyond quick start, different ways to provision, fine tuning, etc., link to Deep Dive section.

Collect Performance Data

  • Short intro. on performance management - what works by default
  • Identify an example of something a user would like to do beyond the default performance management, and walk through how to set it up.
    – SUGGESTION: Set up performance collection for another protocol. (JDBC, HTTPS?)
    – SNMP Config/MIB compiler
  • Cross-reference to deep-dive section

Set up a Threshold

  • Short introduction on thresholding - what works by default
  • Keep the basic walkthrough? It provides an example and walks users through the process with that example, and walk through how to set it up.
  • Cross-reference to deep-dive section.

Establish your baseline

  • Observe the kinds of default alerts, notifications you are getting. Helps determine what is “normal” on your network.
  • Decide what you want to see and what you need to change to accomplish this.

Determine service availability

  • Short intro on service assurance - what works by default
  • Identify an example of something a user would like to do beyond the default notifications, and walk through how to set it up.
  • Cross-reference to deep-dive section

Configure notifications

  • Already turned on default notifications, this section walks through setting up a specific notification.
  • Identify an example of something a user would like to do beyond the default notifications, and walk through how to set it up.
    – SUGGESTION: Change destination path for a notification?
  • Cross-reference to deep-dive section

Visualize your data

  • Short intro to visualization of data through dashboard/reports/topology
  • Example of something user wants to see, show how to see it on dashboard, create a report
  • Cross-reference to deep-dive section