Skip to content

Install Service Impact

This page describes how to install Service Impact.

The following list outlines recommended best practices for installing Service Impact:

  1. Review the release notes for this release before proceeding. The latest information is provided there.
  2. Use screen, tmux, or a similar program to establish sessions on the master host. If you become disconnected, the commands you initiate will continue to run.
  3. Review the procedures in this section before performing them. Every effort is made to avoid mistakes and anticipate needs; nevertheless, the instructions may be incorrect or inadequate for some requirements or environments.

Download required files

To perform this procedure, you need:

  • A workstation with internet access.
  • Permission to download files from delivery.zenoss.io. To request permission, file a ticket at the Zenoss Support site.
  • A secure network copy program.

Follow these steps:

  1. In a web browser, navigate to delivery.zenoss.io, and then log in.
  2. Download the Docker image file for Service Impact.

    • install-zenoss-impact_VERSION.run

    Replace Version with the most recent version number available on the download page. 3. Download the Service Impact ZenPack files. - ZenPacks.zenoss.ImpactServer-VERSION-py2.7.egg - ZenPacks.zenoss.Impact-VERSION-py2.7.egg

    Replace Version with the most recent version number available on the download page. 4. Use a secure copy program to copy the Docker image file and the ZenPack files to the Control Center master host.

Stage required files on the master host

To perform this procedure, you need permission to log in to the Control Center master host as root, or as a user with superuser privileges. Use this procedure to install the Docker image and to prepare the ZenPack files for installation.

  1. Log in to the Control Center master host as root, or as a user with superuser privileges.
  2. Stage the Docker image file and ZenPack files in /tmp.

    1. Create a directory in /tmp for the files. The directory must be local (not mounted) and must be readable, writable, and executable by all users. For example, /tmp/impact.

      mkdir /tmp/impact
      
    2. Copy or move the Docker image file and ZenPack files to /tmp/impact.

      Do not change the file names during the move or copy.

    3. Change the file permissions. The files must have the same permissions as their parent directory.

      chmod -R 777 /tmp/impact
      
  3. Install the Service Impact image.

    1. Change to the directory in which the Service Impact image is located.

      cd /tmp/impact
      
    2. Install the image.

      yes | ./install-zenoss-impact_*.run
      

Install Service Impact

  1. Log in to the Control Center master host as a user with Control Center CLI privileges.

  2. Create a snapshot:

    serviced service snapshot Zenoss.resmgr
    

    On completion, the serviced command returns the ID of the new snapshot. If the installation of a ZenPack fails, you can restore the snapshot created in this step. For more information about restoring a snapshot, see Creating snapshots and rolling back.

  3. Stop the Zenoss services, and then verify that the services are stopped.

    1. Stop Resource Manager.

      serviced service stop Zenoss.resmgr/Zenoss
      
    2. Wait until all services are stopped. Use the watch command to monitor the status.

      watch serviced service status Zenoss.resmgr/Zenoss
      
  4. Start the zeneventserver service.

    1. Start zeneventserver.

      serviced service start zeneventserver
      
    2. Wait until the service is started.

      Use the watch command to monitor the status.

      watch serviced service status zeneventserver
      
  5. Install the ZenPacks.zenoss.ImpactServer ZenPack.

    1. Change directory to the directory in which the Service Impact ZenPack egg files are located.For example, the /tmp/impact directory:

      cd /tmp/impact
      
    2. Install the ZenPack.Replace VERSION with the ZenPack version number:

      serviced service run zope zenpack-manager install ZenPacks.zenoss.ImpactServer-VERSION-py2.7.egg
      

      You may see messages like the following:

      2023/03/16 19:29:43.245152 sync.go:85: ERR Failed to publish events caused by: EOF
      2023/03/16 19:29:44.255162 single.go:140: ERR Connecting error publishing events (retrying): EOF
      

      These are unrelated to the installation process and should be ignored.

  6. Start the Infrastructure/Impact service, and then verify that it started.

    1. Start the Impact service.

      serviced service start Infrastructure/Impact
      
    2. Verify that the service is started.

      watch serviced service status Infrastructure/Impact
      
  7. Install the ZenPacks.zenoss.Impact ZenPack. Replace VERSION with the ZenPack version number:

    serviced service run zope zenpack-manager install ZenPacks.zenoss.Impact-VERSION-py2.7.egg
    
  8. Identify the delegate hosts where Resource Manager is running.

    serviced host list --show-fields=Pool,Name
    

    The name of the resource pool where Resource Manager is running is not standardized.

  9. Log in to a delegate host, and then start a Zope container.

    The following steps may take minutes to hours to complete, based on database size and the speed of the underlying delegate host. Zenoss recommends running the remaining steps of this procedure through a terminal multiplexer like screen or tmux.

    1. Log in to a delegate host in the Resource Manager pool as root or as a user with serviced CLI privileges.

    2. Start a Zope container on the host.

      serviced service shell zope
      
    3. In the container, log in as user zenoss.

      su - zenoss
      
  10. Update the catalog and then initialize the server.

    1. Update the catalog.

      zenimpactgraph run -x catclean
      
    2. Create the Service Impact graph in ZODB and Neo4j.

      zenimpactgraph run --update
      

      Processing may appear stuck for tens of minutes as connected objects are found in the ZODB. This is normal.

    3. Rebuild indexes and constraints for Neo4j graph.

      zenimpactgraph run -x reindex
      
    4. Exit the zenoss user account.

      exit
      
    5. Exit the Zope container.

      exit
      
  11. Restart all Zenoss services:

    serviced service restart Zenoss.resmgr/Zenoss