Installation Guidance overview¶
Introduction¶
Installation Guidance lets application developers define dependency and compatibility rules for an application. These rules are packaged in a bundle and uploaded for a specific application version.
When a user installs an application in IEM, the system evaluates the rules and determines whether the installation can continue, display a warning, or be blocked.
Use this documentation when you want to create and upload an Installation Guidance bundle for an application version, or when you want to understand how such a bundle affects the installation or update flow in the IEM UI.
If no Installation Guidance bundle is uploaded for the application version, the regular installation and update flows in IEM apply without these additional checks.
Installation Guidance workflow¶
The Installation Guidance workflow consists of four steps:
- How to create a Rego bundle and How to get the application ID: Create the bundle and identify the application ID required for the bundle configuration.
- How to upload an Installation Guidance bundle to IE Hub: Upload the bundle to IE Hub for a specific application version.
- Application installation journey: Let IEM evaluate the rules during installation.
- Application update journey: Let IEM evaluate the rules during the update.
This workflow ensures that the bundle is prepared and uploaded in IE Hub first, and then evaluated by IEM during the regular installation or update flow in the IEM UI.
Installation outcomes¶
After the bundle is uploaded, IEM checks the defined rules during installation or update. Depending on the result, the action is:
- allowed
- allowed with a warning
- blocked until the issue is resolved
These outcomes help users understand whether they can continue or must resolve an issue first.
Conclusion¶
Installation Guidance helps make application installation more predictable by checking dependencies before deployment.