Integrate CA Spectrum with CA Digital Operational Intelligence Using Spectrum Data Publisher

2
casp104
2
Overview
The integration between CA Spectrum and CA Digital Operational Intelligence allows you to leverage data from CA Spectrum and helps to analyze, correlate and proactively resolve the network issues. The SpectrumDataPublisher is a utility/service in CA Spectrum that publishes the Spectrum data to the analytics platform.
The following data is synchronized from CA Spectrum to CA Digital Operational Intelligence:
  • Alarms
  • Inventory
  • Groups (Global Collection and Container)
  • Metrics: Device count and Device availability (based on Model Type and Group)
  • Services: information of resources (Vertex) and services/sub-services (Edges)
The following diagram explains how the CA Spectrum-CA Digital Operational Intelligence integration works:
CA Spectrum-CA Digital Operational Intelligence
CA Spectrum-CA Digital Operational Intelligence
If a tenant has multiple groups with the same name, only one group is pushed.
Compatibility Matrix
For more information about the integration of CA Spectrum with other CA products, see Integration Compatibility.
Prerequisites for SpectrumDataPublisher
Ensure the following prerequistes are met on the machine where you want install the SpectrumDataPublisher.
  • JRE (v8)
Ensure that the JRE version is 8. The SpectrumDataPublisher is compatible with JRE v8 only.
  • For Linux machines, set JAVA_HOME to JRE installed location. example  "/usr/java/jre.8.66"
  • For Windows machines, the installer/service takes the JRE installed location or JAVA_HOME path (if already set). If Java Home is not set, make sure Java is in your path.
Installing the SpectrumDataPublisher
The Spectrum OneClick page allows you to download and install the SpectrumDataPublisher JAR file. The Spectrum Data Publisher version should be the same as the version of the CA Spectrum.
Follow these steps:
  1. Log in to the OneClick client.
  2. Navigate to the
    OneClick Administration
    page.
  3. Select the
    Analytics Configuration
    option from the panel on the left.
    The
    Analytics Configuration
    page opens in a separate window.
  4. Under the
    Spectrum Data Publisher
    section, select the SpectrumDataPublisher JAR file link to download the installer.
    The SpectrumDataPublisher.jar file is downloaded to the Downloads folder on your computer.
  5. In
    Windows:
    Double-click on the jar to open the install wizard and enter the install directory. By default, the path is:
    C:\win32app\
    The Spectrum Data Publisher install wizard opens.
  6. In
    Linux
    perform one of the following tasks to start the installation:
    • Execute the following command for silent installation:
      Java -jar SpectrumDataPublisher.jar -i silent -DUSER_INSTALL_DIR="<install directory>"
      For example:
      Java -jar SpectrumDataPublisher.jar -i silent -DUSER_INSTALL_DIR="/opt"
    • Execute the following command to export DISPLAY to a Windows Server and start GUI based installation:
      Export DISPLAY=<machine-name>:0 and then run the following command:
      Java -jar SpectrumDataPublisher.jar
  7. Select
    Next
    to install the folder location.
  8. Select Install for the
    Spectrum Data Publisher
    to be installed.
  9. Select
    Done
    to close the Install wizard.
    After the installation is complete, the SpectrumDataPublisher folder is created in the install folder location.
Upgrade Spectrum Data Publisher
In the CA Spectrum 10.3.1 release, there are considerable changes that are done to the Spectrum Data Publisher. It is recommended to upgrade the Spectrum Data Publisher version to verify that the Spectrum Data Publisher is running the same version of CA Spectrum.
Follow these steps:
  1. Log in to the OneClick client.
  2. Navigate to the OneClick Administration page and select
    Analytics Configuration
    in the left panel.
    The
    Analytics Configuration
    page opens.
  3. Under the
    Spectrum Data Publisher
    section, select the SpectrumDataPublisher JAR file link to download the installer.
    The SpectrumDataPublisher.jar file is downloaded in the Download folder on your computer.
  4. Double-click the JAR file.
    The
    Spectrum Data Publisher
    install wizard opens.
  5. Select 
    Next
    to install the folder location.
  6. Select
    Install
    .
    A pop-up window appears displaying the current version and the version you are upgrading to.
  7. Select
    OK
    to proceed.
    The Spectrum Data Publisher is upgraded.
  8. Select
    Done
    to close the installation wizard.
Configuring the SpectrumDataPublisher
To synchronize data from CA Spectrum to CA Digital Operational Intelligence, configure the SpectrumDataPublisher.
Follow these steps:
  1. Navigate to the Spectrum Data Publisher install location.
  2. Open the 'config' folder.
  3. Open the ConnectorConfig.xml file, and configure the following:
    1. Enter the CA Spectrum OneClick host server details in the
      <SpectrumConfiguration>
      section.
      For example:
      <SpectrumConfiguration> <OneClickHostname><CA Spectrum OneClick host server></OneClickHostname> <OneClickPort>8080</OneClickPort> <OneClickProtocol>http</OneClickProtocol> <FilterUIMContent>true</FilterUIMContent> <ConfigFile>SpectrumConfig.xml</ConfigFile> </SpectrumConfiguration>
      If you want to use the Secure Sockets Layer (SSL) protocol to encrypt communications between OneClick and the SpectrumDataPublisher, you must import SSL (https) Certificate of CA Spectrum into SpectrumDataPublisher.
      If the value for 'FilterUIMContent' is set to 'True' (default), the Spectrum Data Publisher does not send the UIM alarms and inventory information to DOI.
    2. Enter the CA Digital Operational Intelligence host Jarvis server details in the
      <DestinationConfiguration>
      section.
      For example:
      <!-- For CA Digital Operational Intelligence: Specify Jarvis details --> <DestinationConfiguration> <DestinationType>DOI</DestinationType> <DestinationHostname><Jarvis Server Host Name></DestinationHostname> <DestinationPort>8080</DestinationPort> <DestinationProtocol>http</DestinationProtocol> <DestinationDefaultTenant></DestinationDefaultTenant> <DestinationEntitiesPerPayload>200</DestinationEntitiesPerPayload> <ConfigFile>DOIConfig.xml</ConfigFile> <Inventory>true</Inventory> <Alarms>true</Alarms> <Metrics>true</Metrics> <Groups>true</Groups> <Services>false</Services> </DestinationConfiguration>
      If you want to use the Secure Sockets Layer (SSL) protocol to encrypt communications between Jarvis and the SpectrumDataPublisher, you must import SSL (https) Certificate CA Jarvis into SpectrumDataPublisher.
  4. For Multi-tenancy, open the DOIConfig.xml file from the 'config' folder then configure the
    <MultitenancyConfiguration>
    section to map CA Spectrum Landscape to Digital Operational Intelligence.
    For example:
    <MultitenancyConfiguration> <TenantConfiguration> <LandscapeName><CA Spectrum landscape></LandscapeName> <SdcIpAddress></SdcIpAddress> <TenantId>A8A36649-CD82-2A29-54E7-DAEE998ECF42</TenantId> </TenantConfiguration> <TenantConfiguration> <LandscapeName><CA Spectrum landscape></LandscapeName> <SdcIpAddress></SdcIpAddress> <TenantId>69D9B5A0-CEC6-D658-C93F-16D87B5FF1FA</TenantId> </TenantConfiguration> </MultitenancyConfiguration>
    For single tenant, you can configure the tenant ID in the DestinationDefaultTenant field.
    Data from a landscape that is not mapped to any tenant (in MultitenancyConfiguration) will be sent to Digital Operational Intelligence with tenant ID specified in the DestinationDefaultTenant field of Destination Configuration. Data that is sent to Digital Operational Intelligence without any tenant ID will be dropped.
    After the configuration is complete, start the SpectrumDataPublisher service.
Start the SpectrumDataPublisher service
To start the SpectrumDataPublisher service, follow these steps:
  1. In Windows, from the command line, run`run.bat start`
  2. In Unix, from console, run `run.sh start`
  3. When you run the 'run.bat start' or 'run.sh' for the first time, it asks to create login password for SpectrumDataPublisher.
    You will need this login password for next time when you run 'run.sh' or 'run.bat start' commands.
  4. After creating the login password for SpectrumDataPublisher, it asks for following login details which will be encrypted/decrypted with password.
    1. Enter OneClick username: CA Spectrum username
    2. Enter OneClick password: CA Spectrum user password
      The destination username and password are for future use. You can skip these entries by pressing 'Enter'.
    3. Enter destination username: Digital Operational Intelligence or other product username
    4. Enter destination password: Digital Operational Intelligence or other product user password
    The SpectrumDataPublisher service starts.
Post-installation
  • To avoid manual restart of the SpectrumDataPublisher service, change the 'Startup Type' from 'Manual' to 'Automatic'in Windows Services.
Stop the SpectrumDataPublisher service
If you want to stop the SpectrumDataPublisher-service, run the following command:
  • run.bat stop (Windows)
  • run.sh stop (Linux)
Restart the SpectrumDataPublisher service
If you want to restart the SpectrumDataPublisher-service, run the following command:
  • run.bat restart (Windows)
  • run.sh restart (Linux)
On Windows machines, the SpectrumDataPublisher-service can be stopped and restarted through Windows Services Console.
Import SSL (https) Certificate into SpectrumDataPublisher
If you want to use the encrypted communication (https protocol) between CA SpectrumDataPublisher and the integrated products (CA Spectrum and CA Jarvis server), you must import the ssl/https certificate from the respective products into the SpectrumDataPublisher.
Follow these steps to import the certificate:
  1. Ensure that the 'https' certificate is exported and copied to the server where the SpectrumDataPublisher is installed.For export instructions, refer to the notes provided at the end of this section.
  2. Perform one of the following steps to download the CA Jarvis Server SSL/HTTPS certificate:
    • Run the following command:
      openssl s_client -connect Jarvis_Hostname:443 -servername Jarvis_Hostname < /dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > jarvisServer.cer
      OR
    • Access the Jarvis URL using HTTPS in a browser and save the certificate from site information.
  3. Run the following command to import the certificate into the Keystore of SpectrumDataPublisher.
    keytool -importcert -alias <certificate_alias> -file /<PATH>/<FILENAME.cer> -keystore /<PATH>
    For example:
    keytool -importcert -alias tomcatssl -file /SpectrumDataPublisher/OCServer.cer -keystore /SpectrumDataPublisher/Security/cacerts keytool -importcert -alias jarvisssl -file /SpectrumDataPublisher/jarvisServer.cer -keystore /SpectrumDataPublisher/Security/cacerts
    Ignore the warning about migrating to PKCS12 format.
  4. When prompts, provide the keystore password as 'changeit'.
  5. After the certificate is imported, stop the SpectrumDataPublisher service.
  6. Make sure the hostname, port and protocol details are proper in the /SpectrumDataPublisher/config/ConnectorConfig.xml
To export the ssl/https certificate of CA Spectrum, run the following command from CA Spectrum Oneclick server:
keytool -export -keystore /usr/<PATH> -alias <certificate_alias> -file <FILENAME.cer>
For example:
keytool -export -keystore /usr/Spectrum/custom/keystore/cacerts -alias tomcatssl -file OCServer.cer
Reset the Login Details of SpectrumDataPublisher service
In case you forgot login password for SpectrumDataPublisher service, you can reset the same by using following commands. Note that, when you reset the login details, the stored configuration details are deleted and you should provide the details again in the ConnectorConfig.xml file.
    • run.bat reset (Windows)
    • run.sh reset (Linux)
Logging Configuration for SpectrumDataPublisher
The SpectrumDataPublisher logs are stored in the SpectrumDataPublisher/logs/SpectrumDataPublisher.log file.
  • By default, 'trace', 'debug', 'info', 'warn', 'error' and 'fatal' information is logged in the 'SpectrumDataPublisher/config/log4j2.properties' file.
  • To see the log for the number of alarms and inventory being synced, set the rootLogger.level to 'info' in the log4j2.properties file. Any changes to the log4j2.properties file requires a restart of the SpectrumDataPublisher.
  • The maximum size of the log file is 128 MB. When the file reaches the maximum size, a backup file is created. The name of the backup file is SpectrumDataPublisher.log prefixed with a timestamp. The normal logging is continued in the SpectrumDataPublisher.log file.
Troubleshooting SpectrumDataPublisher
Troubleshooting information for the problems that are encountered with SpectrumDataPublisher.
Spectrum Data does not sync to Digital Operational Intelligence
Symptom:
SpectrumDataPublisher.log shows the exception: com.ca.spectrum.spub.common.ConnectorException. Spectrum Data does not sync to Digital Operational Intelligence.
Resolution:
Provide correct details of Jarvis server under the DestinationConfiguration section of ConnectorConfig.xml and make sure the DestinationHostname is resolved to a valid IP address.