Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Commit

Permalink
Reorder Configuration documentation for clarity
Browse files Browse the repository at this point in the history
This patch reorders the configuration documentation to improve clarity
and flow.

Signed-off-by: Justin Thaler <thalerj@us.ibm.com>
  • Loading branch information
Justin Thaler committed Nov 4, 2019
1 parent b1dd777 commit 5a57496
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/source/configuring.md
Expand Up @@ -14,13 +14,26 @@ Each property comes as a pair on the right hand side of the equals sign. The pro
• bmcHostname: This is the string that is either the BMC hostname or the BMC IP address.
• xcatNodeName: This is the hostname of the Host OS. This may also be the IP of the Host OS.
• accessType: This tells what the connection method is to the BMC. Currently accepted values are ipmi (for 9006, 5104 Machine Types) and openbmcRest for 8335-GTC and 8335-GTW systems.
# Setting up the base configuration section
## Setting up the base configuration section
This section allows the user to specify some basic controls for the ibm-crassd service.
- The maxThreads variable is used to define the number of processing threads that are used to collect, parse and forward BMC alerts to the various plugins, based on what is enabled. The current recommended setting for this variable is 40.
- The enableTelemetry option can be set to **True** to turn on telemetry streaming, or **False** to disable telemetry streaming.
- The nodesPerGathererProcess option is used to set the number of BMCs assigned to a sub-process. This can allow performance to be finely tuned for the telemetry streaming service. The default setting is 10.
- The enableDebugMsgs option can be set to True when trying to debug a difficult problem or to help find problems with initial setup. The default setting is False.

## Configuration of the Tracker File Storage Location
Configuring where to put tracker files can be found under the section of [lastReports]. This directory is also used to specify where the configuration file for ibm-crassd is located. The default location is **/opt/ibm/ras/etc**
To support multiple tracker and configuration files in the same storage location (directory), it is imperative to name the tracker and configuration files with the format **<nodewithcrassd_hostname>.ibm-crassd.config**. The ibm-crassd service places highest priority when the hostname.ibm-crassd.config file name format is used.

## Configuration of Analysis Scripts for ibm-crassd
Deep analysis of alerts is sometimes wanted or desired. The ibm-crassd service supports this behavior by allowing the creation of analysis files, and then adding configuration options for them.
To create and run analysis scripts, a few things must be done.
1. Create a python module, with the following name format analyze**alertID**.py.
2. Add a configuration option to ibm-crassd.config file under the analysis section using the following format **alertID**=**option**.
3. Configure the setting to one of the following three options.
- **clear** - This option, after a positive analysis return, will have ibm-crassd delete the alert from the BMC which surfaced it.
- **filter** - This option, will only cause ibm-crassd to filter the alert so it's not sent to the varying reporting plugins. It will leave the alert on the BMC.
- **disable** - This option will prevent the analysis script from being run, and the alert will be forwarded as normal.
# Plugin Configuration
## Configuration for integrating into ESS
1. Open the configuration file in `/var/mmfs/mmsysmon/mmsysmonitor.conf`.
Expand Down Expand Up @@ -62,17 +75,5 @@ a. For example `ESS=True`, `CSM=False`, `logstash=False`.
7. Save and close the file.
8. Start the service with `systemctl start ibm-crassd`. It is also recommended to enable the service so it starts automatically when the Host OS starts. This is done using the command `systemctl enable ibm-crassd`

# Configuration of the Tracker File Storage Location
Configuring where to put tracker files can be found under the section of [lastReports]. This directory is also used to specify where the configuration file for ibm-crassd is located. The default location is **/opt/ibm/ras/etc**
To support multiple tracker and configuration files in the same storage location (directory), it is imperative to name the tracker and configuration files with the format **<nodewithcrassd_hostname>.ibm-crassd.config**. The ibm-crassd service places highest priority when the hostname.ibm-crassd.config file name format is used.

# Configuration of Analysis Scripts for ibm-crassd
Deep analysis of alerts is sometimes wanted or desired. The ibm-crassd service supports this behavior by allowing the creation of analysis files, and then adding configuration options for them.
To create and run analysis scripts, a few things must be done.
1. Create a python module, with the following name format analyze**alertID**.py.
2. Add a configuration option to ibm-crassd.config file under the analysis section using the following format **alertID**=**option**.
3. Configure the setting to one of the following three options.
- **clear** - This option, after a positive analysis return, will have ibm-crassd delete the alert from the BMC which surfaced it.
- **filter** - This option, will only cause ibm-crassd to filter the alert so it's not sent to the varying reporting plugins. It will leave the alert on the BMC.
- **disable** - This option will prevent the analysis script from being run, and the alert will be forwarded as normal.

0 comments on commit 5a57496

Please sign in to comment.