ZenPack FAQ

ZenPack FAQ

1. What is a ZenPack?
2. What ZenPacks are available?
3. How do I install a ZenPack?
4. How do I upgrade a ZenPack?
5. How do I uninstall a ZenPack?
6. How do I install a ZenPack on an appliance?
7. How do I update a ZenPack on an appliance?
8. How do I uninstall a ZenPack installed on an appliance?
9. How do I create a ZenPack?
10. Is there an example ZenPack I can use as a guide?
11. Is there a discussion list for ZenPacks?

1. What is a ZenPack?

A ZenPack is a package that adds new functionality to Zenoss Core and Enterprise.  ZenPacks may add any or all of the following:

A ZenPack may also add new daemons and new UI features.

2. What ZenPacks are available?

ZenPacks come in three flavors: Community, Core, and Enterprise.

• Community ZenPacks are ZenPacks created and contributed by Zenoss community members. They come with no official support from Zenoss.
  
• Core ZenPacks are ZenPacks that have been tested and certified by Zenoss. They are most often made by Zenoss, but community ZenPacks may also be integrated over time. Core ZenPacks are Zenoss-supported for users with Core Support. Both Community and Core varieties are freely available to anyone using Zenoss Core and Enterprise.
• Enterprise ZenPacks are created and officially supported by Zenoss. They are available to and supported for anyone using Zenoss Enterprise.

The most current list of ZenPacks can be found on the ZenPack Project Site.

3. How do I install a ZenPack?

Download the ZenPack .zip file and run, as the zenoss user:

zenpack --install <zenpack file>

This unzips the ZenPack file into $ZENHOME/Products/<ZenPackId> and installs the ZenPack in Zenoss.

NOTE: do not uncompress the file before you issue the command above - this is taken care of for you automatically.

There is also an rpm located here that contains all core zenpacks, for quick and easy installation.

Follow any other steps that maybe specified in the instructions of that ZenPack. If you are using an appliance, see How do I install a ZenPack on an appliance?

4. How do I upgrade a ZenPack?

Download the ZenPack .zip file and run, as zenoss user:

zenpack --install <zenpack file>

Follow any other steps that maybe specified in the instructions of that ZenPack.  If you are using an appliance, see How do I upgrade a ZenPack on an appliance?

5. How do I uninstall a ZenPack?

Warning: Removing a ZenPack can have unexpected consequences. For example, removing a ZenPack that installed a Device Class will remove both the Device Class and all Devices within that class. For this reason you should always perform a backup before removing ZenPacks.

As the zenoss user, run:

zenpack --remove <zenpack name>

NOTE: Use the zenpack name rather than the filename.  Follow any other steps that maybe specified in the instructions of that ZenPack.  If you are using an appliance, see How do I uninstall a ZenPack installed on an appliance?

6. How do I install a ZenPack on an appliance?

If you have used the update server to install your zenpack, then you will have to upgrade the ZenPack in a similar fashion. As root, from the command line run:

 conary update --resolve group-<Name of ZenPack>

For example, to upgrade the DnsMonitor ZenPack, as root:

 conary update --resolve group-DnsMonitor

And that's it. This will automatically download the packages needed and update the ZenPack on your instance.

You can also install all core zenpacks to an appliance at once. To do so, run the following as root:

conary update --resolve group-zenpacks

7. How do I update a ZenPack on an appliance?

You may download the .zip file and upgrade the zenpack as you would on any other installation.  However, if you are running an appliance with a working connection to the internet, you can take advantage of our update server. To do this, as root, from the command line run:

 conary update --resolve group-<Name of ZenPack>

For example, to install the DnsMonitor ZenPack, as root:

 conary update --resolve group-DnsMonitor

And that's it. This will automatically download the packages needed
and install them on your instance.

8. How do I uninstall a ZenPack installed on an appliance?

If you have used the update server to install your zenpack, then you will have to uninstall it in a similar fashion. As root, from the command line run:

 conary erase group-<Name of ZenPack>

For example, to uninstall the DnsMonitor ZenPack, as root, run:

 conary erase group-DnsMonitor

And that's it. This will uninstall the zenpack from your instance.

9.  How do I create a ZenPack?

See this document on How to Create A ZenPack

10.  Is there an example ZenPack I can use as a guide?

HelloWorldZenPack is an example ZenPack and may be used as a starting point for creating your own ZenPacks. The code and comments in its files provide a lot of detail as to the workings of the install process and other aspects of ZenPacks. HelloWorldZenPack and other Zenoss Core ZenPacks are available for download here.

11. Is there a discussion list for ZenPacks?

Yes. There is a dedicated list/forum for the discussion of ZenPacks.