Basic Installation

Before installing OpenNMS Helm Charts, make sure your environment meets the minimum requirements.

This section describes a basic local installation on different operating systems with a Horizon Core.

Installation and configuration

To install and configure OpenNMS Helm Charts, follow these steps:

  1. Create a basic .yaml file.

    The install script requires a .yaml file that contains at least the domain name that you are using. You may also want to specify the password for the OpenNMS instance.

    On GitHub, see values.yaml for additional configuration parameters you can specify. See helm-cloud.yaml for a sample file for testing purposes.

  2. Configure your VNC with a UI.

  • Debian/Ubuntu

  • RHEL

The following shows how to configure a UI for your Debian or Ubuntu VNC.

  1. Type the following:

    sudo apt install ubuntu-desktop-minimal

  2. Install tigervnc server and avahi.

    sudo apt install tigervnc-standalone-server avahi-daemon

  3. Edit vncserver defaults file to specify resolution and any other settings.

    sudo vi /etc/tigervnc/vncserver-config-defaults

  4. Edit vncserver.users to add user to VNC.

    sudo vi /etc/tigervnc/vncserver.users

  5. Create VNC account password.

    vncpasswd

  6. Enable both vncserver for the user specified and avahi daemon.

    sudo systemctl enable --now tigervncserver@:1.service
sudo systemctl enable --now avahi-daemon

  7. Add information to the avahi daemon at /etc/avahi/services.rfb.service.

    Note that the port number must match user account :1 = 5901

    sudo vi /etc/avahi/services/rfb.servie
<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
  <name replace-wildcards="yes">%h</name>
  <service>
    <type>_rfb._tcp</type><port>5901</port>
  </service>
</service-group>

The following shows how to configure a UI for your Red Hat Rocky Alma VNC.

  1. Type the following:

    sudo dnf group install "Server with GUI"

  2. Install tigervnc server and avahi.

    sudo dnf install tigervnc-server avahi

  3. Edit vncserver defaults file to specify resolution and any other settings.

    sudo vi /etc/tigervnc/vncserver-config-defaults

  4. Edit vncserver.users to add user to VNC.

    sudo vi /etc/tigervnc/vncserver.users

  5. Create VNC password for the account.

    vncpasswd

  6. Enable both vncserver for the specified user and avahi daemon.

    sudo systemctl enable --now vncserver@:1.service
sudo systemctl enable --now avahi-daemon

  7. Add information to the avahi daemon at `/etc/avahi/services.rfb.service.

    Note that the port number must match user account :1 = 5901

    sudo vi /etc/avahi/services/rfb.servie
<?xml version="1.0" standalone='no'?>
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<service-group>
  <name replace-wildcards="yes">%h</name>
  <service>
    <type>_rfb._tcp</type><port>5901</port>
  </service>
</service-group>
For information on how to set up with minikube, see the following on GitHub:

Start the OpenNMS environment on your Kubernetes cluster

Locally you should run only one set. 
helm upgrade --install -f helm-cloud.yaml \
  --set domain=k8s.<your-domain-name>.net \
  --set storageClass=onms-share \
  --set ingress.certManager.clusterIssuer=opennms-issuer \
  --set-file dependencies.truststore.content=jks/truststore.jks \
  --set-file dependencies.postgresql.caCert=jks/postgresql-ca.crt \
  --set dependencies.postgresql.hostname=onms-db.shared.svc \
  --set dependencies.kafka.hostname=onms-kafka-bootstrap.shared.svc \
  --set dependencies.elasticsearch.hostname=onms-es-http.shared.svc \
  <namespace> ./horizon

Keep in mind that is only an example. Treat the content of helm-cloud.yaml as a sample for testing. Make sure to tune it properly so that you avoid overriding settings via --set.

Check the output file

When the update completes, check the output file to determine if you need to make changes. The notes.txt file illustrates sample output. The file also includes links to login to the Horizon Core and a Grafana URL.

Log in to the Horizon UI

Click on the link in the output file to log in.

Post-installation tasks

See the following topics might be useful after installation: