Gating rules are a set of criteria that each stage must pass to proceed to the subsequent stage. You can configure gating rules based on your requirement for a pipeline.

About this task

If the gating rule is not configured, then the process proceeds to the next stage regardless of the outcome of tasks in the current stage. The workflows are tagged as vRCS_GATING_RULE and are listed in the drop-down menu.

A workflow is depicted as a sequence of operations. The workflow consists of an orchestrated and repeatable pattern of business activity enabled by the systematic organization of resources into processes that transform materials, provide services, or process information.

The default workflows are Approval and Test Acceptance Threshold. For information on how you can register vRO workflow for a gating rule, see Installation and Configuration guide.

Table 1. Default Workflows

Workflow

Description

Approval

This workflow is tagged with a vRCS_GATING_RULE tag.

You must provide the approval group DN value and the approval message for a stage to continue or stop. The appropriate user receives an email to approve or reject this workflow. After the user submits or rejects the notification that appears in My Inbox, the workflow either continues or stops.

Test Acceptance Threshold

This workflow is tagged with a vRCS_GATING_RULE tag.

You must provide the threshold percentage value and the test result for a task to succeed the gating rule to the next level. This workflow accepts the test result from a Jenkins test task. Based on the configured threshold for passed tests criteria, it allows the pipeline run to proceed to the subsequent stage.

Prerequisites

  • Verify that the last task of a stage is a test, custom script, or custom workflow.

  • Verify that a custom script output is converted to create a JSON and then passed to the gating rule.

    The Jenkins output can be passed directly to the gating rule, as the following example shows.

    {
    "totalCount": 40,
    "skipCount": 0,
    "failureCount": 0,
    "successCount": 40
    }

Procedure

  1. Click the Code Stream tab.
  2. Select an existing pipeline to configure from the Pipeline tab.
  3. Select Edit > Stages.
  4. Click the Gating Rule icon (gating rules) next to a stage.
  5. Select If outcome of a vRealize Orchestrator workflow is successful to create the gating rule.
  6. Select the appropriate workflow from the drop-down menu.
    1. Enter the approval group DN value, vsphere.local\administrators, in the Approval text box.

      You can also edit the approval message. DN is any valid DN name that is configured in the identity store tied to vRealize Automation.

    2. Enter the threshold percentage and the test result value in the Test Acceptance Threshold text box.
  7. Click Save.