ZenPack Semantic Data

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

This page is intended to document the semantic data that is associated with each ZenPack.

Diagram

ZenPack UML Diagram.png

ZenPack Object

Each ZenPack is represented by a wiki page in the ZenPacks Category (this is a link to the Category Page for ZenPacks).

This page can have the following semantic data associated with it. Each of these items are called properties in Semantic MediaWiki parlance, and many are entered directly via fields on the ZenPack Form.

Flavor
This is a text field that can contain one of: free, core, commercial.
Author
This is a field of type page that can be defined zero or more times for each author of the ZenPack.
Maintainer
This is a field of type page that can be defined zero or more times for each maintainer of the ZenPack.
Organization
This is a field of type page that is used to set the organization that created the ZenPack. Zenoss-created ZenPacks have this set to Zenoss, Inc..
Restart
This is a string field that can be used to define a command to restart the ZenPack, which can be used to override the default command appears in the standard installation documentation display.
ClassTag
ClassTag is a multiple value string field that is used to set various special tags related to the ZenPack. These are typically used for QA purposes, such as indicating that the ZenPack needs an extjs update, etc.
License
This is a page value that links to the name of the license under which the ZenPack is released. This value is not set for commercial ZenPacks.
ZenPack name
This is a string value that contains the Python immutable name of the ZenPack, such as ZenPacks.zenoss.OpenVZ. It is required by the ZenPack autobuilder.
Homepage
A URL containing a link to the ZenPack's homepage.
Documentation URL
A URL containing a link to documentation. This has been used to provide a legacy link to the old documentation on Jive. This field is also used for the Pardot tracking URL that we use to track interest in commercial ZenPacks.
Source URI
A URL linking to a http or https URL where the ZenPack sources can be cloned. This URL is used by ZenPack autobuilder.

Sub-Objects

In addition to the main ZenPack object, several sub-objects can be defined for each ZenPack. There can be zero or more of each type of sub-object defined per ZenPack.

Sub-objects are linked to each ZenPack page by a semantic property of type Page that references the ZenPack page, which can be queried to find all sub-objects for a particular ZenPack. For example, to find all releases of the OpenVZ ZenPack, you would query for all Releases of properties that reference ZenPack:OpenVZ (the MediaWiki page name for the OpenVZ ZenPack.) This special page property will be listed first for each sub-object, below:

Releases

Release of
A property of type page that is used to link to the page name of the ZenPack.
Version
A string containing the version of the particular release.
Tag
A string containing the git tag or SHA1 that references this release. This is used in conjunction with the Source URI property (one of the fields associated directly with the ZenPack) by the ZenPack auto-builder to build the release.
Download URL
This field is used to provide a password-protected Parature download link for commercial ZenPacks.
Release date
A property of type date that specified the date upon which this release was first made available.
Requires
A property of type page that links to all ZenPacks (by page name) that this ZenPack requires in order to function.
Compatible with
A property of type page that links to all Compatibility Levels of Zenoss with which this ZenPack is compatible.
Incompatible with
A property of type page that links to all Compatibility Levels of Zenoss with which this ZenPack is incompatible.
Enhances
A property of type page that links to all ZenPacks (by page name) that this ZenPack enhances by enabling additional functionality in the target ZenPack. This value is imported from the ZenPack auto-builder JSON output.
Complexity
A numeric property that specifies the integer complexity value of this release. This value is imported from the ZenPack auto-builder JSON output.
ComplexityTags
A property of type string that specifies all specific complexity settings that were detected in this release. This allows you to query on particular capabilities in the ZenPack, such as support for Impact. See ComplexityTags for a complete listing of possible tags.

Devices

Device of
A property of type page that is used to link to the page name of the ZenPack.
Manufacturer
Device manufacturer (string)
Model
The device model (product name), a string.

Applications

Application of
A property of type page that is used to link to the page name of the ZenPack.
Product name
Product name (string)
Version
Product version (multiple allowed)

Integrations

Application of
A property of type page that is used to link to the page name of the ZenPack.
Product name
Product name (string)
Version
Product version (multiple allowed)

Legacy Binaries

This semantic data was originally used to link to pre-generated eggs for download, but is now deprecated and no longer being used.