Merge pull request #6376 from OpenNMS/jira/DP-64b

DP-64: Add meta descriptions to each page in the operation guide.
OpenNMS · Jul 20, 2023 · 5028987 · 5028987
2 parents fabfce1 + a41c026
commit 5028987
Show file tree

Hide file tree

Showing 41 changed files with 41 additions and 0 deletions.
diff --git a/docs/modules/operation/pages/deep-dive/alarm-correlation/situation-feedback.adoc b/docs/modules/operation/pages/deep-dive/alarm-correlation/situation-feedback.adoc
@@ -1,5 +1,6 @@
 
 = Alarm Correlation
+:description: How to configure OpenNMS Horizon/Meridian to provide real-time feedback on alarm correlation.
 
 This section describes how to configure {page-component-title} to provide real-time feedback on alarm correlation.
 

diff --git a/docs/modules/operation/pages/deep-dive/alarms/alarm-advanced-search.adoc b/docs/modules/operation/pages/deep-dive/alarms/alarm-advanced-search.adoc
@@ -1,5 +1,6 @@
 
 = Advanced Alarm Search
+:description: List and description of search criteria in OpenNMS Horizon/Meridian for advance alarm searches.
 
 When searching your environment's alarms list, you may want to customize your query to narrow your search.
 The {page-component-title} Alarm List page has a button to filter your searches based on different criteria:

diff --git a/docs/modules/operation/pages/deep-dive/alarms/alarm-example.adoc b/docs/modules/operation/pages/deep-dive/alarms/alarm-example.adoc
@@ -1,5 +1,6 @@
 
 = Alarm Lifecycle
+:description: Example of alarm lifecycle and lifetime rules in OpenNMS Horizon/Meridian.
 
 The following is an example of the alarm lifecycle based on a `nodeLostService` event.
 

diff --git a/docs/modules/operation/pages/deep-dive/alarms/alarm-handling.adoc b/docs/modules/operation/pages/deep-dive/alarms/alarm-handling.adoc
@@ -1,5 +1,6 @@
 
 = Alarm Handling
+:description: Ways to manage alarms in OpenNMS Horizon/Meridian: acknowledgement, clearing, escalation, related events, alarm note, and advanced alarm handling.
 
 The following are ways you can interact with alarms.
 

diff --git a/docs/modules/operation/pages/deep-dive/alarms/alarm-sound-flash.adoc b/docs/modules/operation/pages/deep-dive/alarms/alarm-sound-flash.adoc
@@ -1,5 +1,6 @@
 
 = Alarm Sounds
+:description: How to configure OpenNMS Horizon/Meridian to generate sounds for alarms.
 
 In certain situations, you may want an audible indication of a change in alarm state.
 The Alarms List page has the optional ability to generate a sound either when new alarms are created, or on each change to an alarm event count on the page.

diff --git a/docs/modules/operation/pages/deep-dive/alarms/configuring-alarms.adoc b/docs/modules/operation/pages/deep-dive/alarms/configuring-alarms.adoc
@@ -1,5 +1,6 @@
 [[ga-configure-alarms]]
 = Configure Alarms
+:description: Configuring alarms in OpenNMS Horizon/Meridian including attributes and elements like reduction key, alarm type, and clear key attribute.
 
 Because alarmd instantiates alarms from events, defining alarms in {page-component-title} involves defining an additional event XML element that indicates a problem or resolution in the network.
 This is the `alarm-data` element.

diff --git a/docs/modules/operation/pages/deep-dive/alarms/history.adoc b/docs/modules/operation/pages/deep-dive/alarms/history.adoc
@@ -1,6 +1,7 @@
 
 [[ga-alarm-history]]
 = Alarm History
+:description: How to keep a historical record of alarms in OpenNMS Horizon/Meridian using the alarm history feature: indexing, alarm document fields, and properties.
 
 Alarms are deleted from the {page-component-title} database as they clear or become stale.
 If you would like to keep an historical record of alarm data, you can enable the alarm history feature to provide long-term storage and maintain a history of alarm state changes in Elasticsearch.

diff --git a/docs/modules/operation/pages/deep-dive/alarms/ifttt-integration.adoc b/docs/modules/operation/pages/deep-dive/alarms/ifttt-integration.adoc
@@ -1,5 +1,6 @@
 
 = IFTTT Integration
+:description: How to integrate the IFTTT service with OpenNMS Horizon/Meridian to combine web applications and trigger actions of other services.
 
 The IFTTT service lets you combine web applications using simple conditional instructions.
 Each supported service has several triggers that you can use to trigger the actions of other services.

diff --git a/docs/modules/operation/pages/deep-dive/alarms/introduction.adoc b/docs/modules/operation/pages/deep-dive/alarms/introduction.adoc
@@ -1,5 +1,6 @@
 
 = Alarms
+:description: Overview of alarms in OpenNMS Horizon/Meridian for fault management information.
 
 {page-component-title} uses a network's managed entities, their resources, the services they provide, and any applications that they host to monitor problem states.
 

diff --git a/docs/modules/operation/pages/deep-dive/bsm/business-service-definition.adoc b/docs/modules/operation/pages/deep-dive/bsm/business-service-definition.adoc
@@ -1,5 +1,6 @@
 
 = Business Service Definition
+:description: Overview business service definitions in OpenNMS Horizon/Meridian.
 
 The status of service monitors and any kind of alarm can be used to drive the operational status of a business service.
 A business service is defined with the following components:

diff --git a/docs/modules/operation/pages/deep-dive/bsm/business-service-map.adoc b/docs/modules/operation/pages/deep-dive/bsm/business-service-map.adoc
@@ -1,5 +1,6 @@
 
 = Business Service Topology
+:description: How the topology map in OpenNMS Horizon/Meridian lets you view business service hierarchies: simulation mode, edit icons, and sharing.
 
 Business services can depend on each other.
 Together, they build a business service hierarchy.

diff --git a/docs/modules/operation/pages/deep-dive/bsm/edges.adoc b/docs/modules/operation/pages/deep-dive/bsm/edges.adoc
@@ -1,6 +1,7 @@
 
 [[gu-bsm-edges]]
 = Edges
+:description: How to use edges to map alarm status monitoring with OpenNMS Horizon/Meridian: child service, IP service, reduction key, and application.
 
 Edges map the alarm status monitoring with OpenNMS.
 

diff --git a/docs/modules/operation/pages/deep-dive/bsm/introduction.adoc b/docs/modules/operation/pages/deep-dive/bsm/introduction.adoc
@@ -1,6 +1,7 @@
 
 [[ga-bsm-introduction]]
 = Business Service Monitoring
+:description: How to monitor high-level business service contexts with OpenNMS Horizon/Meridian to identify the most critical problems affecting them.
 
 While {page-component-title} detects issues in your network by device, interface, or service, Business Service Monitoring takes it one step further.
 With this feature, you can monitor high-level business service contexts around {page-component-title}'s technical service monitors, and quickly identify the most critical problems affecting them.

diff --git a/docs/modules/operation/pages/deep-dive/bsm/map-functions.adoc b/docs/modules/operation/pages/deep-dive/bsm/map-functions.adoc
@@ -1,5 +1,6 @@
 
 = Map Functions
+:description: Overview of map functions in OpenNMS Horizon/Meridian to use the severity of an edge in the parent system's reduce function.
 
 The map function defines how to use the severity of an edge in the parent system's reduce function when {page-component-title} calculates the operational status of the business service.
 

diff --git a/docs/modules/operation/pages/deep-dive/bsm/operational-status.adoc b/docs/modules/operation/pages/deep-dive/bsm/operational-status.adoc
@@ -1,5 +1,6 @@
 
 = Operational Status
+:description: Overview of business service operational status in OpenNMS Horizon/Meridian.
 
 Every business service maintains an operational status that represents its overall status.
 The overall status is calculated from the edges, using the map and reduce functions, and uses the <<deep-dive/events/event-configuration.adoc#severities, severities>> from associated events and alarms.

diff --git a/docs/modules/operation/pages/deep-dive/bsm/reduce-functions.adoc b/docs/modules/operation/pages/deep-dive/bsm/reduce-functions.adoc
@@ -1,5 +1,6 @@
 
 = Reduce Functions
+:description: Overview of reduce functions in OpenNMS Horizon/Meridian to use alarm severity information to aggregate business service operational status.
 
 A reduce function uses alarm severity information from the edges to aggregate the operational status for a business service.
 

diff --git a/docs/modules/operation/pages/deep-dive/bsm/root-cause-impact-analysis.adoc b/docs/modules/operation/pages/deep-dive/bsm/root-cause-impact-analysis.adoc
@@ -1,5 +1,6 @@
 
 = Root Cause and Impact Analysis
+:description: Overview of root cause operation in OpenNMS Horizon/Meridian to identify underlying reduction keys of edges.
 
 The root cause operation can quickly identify the underlying reduction keys of edges that contribute to an element's current operational status.
 The impact analysis operation identifies all business services that are affected by a given element.

diff --git a/docs/modules/operation/pages/deep-dive/events/event-advanced-search.adoc b/docs/modules/operation/pages/deep-dive/events/event-advanced-search.adoc
@@ -1,5 +1,6 @@
 
 = Advanced Event Search
+:description: List and definitions of criteria you can use in advanced event searches in OpenNMS Horizon/Meridian.
 
 When searching your environment's events list, you may want to customize your query to narrow your search.
 The {page-component-title} Event Detail page has a button to filter your searches based on different criteria:

diff --git a/docs/modules/operation/pages/deep-dive/events/event-configuration.adoc b/docs/modules/operation/pages/deep-dive/events/event-configuration.adoc
@@ -1,5 +1,6 @@
 
 = Event Daemon Configuration
+:description: How to configure the event daemon in OpenNMS Horizon/Meridian: parameters, severities, event reload configuration.
 
 The back-end configuration surrounding events is split into two areas: the configuration of eventd itself, and the configuration of events definitions known to {page-component-title}.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/event-debugging.adoc b/docs/modules/operation/pages/deep-dive/events/event-debugging.adoc
@@ -1,5 +1,6 @@
 
 = Event Troubleshooting
+:description: How to troubleshoot events in OpenNMS Horizon/Meridian: debugging, manually send events, Karaf shell.
 
 This section describes how to troubleshoot events in {page-component-title}.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/event-definition.adoc b/docs/modules/operation/pages/deep-dive/events/event-definition.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-event-definition]]
 = Event Definition
+:description: How to associate and event with an existing node in OpenNMS Horizon/Meridian, and descriptions of mandatory fields.
 
 == Associate an event to a specific node
 

diff --git a/docs/modules/operation/pages/deep-dive/events/event-sources.adoc b/docs/modules/operation/pages/deep-dive/events/event-sources.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-sources-of-events]]
 = Sources of Events
+:description: Overview of where events originate in OpenNMS Horizon/Meridian.
 
 Events may originate within {page-component-title} itself or from outside.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/event-tokens.adoc b/docs/modules/operation/pages/deep-dive/events/event-tokens.adoc
@@ -1,5 +1,6 @@
 
 = Replacement Tokens
+:description: List of replacement tokens you can use in OpenNMS Horizon/Meridian to insert relevant information into events. Includes hardware and parameter tokens.
 
 You can use replacement tokens (event substitution tokens) to insert additional relevant information into event descriptions, log messages, operator instructions, and automatic actions.
 The tokens are replaced by values from the event when its text is generated.

diff --git a/docs/modules/operation/pages/deep-dive/events/event-translator.adoc b/docs/modules/operation/pages/deep-dive/events/event-translator.adoc
@@ -1,4 +1,5 @@
 = Event Translator
+:description: Overview and examples of event translator in OpenNMS Horizon/Meridian, which transforms and enhances data from events that other daemons generate.
 
 The Event Translator can transform and enhance the data from {page-component-title} events that other daemons generate.
 This feature enables better integration with external systems, based on data from sources internal and external to {page-component-title}.

diff --git a/docs/modules/operation/pages/deep-dive/events/introduction.adoc b/docs/modules/operation/pages/deep-dive/events/introduction.adoc
@@ -1,6 +1,7 @@
 
 [[events]]
 = Events
+:description: Overview of events (structured historical records of things in OpenNMS Horizon/Meridian), event definition files and the event bus.
 
 Events are structured historical records of things that happen in {page-component-title} and the nodes, interfaces, and services it monitors.
 Events are central to the operation of the {page-component-title} platform, so it's critical to have a firm grasp of this topic.

diff --git a/docs/modules/operation/pages/deep-dive/events/perf-data.adoc b/docs/modules/operation/pages/deep-dive/events/perf-data.adoc
@@ -1,4 +1,5 @@
 = SNMP Trap Performance Data
+:description: Persist performance data from SNMP traps in OpenNMS Horizon/Meridian, including example configurations, resource types, and graphing.
 
 The `opennms-events-collector` feature lets you persist performance data from SNMP traps as time-series data.
 Unlike SNMP collection where you can define data types, SNMP traps always embed values as strings.

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/eif-adapter.adoc b/docs/modules/operation/pages/deep-dive/events/sources/eif-adapter.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-sources-eif]]
 = IBM Tivoli Event Integration Facility
+:description: How to configure OpenNMS Horizon/Meridian to receive events sent using the Tivoli Event Integration Facility (EIF). Includes troubleshooting.
 
 You can configure {page-component-title} to receive events sent using the https://www.ibm.com/docs/en/netcoolomnibus/8.1?topic=reference-overview-tivoli-event-integration-facility[Tivoli Event Integration Facility].
 These EIF events are translated into {page-component-title} events using preconfigured rules.

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/kafka.adoc b/docs/modules/operation/pages/deep-dive/events/sources/kafka.adoc
@@ -2,6 +2,7 @@
 [[ga-events-sources-kafka]]
 
 = Kafka Consumer (Events)
+:description: How to ingest events into OpenNMS Horizon/Meridian by consuming a specified Kafka topic.
 
 You can also create events by routing them to a specific topic on Kafka.
 The Kafka Consumer feature allows events to be consumed from a specific topic on Kafka.

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/rest.adoc b/docs/modules/operation/pages/deep-dive/events/sources/rest.adoc
@@ -1,5 +1,6 @@
 
 [[ga-events-sources-rest]]
 = REST
+:description: Overview of posting events in XML format to the REST API events endpoint in OpenNMS Horizon/Meridian.
 
 Posting an event in XML format to the xref:development:rest/events.adoc#posts-adding-data[Events endpoint] in the {page-component-title} REST API will create a corresponding event, just as with the XML-TCP interface.
diff --git a/docs/modules/operation/pages/deep-dive/events/sources/sink-api.adoc b/docs/modules/operation/pages/deep-dive/events/sources/sink-api.adoc
@@ -2,6 +2,7 @@
 [[ga-events-sources-sink-api]]
 
 = Sink
+:description: How to use OpenNMS sink to route events to a specific topic on Kafka/ActiveMQ in Horizon/Meridian.
 
 Events can also be created by routing them to a specific topic on Kafka/ActiveMQ.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/snmp-traps.adoc b/docs/modules/operation/pages/deep-dive/events/sources/snmp-traps.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-sources-snmp-traps]]
 = SNMP Traps
+:description: All about events and SNMP traps in OpenNMS Horizon/Meridian: definitions, parm replacement token, varbinds, and traps forwarded by proxy.
 
 {page-component-title} can receive and process SNMP traps/informs from SNMP-capable devices out of the box.
 It receives SNMP traps via the xref:reference:daemons/daemon-config-files/trapd.adoc[trapd service daemon], which is enabled by default.

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/syslog.adoc b/docs/modules/operation/pages/deep-dive/events/sources/syslog.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-sources-syslog]]
 = Syslog Messages
+:description: All about events and syslog messages in OpenNMS Horizon/Meridian: parsers and RadixTreeSyslogParser parameters and tokens.
 
 Syslog messages sent over the network to {page-component-title} can be transformed into events according to preconfigured rules.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/tl1.adoc b/docs/modules/operation/pages/deep-dive/events/sources/tl1.adoc
@@ -1,6 +1,7 @@
 
 [[ga-events-sources-tl1]]
 = TL1 Autonomous Messages
+:description: Overview of retrieving autonomous messages from TL1-enabled equipment in OpenNMS Horizon/Meridian.
 
 Autonomous messages can be retrieved from certain TL1-enabled equipment and transformed into events.
 

diff --git a/docs/modules/operation/pages/deep-dive/events/sources/xml-tcp.adoc b/docs/modules/operation/pages/deep-dive/events/sources/xml-tcp.adoc
@@ -1,5 +1,6 @@
 
 [[ga-events-sources-xml-tcp]]
 = XML-TCP
+:description: Create custom events in OpenNMS Horizon/Meridian by sending properly formatted XML data over a TCP socket.
 
 Any application or script can create custom events in {page-component-title} by sending properly formatted XML data over a TCP socket.
diff --git a/docs/modules/operation/pages/deep-dive/notifications/bonus-strategies.adoc b/docs/modules/operation/pages/deep-dive/notifications/bonus-strategies.adoc
@@ -2,5 +2,6 @@
 
 [[ga-notifications-bonus-strategies]]
 = Bonus Notification Methods
+:description: Overview of bonus notification methods in OpenNMS Horizon/Meridian: Mattermost and Slack.
 
 {page-component-title} includes a handful of newer notification methods that currently require manual steps to activate.
diff --git a/docs/modules/operation/pages/deep-dive/notifications/commands.adoc b/docs/modules/operation/pages/deep-dive/notifications/commands.adoc
@@ -1,5 +1,6 @@
 
 = Notification Commands
+:description: Default notification commands in OpenNMS Horizon/Meridian and how to create custom commands.
 
 A notification command is a named, reusable execution profile for a Java class or external program command used to convey notices to targets.
 {page-component-title} includes several default notification commands.

diff --git a/docs/modules/operation/pages/deep-dive/notifications/concepts.adoc b/docs/modules/operation/pages/deep-dive/notifications/concepts.adoc
@@ -1,6 +1,7 @@
 
 [[ga-notifications-concepts]]
 = Concepts
+:description: Concepts around notifications in OpenNMS Horizon/Meridian: events and UEIs, users and groups, on-call roles, duty schedules, and destination paths.
 
 This page describes core concepts related to {page-component-title} notifications.
 They ultimately combine to form an xref:operation:deep-dive/events/event-definition.adoc[Event Notification Definition].

diff --git a/docs/modules/operation/pages/deep-dive/notifications/configuration.adoc b/docs/modules/operation/pages/deep-dive/notifications/configuration.adoc
@@ -1,5 +1,6 @@
 
 = Notification Configuration
+:description: Advanced notification configuration options in OpenNMS Horizon/Meridian: configure path outages.
 
 The xref:operation:quick-start/notification-config.adoc[Configure Notifications] chapter in the Quick Start section includes basic procedures to configure and customize {page-component-title} notifications.
 This section presents more advanced notification configuration options.

diff --git a/docs/modules/operation/pages/deep-dive/notifications/introduction.adoc b/docs/modules/operation/pages/deep-dive/notifications/introduction.adoc
@@ -1,6 +1,7 @@
 
 [[ga-notifications-introduction]]
 = Notifications
+:description: Overview of notifications in OpenNMS Horizon/Meridian to alert users about events that happen in the network.
 
 {page-component-title} uses notifications to inform users about events that happen in the network.
 Notifications allow you to keep track of your network status without having to log in and look at the UI.

diff --git a/docs/modules/operation/pages/deep-dive/notifications/strategies/mattermost.adoc b/docs/modules/operation/pages/deep-dive/notifications/strategies/mattermost.adoc
@@ -1,5 +1,6 @@
 
 = Mattermost Notifications
+:description: How to use webhooks to configure OpenNMS Horizon/Meridian to send notifications through Mattermost.
 
 If your organization uses https://mattermost.com/[Mattermost], you can configure {page-component-title} to send notices to any channel via an incoming webhook.
 You must configure an incoming webhook in your Mattermost settings and manually configure some settings in your {page-component-title} instance.

diff --git a/docs/modules/operation/pages/deep-dive/notifications/strategies/slack.adoc b/docs/modules/operation/pages/deep-dive/notifications/strategies/slack.adoc
@@ -1,5 +1,6 @@
 
 = Slack Notifications
+:description: How to use webhooks to configure OpenNMS Horizon/Meridian to send notifications through Slack.
 
 If your organization uses https://slack.com/[Slack], you can configure {page-component-title} to send notices to any channel via an incoming webhook.
 You must configure an incoming webhook in your Slack settings and manually configure some settings in your {page-component-title} instance.