Deploy Request

The purpose of a deploy request is to indicate that a policyRules Engine: Refers to a read-only version of a set of rules that identify requests and the set of actions that can be applied to them. A policy may be applied to either the Staging or Production environment. is ready to be applied to either the Staging or Production environment. Once a deploy request has been submitted, it will undergo an automated validation and error detection system. If no issues are detected, then the policy will be applied to the requested environment.

Although most rules may undergo automated validation, more complex rules require manual review. This manual review process may take up to 4 hours.

It may take up to an hour before a policy is fully deployed to the Production environment, while deployment to the Staging environment should only take approximately 15 minutes.

Deploy Request Submission

The submission of a deploy request may be initiated when viewing a policy. This submission process requires the selection of a target environment (i.e., Staging or Production) and a description of the deploy request.

Please try to assign a relevant description when submitting a deploy request. This information may prove to be helpful when reviewing deploy request history.

Two simultaneous deploy requests to the same environment may not be submitted. Please wait until the previous deploy request has been deployed, rejected, or canceled before submitting another deploy request.

Upon selecting the desired environment, the XML differences between the new policy and the one currently deployed to that environment will be displayed. Review the XML changes to validate that the policy accurately reflects the configuration that should be deployed to that environment.

Learn how to interpret XML data.

The following table describes how XML changes are annotated.

Change Type	Line Color	Description
New Line (Addition)	Green	Indicates that the new policy contains a line that is not present in the policy currently deployed to the requested environment.
Deleted Line (Deletion)	Red	Indicates that the new policy does not contain a line that is present in the policy currently deployed to the requested environment.
No Change	White	Indicates that the line is present in both policies and no changes were detected.

A change in a match condition or feature's setting is reported as:

A deletion of the line that defines the current value for the match condition/feature's setting.
The addition of the line that proposes a new value for the match condition/feature's setting.

The following illustration demonstrates a change in the Compress File Types feature's media type from "text/html" to "text/htm."

To submit a deploy request

Navigate to the Rules Engine page.
Click the Policies tab.
View the desired policy by clicking on its name.
Click Deploy Request.
In the Environment option, choose the target environment (i.e., Staging or Production). The page will be updated to display the differences between the new policy and the policy currently deployed to the selected environment.
In the Message option, provide a comment that indicates why this deploy request was submitted.
Click Create Deploy Request.

Deploy Request States

A deploy request must undergo a review and approval process before a policy may be applied to the Staging or Production environment. The workflow for core deploy request states is depicted below.

A description is provided for each deploy request state below.

State	Description
Submitted	Indicates that a deploy request was submitted by a user.
Canceled	Indicates that the deploy request was canceled by a user. This state will also be applied to a deploy request upon multiple unsuccessful retry attempts.
Pending Review	Indicates that the deploy request is awaiting manual review. Manual review is required when the logic in a deploy request could not be automatically approved by our automated policy review system.
Escalated	Indicates that the deploy request was escalated after manual review. This state only applies to deploy requests for complex policies. As a result, most deploy requests will bypass this state.
Rejected	Indicates that the deploy request was rejected and the corresponding policy will not be applied to the target environment. A message will indicate the reason why the deploy request was rejected. Duplicate the corresponding policy and then adjust the configuration accordingly.
Verification Delayed	Indicates that the deploy request contains logic that is indicative of an invalid configuration. Although you can resubmit the deploy request by viewing it and then clicking Retry Deploy Request, the recommended procedure is to cancel the deploy request, duplicate the policy, review/revise all rules, and submit another deploy request.
Deployment Delayed	Indicates that the deploy request contains logic that is indicative of an invalid configuration. Although you can resubmit the deploy request by viewing it and then clicking Retry Deploy Request, the recommended procedure is to cancel the deploy request, duplicate the policy, review/revise all rules, and submit another deploy request.
Approved	Indicates that the deploy request has been approved for deployment.
Deployed	This state is applicable while a policy is being deployed to either the Staging or the Production environment. It may take up to an hour before a policy is fully deployed to the Production environment, while deployment to the Staging environment should only take approximately 15 minutes.

The last status assigned to each deploy request is indicated on the Deploy Requests section of the Rules Engine page. Clicking on the desired deploy request will display its historical status activity.

The policy currently deployed to both Production and Staging environments are indicated in the Production and Staging sections of the Rules Engine page. Additionally, historical status activity for the corresponding deploy request may be viewed by following the "View deploy request" link that appears below the policy name.

Deploy Request History

Deploy request history is displayed under the Deploy Requests section of the Rules Engine page.

Click on a deploy request to view:

The XML differences between the corresponding policy and the policy that it replaced in the target environment (i.e., Production or Staging).
A history of the deploy request's status activity. This activity information tracks the deploy request through the status workflow described above.

Deploy Request State Notifications

An email notification may be sent whenever a deploy request enters a new state.

Key information:

Email notifications are applicable to all deploy requests. However, notifications will only be sent for the states selected on the Deploy Request Notification page.
An email notification may be sent to one or more email addresses. Use a comma to delimit each email address.

Sample configuration:

joe@mycompany.com,mary@mycompany.com,james@widgets.com
The following syntax will be applied to the subject line for each email notification:

Rules Engine Notification - CAN - Deploy Request IDIdentifies a deploy request by its system-defined ID.- StateIndicates the state assigned to the deploy request.
The body of the email notification will describe the deploy request.

To set up deploy request state notifications

Navigate to the Deploy Request Notification page by clicking on the "Notification is [Enabled/Disabled]" link from the Rules Engine landing page.
Enable notifications by toggling the Notify me by email when any pending Deploy Request gets updated option from "off" to "on."
Verify that each state for which a notification should be sent is marked.
Specify one or more email address(es) in the Please enter 1 or more email addresses for notifications option.
Click Save.