Docs section about startup configuration and opennms.conf

Description

The official docs make hardly any mention of important startup settings that are configurable via OPENNMS_HOME/etc/opennms.conf. For example JAVA_HEAP_SIZE is not mentioned at all.

Acceptance / Success Criteria

Acceptance

The admin guide includes a section documenting:

  • That the startup scripts will source OPENNMS_HOME/etc/opennms.conf early in their startup, if that file exists

  • That no opennms.conf exists in the default RPM / DEB install, but that a sample file is included in OPENNMS_HOME/etc/examples which can be used as a starting point

  • The most important variables that one might set in opennms.conf, including:

    • JAVA_HEAP_SIZE and JAVA_INITIAL_HEAP_SIZE (units are in MB; suffix m added automatically with result passed as -Xmx and -Xms flag to JVM, respectively)

    • ADDITIONAL_MANAGER_OPTIONS (appended to other JVM startup flags)

    • MAXIMUM_FILE_DESCRIPTORS (passed to ulimit -n before starting JVM)

    • MAXIMUM_SIZE_STACK_SEGMENT (passed to ulimit -s before starting JVM)

Activity

Show:

Bonnie Robinson May 25, 2023 at 4:58 PM

Merged 25/5/23.

Bonnie Robinson May 23, 2023 at 7:44 PM

Fixed

Details

Assignee

Reporter

HB Grooming Date

HB Backlog Status

Docs Needed

Yes

Original estimate

Time tracking

No time logged2h remaining

Sprint

Priority

PagerDuty

Created April 26, 2023 at 6:22 PM
Updated June 13, 2023 at 2:22 PM
Resolved May 25, 2023 at 4:58 PM

Flag notifications