📄️ Best Practices for Customizing Deploy
When customizing Deploy, it is recommended that you start by extending configuration item (CI) types and writing rules.
📄️ Customizing the Login Screen
You can configure your login screen to display a custom message.
📄️ Configure the Task Execution Engine
In Deploy, deployment tasks are executed by dedicated worker instances. A Deploy master generates a deployment plan that contains steps that a Deploy worker's task execution engine will carry out to deploy an application. You can read more about masters and workers here
📄️ Create a Custom Step for Rules
In Deploy you can create rules that define which steps should be included in a deployment plan. Each rule in the xl-rules.xml file defines a number of steps to add to the deployment plan. The available step primitives determine what kind of steps can be used. A step primitive is a definition of a piece of functionality that Deploy may execute as part of the deployment plan. For more information about Deploy rules, see Getting started with Deploy rules.
📄️ Add Input Hints in Configuration Items
The input hints feature enables Deploy plugin developers to guide users through the process of creating complex configuration items. Input hints can provide information such as: drop-down lists with the valid values for a configuration item property or messages that inform a user what type of data is expected in a property.
📄️ Add a Checkpoint to a Custom Plugin
Although the content in this topics is relevant for this version of Deploy, we recommend that you use the rules system for customizing deployment plans. For more information, see Getting started with Deploy rules.
📄️ Using the View as Feature
The Deploy View As feature allows you, as an Admin user, to view Deploy and navigate through the UI as a specific user or role. This allows you to see the permissions for a user or view and find CIs from another user perspective. You can use this information to decide if a user's environment needs to be modified, add or remove permissions, or adjust what a user or role can view in a CI tree.
📄️ Writing Jython Scripts for Deploy
You can use Jython scripting to extend or customize Deploy actions, events, or components. This topic describes best practices for writing, organizing and packaging your Jython scripts.
📄️ Using Variables and Expressions in FreeMarker Templates
Deploy uses the FreeMarker templating engine to allow you to access deployment properties such as such as the names or locations of files in the deployment package.
📄️ Automatically Archive Tasks According to a User-defined Policy
Deploy keeps all active tasks in the Monitoring section, which is located under the search bar at the top left of the screen.
📄️ Automatically Purge Packages According to a User-defined Policy
You can create a package retention policy (policy.PackageRetentionPolicy) that retains the deployment packages based on the configured regular expression. Deployed packages are never removed by the package retention policy. If a deployed package is part of the packages identified for removal, then it will be skipped, with no impact on other packages.
📄️ Automatically Purge the Task Archive According to a User-defined Policy
Deploy records and archives information about all tasks that it executes. This information is available through the statistics, graphs, and task archives on the Reports screen.