Skip to content

Preparing to install or update a ZenPack

Perform this procedure to minimize the amount of time that Resource Manager is unavailable during a ZenPack installation or update.

  1. Log in to your workstation and start a web browser.

  2. Download the ZenPack to install or update from the Zenoss Support site. Contact your Zenoss representative for login credentials.

  3. Copy the ZenPack egg file to a local directory on the Control Center master host.

    1. Create a directory for the ZenPack egg file.

      The directory must be local (not mounted).The following command creates a directory in /tmp:

      mkdir /tmp/zenpack
      
      2. Use a file transfer command or utility to copy the file.

    2. Set full permissions on the directory and files:

      chmod -R 0777 /tmp/zenpack
      
  4. Optional: Install ZenPack dependencies.

    A ZenPack might require packages or other software not included in the ZenPack egg file. To ensure that the dependencies are available, perform the following substeps:

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

    2. Start an interactive shell in a Zope service container.

      In the following command, the -s flag saves and tags the changes that you make. Replace MyTag with a short name that describes the dependencies that you are installing.

      serviced service shell -i -s MyTag zope bash
      

      The serviced daemon starts a Bash shell and logs you in as the root user.

    3. Install required dependencies.

      For example, to install the terminus font for X Windows in Ubuntu Linux, enter the following command:

      apt-get install xfonts-terminus
      

      Enter any number of commands to install the required dependencies.

    4. Return to the Control Center master host shell session:

      exit
      
    5. Create a snapshot and commit your changes:

      serviced snapshot commit MyTag
      
    6. Restart all Resource Manager application services:

      serviced service restart Zenoss.resmgr/Zenoss
      

Installing or updating a ZenPack

Before you begin, review the following requirements and considerations:

Perform these steps:

  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. Change directory to the directory in which the ZenPack egg file is located. For example:

    cd /tmp/zenpack
    
  4. Install the ZenPack:

    serviced service run zope zenpack-manager install ZenPack-File.egg
    

    Daemons that a ZenPack provides are packaged in Docker containers and installed as child services of the current instance of Resource Manager.

  5. Restart all Zenoss services:

    serviced service restart Zenoss.resmgr/Zenoss