Skip to content

Commit

Permalink
DP-82: Add meta descriptions to each page in the reference guide
Browse files Browse the repository at this point in the history
DP-82: Add meta descriptions to each page in the reference guide - added meta descriptions to each page in the reference, troubleshooting, and write the docs section of the docs. Also updated the opennms full stack architecture diagram in the intro to the core docs.
  • Loading branch information
Bonrob2 committed Nov 22, 2023
1 parent ddfcb12 commit 8785e6d
Show file tree
Hide file tree
Showing 161 changed files with 161 additions and 149 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[core-docker]]
= Core Docker
:description: Learn about startup arguments and environment variables for the Docker with the {page-component-title} core.
:description: Learn about startup arguments and environment variables for the Docker with the OpenNMS {page-component-title} core.

== Startup arguments

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[file-editor]]
= File Editor
:description: Learn how to use the File Editor in {page-component-title} to view and edit configuration (.xml, .cfg, etc.) files through the UI.
:description: Learn how to use the File Editor in OpenNMS {page-component-title} to view and edit configuration (.xml, .cfg, etc.) files through the UI.

The File Editor page lets you view and edit configuration files (`.xml`, `.cfg`, `.drl`, and so on) in the {page-component-title} UI instead of having to edit them in your local file system (for example, by locating the file in your `/etc` directory and editing it with a text editor).
To access the file editor, log in to the web UI and click menu:Info[File Editor] in the top menu bar.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[filter-components]]
= OpenNMS components that use filters
:description: Get a list of the {page-component-title} components that use filters/rules: notfifd, collectd, pollerd, threshd, and the web UI.
:description: Get a list of the OpenNMS {page-component-title} components that use filters/rules: notfifd, collectd, pollerd, threshd, and the web UI.

== notifd

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[filters]]
= Filters
:description: Learn about the database schema file in {page-component-title} and how to use filters (rules) to select IP addresses from the ipinterface table.
:description: Learn about the database schema file in OpenNMS {page-component-title} and how to use filters (rules) to select IP addresses from the ipinterface table.

A filter (also known as a rule) is a shorthand expression that allows you to select IP addresses from the ipinterface table.
The rule builds the WHERE clause of a SQL query.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[filter-parameters]]
= Parameters
:description: View a list of filter/rule parameters, grouped by component, in {page-component-title}.
:description: View a list of filter/rule parameters, grouped by component, in OpenNMS {page-component-title}.

This is a partial list of rule parameters, grouped by component.
You can add parameters not available in `database-schema.xml` for use in filter expressions as long as you follow the existing database table hierarchy.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[filter-rule-format]]
= Rule formats
:description: View the formats for filters/rules in {page-component-title}: CDATA construct, GUI construct, and catinc.
:description: View the formats for filters/rules in OpenNMS {page-component-title}: CDATA construct, GUI construct, and catinc.

There are at least two formats for these rules in xml (GUI format follows).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[install-jdbc-driver-core]]
= Install JDBC Driver on {page-component-title} Core
:description: Learn how to install a JDBC driver in {page-component-title} to detect, poll, or collect on JDBC services.
:description: Learn how to install a JDBC driver in OpenNMS {page-component-title} to detect, poll, or collect on JDBC services.

To detect, poll, or collect any JDBC service, you must install the appropriate JDBC driver.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[jmx-exporter]]
= Prometheus JMX exporter
:description: Learn how to set up out-of-band monitoring of the Java virtual machine (JVM) with the Minion process in {page-component-title}.
:description: Learn how to set up out-of-band monitoring of the Java virtual machine (JVM) with the Minion process in OpenNMS {page-component-title}.

To provide an out-of-band monitoring of the JVM with the Minion process, this container image ships with the Prometheus JMX exporter.
The default configuration, which you can edit, appears in the `minion-config.yaml` file:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[minion-confd]]
= Configuring Minion via confd
:description: Learn how to configure the Minion via confd in {page-component-title}: mount, YAML file contents, Kafka sink, and so on.
:description: Learn how to configure the Minion via confd in OpenNMS {page-component-title}: mount, YAML file contents, Kafka sink, and so on.

For information on testing confd templates, see xref:configuration/minion-confd/test-confd.adoc#confd-template-test[Test confd templates].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[confd-template-test]]
= Test confd Templates
:description: Learn how to test confd template changes locally using a Minion Docker container in {page-component-title}.
:description: Learn how to test confd template changes locally using a Minion Docker container in OpenNMS {page-component-title}.

To locally test `confd` template changes, run a Minion container and map the corresponding files into the container.
The following procedure, which requires a Minion Docker container, might be useful:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[minion-docker]]
= Minion Docker
:description: Learn about startup arguments and environment variables for the Docker with the {page-component-title} Minion.
:description: Learn about startup arguments and environment variables for the Docker with the OpenNMS {page-component-title} Minion.

== Startup arguments

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[receive-snmp-traps]]
= Receive SNMP traps/informs
:description: Learn about how to configure a policy that allows {page-component-title} to bind to the ICMP service with SELinux enabled on your OpenNMS server.
:description: Learn about how to configure a policy that lets OpenNMS {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server.

{page-component-title} lets you receive and process SNMP traps and informs out of the box.
The {page-component-title} services run as an unprivileged user and cannot bind on port numbers below `1024` without escalated privileges.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/reference/pages/configuration/selinux.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[selinux-icmp]]
= SELinux and ICMP permissions
:description: Learn how to configure a policy that lets {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server.
:description: Learn how to configure a policy that lets OpenNMS {page-component-title} bind to the ICMP service with SELinux enabled on your OpenNMS server.

If you have SELinux enabled on your {page-component-title} server, you must also configure a policy that allows {page-component-title} to bind to the ICMP service.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Sentinel Features
:description: Discover some of the Sentinel features you can install manually in {page-component-title}: core, Java Message Service (JMS), Kafka, flows, and so on.
:description: Discover some of the Sentinel features you can install manually in OpenNMS {page-component-title}: core, Java Message Service (JMS), Kafka, flows, and so on.

The following list contains some features which may be installed manually:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/reference/pages/configuration/ttl-rpc.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Time to Live (TTL) for RPCs
:description: Learn about time-to-live (TTL) with remote procedure calls (RPCs) in {page-component-title}: global, pollerd, collectd, provisiond, and so on.
:description: Learn about time-to-live (TTL) with remote procedure calls (RPCs) in OpenNMS {page-component-title}: global, pollerd, collectd, provisiond, and so on.

Remote procedure calls (RPCs) between {page-component-title} Core and Minion include a time limit which, if exceeded, aborts the requests and discards any subsequent responses.
We call this limit the time-to-live or TTL.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Tuning ActiveMQ
:description: Learn about default ActiveMQ settings in {page-component-title} and how to change them for better performance.
:description: Learn about default ActiveMQ settings in OpenNMS {page-component-title} and how to change them for better performance.

The settings for the embedded ActiveMQ broker are found in `$\{OPENNMS_HOME}/etc/opennms-activemq.xml`.
Memory and storage limits are conservative by default and should be tuned to accommodate your workload.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Tuning Apache Kafka
:description: Learn about default Kafka settings in {page-component-title} and how to change them to meet your system requirements, including multi-tenancy.
:description: Learn about default Kafka settings in OpenNMS {page-component-title} and how to change them to meet your system requirements, including multi-tenancy.

The configuration is shipped with some defaults, but depending on the size and network topology you might need to tune the Apache Kafka environment to meet certain needs.
Set Apache Kafka options directly in the `org.opennms.core.ipc.rpc.kafka.cfg` and `org.opennms.core.ipc.sink.kafka.cfg` file.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-event-translate]]
= Event Translator
:description: Learn about the event translator, which transforms and enhances the data from {page-component-title} events that other daemons generate.
:description: Learn about the event translator, which transforms and enhances the data from OpenNMS {page-component-title} events that other daemons generate.

The event translator transforms and enhances the data from {page-component-title} events that other daemons generate.
It enables better integration with external systems, based on data from sources internal and external to {page-component-title}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-config-files-eventd]]
= Eventd
:description: Learn about eventd, a core {page-component-title} process that generates events.
:description: Learn about eventd, a core OpenNMS {page-component-title} process that generates events.

Core {page-component-title} process that generates xref:operation:deep-dive/events/introduction.adoc[events].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-config-files-jettyserver]]
= JettyServer
:description: Learn about the JettyServer in {page-component-title}, which provides and manages the web user interface service.
:description: Learn about the JettyServer in OpenNMS {page-component-title}, which provides and manages the web user interface service.

Provides and manages the web user interface service.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-config-files-karaf]]
= Karaf
:description: Learn about the Karaf daemon, which is the core runtime module that manages all other daemon services within the {page-component-title} system.
:description: Learn about the Karaf daemon, which is the core runtime module that manages all other daemon services within the OpenNMS {page-component-title} system.

The core runtime module that manages all other daemon services running within the {page-component-title} system.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-config-files-karafstartupmonitor]]
= KarafStartupMonitor
:description: Learn about the {page-component-title} KarafStartupMonitor, which tracks issues with starting the core Karaf runtime.
:description: Learn about the OpenNMS {page-component-title} KarafStartupMonitor, which tracks issues with starting the core Karaf runtime.

Tracks issues with starting the core xref:reference:daemons/daemon-config-files/karaf.adoc[Karaf] runtime.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ref-daemon-config-files-notifd]]
= Notifd
:description: Learn about notifd in {page-component-title}, which generates notifications to system operators for desired events.
:description: Learn about notifd in OpenNMS {page-component-title}, which generates notifications to system operators for desired events.

Generates xref:operation:deep-dive/notifications/introduction.adoc[notifications] to system operators for desired events.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= SnmpCollector
:description: Learn how to configure the SNMPCollector in {page-component-title} to collect performance data through SNMP.
:description: Learn how to configure the SNMPCollector in OpenNMS {page-component-title} to collect performance data through SNMP.

The SnmpCollector collects performance data through SNMP.
Configure credentials to access SNMP agents in the Web UI (*Admin>Configure SNMP Community Names by IP Address*).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= HttpCollector
:description: Learn how to configure and use the HttpCollector in {page-component-title} to collect performance data via HTTP and HTTPS.
:description: Learn how to configure and use the HttpCollector in OpenNMS {page-component-title} to collect performance data via HTTP and HTTPS.

The HttpCollector collects performance data via HTTP and HTTPS.
Attributes are extracted from the HTTP responses using a regular expression.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= JDBC Collector
:description: Learn how to configure and use the JDBCCollector in {page-component-title} to collect performance data via JDBC drivers.
:description: Learn how to configure and use the JDBCCollector in OpenNMS {page-component-title} to collect performance data via JDBC drivers.

The JDBCCollector collects performance data via JDBC drivers.
Attributes are retrieved using SQL queries.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

= JmxCollector

:description: Learn how to configure and use the JmxCollector in {page-component-title} to collect performance data via Java Management Extensions (JMX).
:description: Learn how to configure and use the JmxCollector in OpenNMS {page-component-title} to collect performance data via Java Management Extensions (JMX).

The JmxCollector collects performance data via Java Management Extensions (JMX).
Attributes are extracted from the available MBeans.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= NSClientCollector
:description: Learn how to configure and use the NSClientCollector in {page-component-title} to collect performance data over HTTP from NSClient.
:description: Learn how to configure and use the NSClientCollector in OpenNMS {page-component-title} to collect performance data over HTTP from NSClient.

The NSClientCollector collects performance data over HTTP from NSClient.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ga-performance-mgmt-collectors-prometheus-collector]]
= PrometheusCollector
:description: Learn how to configure the PrometheusCollector in {page-component-title} to collect performance data via HTTP(S) using the Prometheus Exposition format.
:description: Learn how to configure the PrometheusCollector in OpenNMS {page-component-title} to collect performance data via HTTP(S) using the Prometheus Exposition format.

The PrometheusCollector collects performance metrics via HTTP(S) using the text-based https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format[Prometheus Exposition format].
Many applications have adopted it and it is in the process of being standardized in the https://openmetrics.io/[OpenMetrics] project.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= TcaCollector
:description: Learn how to configure the TcaCollector in {page-component-title} to collect special SNMP data from Juniper TCA devices.
:description: Learn how to configure the TcaCollector in OpenNMS {page-component-title} to collect special SNMP data from Juniper TCA devices.

The TcaCollector collects special SNMP data from Juniper TCA devices.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= VmwareCimCollector
:description: Learn how to configure the VmwareCimCollector in {page-component-title} to collect ESXi host and sensor metrics from vCenter.
:description: Learn how to configure the VmwareCimCollector in OpenNMS {page-component-title} to collect ESXi host and sensor metrics from vCenter.

The VmwareCimCollector collects ESXi host and sensor metrics from vCenter.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= VmwareCollector
:description: Learn how to configure the VmwareCollector in {page-component-title} to collect performance metrics from managed entities from vCenter.
:description: Learn how to configure the VmwareCollector in OpenNMS {page-component-title} to collect performance metrics from managed entities from vCenter.

The VmwareCollector collects performance metrics for managed entities from vCenter.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= WmiCollector
:description: Configure the WmiCollector in {page-component-title} to collect performance metrics from Windows systems using Windows Management Instrumentation (WMI).
:description: Configure the WmiCollector in OpenNMS {page-component-title} to collect performance metrics from Windows systems using Windows Management Instrumentation (WMI).

The WmiCollector collects performance metrics from Windows systems using Windows Management Instrumentation (WMI).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[[ga-performance-mgmt-collectors-wsman-collector]]
= WsManCollector
:description: Learn how to configure the WsManCollector in {page-component-title} to collect performance metrics using the Web Services-Management protocol.
:description: Learn how to configure the WsManCollector in OpenNMS {page-component-title} to collect performance metrics using the Web Services-Management protocol.

The WsManCollector collects performance metrics using the Web Services-Management (WS-Management) protocol.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

= XmlCollector
:description: Learn how to configure the XmlCollector in {page-component-title} to collect and extract metrics from XML and JSON documents.
:description: Learn how to configure the XmlCollector in OpenNMS {page-component-title} to collect and extract metrics from XML and JSON documents.

The XmlCollector collects and extracts metrics from XML and JSON documents.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[ref-performance-data-collectors]]
= Collectors
:description: Overview of official documentation for collectors in {page-component-title}.
:description: Overview of official documentation for collectors in OpenNMS {page-component-title}.

This section describes all available built-in xref:operation:deep-dive/performance-data-collection/introduction.adoc[performance data collectors].
You can configure them to allow complex monitoring to meet the needs of your environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[adapter-ddns]]
= Dynamic DNS
:description: Learn how the DDNS adapter uses the dynamic DNS protocol to send updated A/AAAA DNS records to your DNS system when {page-component-title} provisions nodes.
:description: Learn how the DDNS adapter uses the dynamic DNS protocol to send updated DNS records to your DNS system when OpenNMS {page-component-title} provisions nodes.

The DDNS adapter uses the dynamic DNS protocol to send updated A/AAAA DNS records to your DNS system as nodes are provisioned into {page-component-title}.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[adapter-geoip]]
= GeoIP
:description: Learn how the GeoIP provisioning adapter in {page-component-title} enriches node asset data with location information.
:description: Learn how the GeoIP provisioning adapter in OpenNMS {page-component-title} enriches node asset data with location information.

Use the GeoIP Provisioning Adapter to enrich a node's asset data with location information.
It uses the GeoIP2 Databases from MaxMind to look up longitude/latitude values for a given IP address.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[hardware-inventory]]
= Hardware Inventory
:description: Learn how to configure {page-component-title} to import Entity-MIB information from SNMP agents and enrich node data.
:description: Learn how to configure OpenNMS {page-component-title} to import Entity-MIB information from SNMP agents and enrich node data.

{page-component-title} can be extended to import Entity-MIB information from SNMP agents to enrich node data.
There are two types of Entity-MIBs.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[adapters]]
= Adapters
:description: Overview of provisioning adapters section in the {page-component-title} documentation: requisition node enrichment.
:description: Overview of provisioning adapters section in the OpenNMS {page-component-title} documentation: requisition node enrichment.

The {page-component-title} Provisiond API supports xref:operation:deep-dive/provisioning/introduction.adoc[provisioning] adapters (plugins) for integration with external systems during the provisioning import phase.
These adapters let OpenNMS exchange data with other systems, allowing the enrichment of node data.
Loading

0 comments on commit 8785e6d

Please sign in to comment.