This section explains how to install and configure a new {page-component-title} instance, including the following tasks:
-
Install all required OpenNMS {page-component-title} components, including PostgreSQL, on a single node.
-
Run {page-component-title} core and PostgreSQL with the default configuration.
NoteThe default configuration is not optimized to run in a production environment or monitor large networks. -
Sign in to the web UI and change the
adminaccount’s default password.
If you are planning a large deployment, you may need to review your DNS configuration to ensure name lookups can be processed quickly. DNS lookups may be preformed by different processes, including while provisioning new nodes and when receiving syslog messages. It is vital that DNS lookups can be performed quickly to prevent them from becoming a bottleneck, which can happen if your deployment covers thousands of nodes. One way to mitigate DNS performance is to setup your {page-component-title} as a secondary DNS server so that it is able to self-host DNS records for your network.
The following components and settings are required to set up a new {page-component-title} instance:
-
A Linux physical server, or a virtual machine running a supported Linux operating system.
-
Internet access to download the installation packages.
-
A working DNS server, and a localhost and server name that resolve properly.
-
A system user with administrative permissions (
sudo) to perform installation. -
A SELinux policy that permits binding to the ICMP service, if necessary.
NoteIf you do not include the appropriate SELinux policy, {page-component-title} may generate an ICMP permissions error when starting up (see reference:configuration/selinux.adoc).
|
Tip
|
PostgreSQL 14 and 15 use the scram-sha-256 password authentication method by default.
If you use older versions of PostgreSQL, you should change the method in postgresql.conf and in pg_hba.conf before installing the {page-component-title} core instance.
|
You must configure the PostgreSQL max_connections setting to at least twice the maximum pool size in {page-component-title}.
The default maximum pool size value in {page-component-title} is 50, but it applies to each connect in opennms-datasources.xml: opennms (the main connection used at runtime) and opennms-admin (the connection used during administrative operations, including installation).
Therefore, your max_connections setting should be at least 100.
If you change the default pool size, make sure you also update the max_connections.
You typically set this in PG_HOME/data/postgresql.conf, but you may also use the ALTER SYSTEM syntax.
You must restart the PostgreSQL server for the changes to take effect.
|
Note
|
You may find PGTune useful to calculate configuration parameters for PostgreSQL. As with all third-party tools, we do not endorse or guarantee it. Use it at your own discretion. |
- CentOS/RHEL 9
- CentOS/RHEL 8
- CentOS/RHEL 7
|
Important
|
For security reasons, {page-component-title} is designed to run within an organization’s protected intranet. Do not expose the web console or sign in pages directly to the Internet without appropriate isolation controls (for example, a VPN with multi-factor authentication). |
- CentOS/RHEL 9
- CentOS/RHEL 8
- CentOS/RHEL 7
- CentOS/RHEL 7/8/9
After you start the {page-component-title} core services, you can access the web application at http://core-instance-ip:8980/opennms.
The default user credentials are as follows:
-
Username:
admin -
Password:
admin
When you try to sign in with these credentials, {page-component-title} prompts you to change your password.
Although you also have the option to skip this action and sign in with default the credentials, we strongly recommend that you change the admin account’s password to a secure one.
-
Type your current password.
-
Type your new password and confirm it.
-
Click Change Password.
To change your account’s password after the first time you sign in, follow these steps:
-
On the top menu bar, click menu:Admin[Change Password].
-
Type your current password and new password in the appropriate fields.
-
Confirm your new password, and click Submit.
The password is updated.
We encourage you to use {page-component-title} with individual user accounts instead of using only the admin account.
If all users have individual accounts, you can see who is completing tasks (for example, clearing or acknowledging alarms).
For information on how to create personalized user accounts, see Create a new user in the Quick Start guide.
The first time you sign in, {page-component-title} notifies you that it collects anonymized usage statistics and publishes them to https://stats.opennms.com. Consent to share collected usage statistics is assumed by default.
The OpenNMS Group uses this information to help determine product use and to improve the {page-component-title} software. We do not share it with third parties, and we will not use it for sales purposes.
Click Learn More to view the information that we collect and share. This also hides the notification.
Click Dismiss to simply hide the notification. You can view the usage statistics at any time on the admin page.
|
Note
|
Admin users can opt out of sharing the statistics at any time. |
The default configuration will discover a single node with an interface 127.0.0.1 and detect services exposed on the loopback interface, including the OpenNMS-JVM service.
Nodes with this service have JMX-based data collection performed on Java JVM statistics such as heap memory and open file handles.
-
operation:deep-dive/admin/configuration/startup.adoc
-
reference:configuration/selinux.adoc
-
reference:configuration/receive-snmp-traps.adoc
-
reference:configuration/install-jdbc-driver.adoc