Skip to main content

19 docs tagged with "rules"

View all tags

Create a custom step for rules

This topic covers the creation of rules in Deploy, which define the steps to be included in a deployment plan. Each rule in the xl-rules.xml file specifies a number of steps to add to the deployment plan.

Define a Rule

This topic provides information about Deploy rules, which allow you to use XML or Jython to specify the steps included in a deployment plan and how these steps are configured.

Deploy System Architecture

With Deploy modular architecture you can change and extend components while maintaining a consistent system.

Disable a rule

This topic explains how to disable rules in Deploy by modifying the xl-rules.xml file

Extend the Database plugin

This topic describes how the Database plugin uses the Deploy rules system to provide improved rollback support for SQL scripts.

How Deployments are Executed

Deploy is a model-driven deployment solution. Users declaratively define the artifacts and resources that they need to deploy in a package, which is a ZIP file with a deployit-manifest.xml file, and Deploy figures out how to install the components in a target environment using rules. Rules are used to teach the Deploy execution engine how to generate your deployment steps in a scalable, reusable, and maintainable way.

Rule Objects and Properties

When you define an XML or script rule in Deploy, you use expressions or scripts to define its behavior. These are written in Jython, a combination of Python and Java.

Stitch rules

A Stitch rule is a customization rule that can either transform the content of the provided configuration file or generate it. A rule comprises of conditions (the 'when') and processors (the 'how').

Tutorial for using rules

The rules system works with the Deploy planning phase. You can use XML or Jython to specify the steps that belong in a deployment plan and how the steps are configured.

Use a script to execute commands

This topic provides information on executing commands as part of a deployment using Deploy. By creating a new deployable type and defining behaviors in the synthetic.xml and xl-rules.xml files, you can run scripts during deployment and rollback processes.

Use predefined steps in rules

Deploy rules enable you to use XML or Jython to specify the steps that belong in a deployment plan and how the steps are configured. Several Deploy plugins include predefined rules that you can use when writing rules. For more information on rules, see Get started with rules.

Use step macros

You can define new step primitives by using predefined step primitives such as jython and os-script. These are called step macros. After you define a step macro, you can refer to it by name, as you refer to a predefined step. You can reuse built-in steps and customize them for your system. Step macros can include one or more parameters of any valid Deploy type.

Write script rules

A script rule adds steps and checkpoints to a plan by running a Jython script that calculates which steps and checkpoints to add.

Write XML rules

The Deploy rules system enables you to use XML or Jython to specify the steps that belong in a deployment plan and how the steps are configured.