This project is owned and driven by Jane Curry ( jane.curry@skills-1st.co.uk ).
The Guide is detailed documentation for Zenoss ZenPack developers. It is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/
This basically means that anyone is welcome to copy, redistribute, remix, transform and build upon the material. You must give appropriate credit and indicate if changes were made. You must distribute any derivative under this same license.
Zenoss Inc are part of the project but accept no liability for the document or its usage.
The document discusses a wide variety of ZenPack topics, including some detailed investigation of core Zenoss code and how the ZenPack developer can interface with it.
The Guide is built around a number of sample ZenPacks which, between them, explore:
- Zenoss architecture
- ZenPack architecture
- Creating new object classes and relationships
- The zenpacklib tool
- Creating new collector modeler plugins to populate the new classes with data
- Converting old, non-zenpacklib ZenPacks to use zenpacklib
- Creating code for web pages for new types of objects, both JavaScript and TAL
- Creating new performance datasources and data templates
- Converting COMMAND-based ZenPacks to use the PythonCollector
- Incorporating new event classes, triggers and notifications in ZenPacks
- Creating and extending menus
- Extending functionality using routers and facades
- Logging and debugging
- The process of ZenPack creation, GitHub and ZenPack submission to Zenoss
The samples can be found here on GitHub under https://github.com/ZenossDevGuide
The document will never be “finished”; always a “work-in-progress” as the product and knowledge of the product expands. Please read the Guide, try the ZenPacks and contribute comments back for the next version. A basic template document, in Word format, is provided.
Please use the ZenPack Development forum for discussions - http://www.zenoss.org/forums/zenpack-development . We could also try using the "Issues" tab on GitHub for feedback.
To download the pdf document, click on the latest published guide, eg. ZenPack_DevGuide_V1.0.1_publish1_20160920.pdf . You get to see about the first 40 pages - you can select More to continue viewing online. To download, click the Raw button when viewing the doc and select where to save.
- 1.0.0
- Initial public release
- 1.0.1
- With odd / even page numbers fixed and document history