.ziparchives that contain a file structure allowing for StackPack presentation in StackState, installation, provisioning and configuration of StackState. The
.zipextension must be changed to
.ststo make the archive visible as a StackPack in StackState. A StackPack archive has the following structure:
.stsarchive you can find the provisioning directory, resources directory and a configuration file. Provisioning directory is prepared for provision groovy scripts, and Templates.
provisioningdirectory is where all icons, templates, and
groovyscripts used for provisioning the StackPack are stored. The provisioning can also be split into multiple groovy scripts, and the
provisioningdirectory is part of the
classpathwhile provisioning the StackPack. Find more on Groovy in StackState.
resourcesdirectory contains all the static resources and contents for the StackPack. They are available in the Groove code through
stackpack.confis where the StackPack is configured. See the section below for more details.
Templates- these files are StackState Templated JSON handlebar files that reflect StackState configuration; it may contain
Id Extractors, and/or component/relations templates. Find more details on the templates page
name- Name of the StackPack. This is what is used to uniquely identify the StackPack. (Required)
displayName- Name that is displayed on both the StackPack listing page and on the title of the StackPack page. (Required)
isNew- This specifies whether the StackPack is new, as in the StackPack version is the first publicly available version. The values can be
false. By default, it is considered
categories- These are keywords using which the StackPacks can be filtered. Any list of relevant labels can be passed here. It is recommended to keep labels in capitalized letters.
overviewUrl- Markdown resource with general information about the StackPack. By default it is assumed to be
detailedOverviewUrl- Optional Markdown resource that described the StackPack in a bit more detailed fashion. This is displayed in two columns below the installed instances section in the StackPack page. Markdown comment,
[comment]: # (split)is used to delimit the two columns in the markdown.
configurationUrls- Contains the Markdown resources relevant for various states of StackPack provisioning.
faqs- Frequently asked questions concerning the StackPack or its installation. A list with each element having the format:
provision- Defines the provisioning script. For example, if the script is
provisioning/ExampleProvision.groovyis looked up to see if there is a groovy class named
releaseNotes- Markdown file containing release notes for the current StackPack release. Shown when installing the StackPack.
upgradeInstructions- Markdown file containing upgrade instructions for the current StackPack release. Shown when upgrading the StackPack.