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 remove a ZenPack?
5. How do I create a ZenPack?
6. Is there an example ZenPack I can use as a guide?
7. 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?

ZenPacks are installed from the command line by issuing the following (as the zenoss user):

zenpack --install <filename>

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.

4. How do I remove 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.

The command to remove a ZenPack is:

zenpack --remove <ZenPack id>

"<ZenPack id>" is the name of the ZenPack. So if you install "HelloWorld.zip", your command to remove would be "zenpack --remove HelloWorld".

5. How do I create a ZenPack?

See this document on How to Create A ZenPack

6. 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.

7. Is there a discussion list for ZenPacks?

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