StackState Docs
StackState.comDownloadBlogsSupport
Search…
StackState version 4.2 (EOL)
Welcome to the StackState Docs!
🚀
Setup
Requirements
Installation
Data management
Upgrade StackState
👤
Use
Introduction to StackState
Explore mode
Views
Analytics
Health state and event notifications
Glossary
🧩StackPacks
What is a StackPack?
Add-ons
Integrations
Develop your own StackPacks
🔧
Configure
Topology
Telemetry
Traces
Security
Identifiers
Logging
📖
Develop
Developer guides
Develop StackPacks
Packaging
How to get a template file
How to make a multi-instance StackPack
Prepare a multi-instance provisioning script
Upload a StackPack file
Prepare a shared template
Customize a StackPack
Prepare instance template files
Prepare a StackPack provisioning script
Resources in a StackPack
StackState Common Layer
Custom Synchronization StackPack
Synchronizations and templated files
Agent checks
Extend StackState with functions
Mirroring Telemetry
Integrate external services
Reference
Tutorials
Powered By GitBook
Resources in a StackPack
This page describes StackState version 4.2.
The StackState 4.2 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.2 version range to upgrade to a more recent release.
Go to the documentation for the latest StackState release.
The resources reside in <your-stackpack>/src/main/stackpack/resources directory. This folder contains files to be used mostly as display assets in the StackState UI as steps during the StackPack installation process. Some of the files are required for a StackPack to be displayed correctly:
  • logo.png - an image file with the StackPack logo that is displayed on the StackPacks page in StackState.
  • overview.md - a markdown text file with general information about the StackPack.
  • configuration.md - a markdown text file with information about how to configure a StackPack instance.
    This is a piece of information the user is going to see in the first step of the installation process.
  • waitingfordata.md - a markdown text file with information about user actions required for the StackPack instance to start receiving data.
    This is a piece of information the user is going to see in the second step of the installation process.
  • enabled.md - a markdown text file explaining that the StackPack instance has been installed successfully.
    Should also contain information on how to uninstall the instance.
    This is a piece of information the user is going to see in the final step of the installation process.
  • detailed-overview.md - a markdown text file with general information the user needs to know to use a StackPack instance, e.g., prerequisites or access rights. To achieve a two-column layout, there is a special [comment]: # (split) tag. Inserting this tag in a particular place will cause the text to be split into two columns in this place.
  • provisioning.md - a markdown text file with a piece of information the user is going to see during the installation process.
  • deprovisioning.md - a markdown text file with a piece of information the user is going to see during the uninstallation process.
  • error.md - a markdown text file with an error message to show when an error occurred during provisioning of the StackPack.
Previous
Prepare a StackPack provisioning script
Next
StackState Common Layer
Last modified 2mo ago
Copy link