Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

minLevel1
maxLevel7

Approval Gate

...

An Approval Gate step can be added to pipeline in order to obtain approval by selected user before the continuation of steps can occur. In order for this step to function correctly, you must configure a Pipeline Notification to the Approval Gate pipeline step. Use the following documentation as a guideline to configuring an Approval Gate pipeline step, configuring a Pipeline Notification to the step, then approving through the respective platform or in Opsera’s UI.

Table of Contents
minLevel1
maxLevel7

...

Pipelines Approval Gate Configuration

Use the following documentation as a guideline to configuring an Approval Gate pipeline step.

Info

Prerequisites - In order to configure approval gate step for Slack, MS Teams, Jira, Service Now, or Google Chat, ensure you have created a respective tool in Tool Registry with a valid connection. You must also configure a notification to the approval gate step.

  1. To add an Approval Gate step, add a new pipeline step in the pipeline Workflow. Select Approval Gate from the Tool drop-down. Click Save and close the step.

...

  1. Image Added

2. Click on the gear icon to open Step Configurations and add Settings. Add a Custom Step Message by enabling Send Custom Message toggle (optional) and provide Point of Contact.

...

3. Click Save then proceed to Pipeline Notifications Configuration.

...

Jira Notification Configuration

This area will contain information on how to successfully configure a Jira notification.

Microsoft Teams Notification Configuration

...

Google Chat Notification Configuration

Fetching Webhook URL from Google chat:

Click on the chat to receive notifications → Manage Webhooks → Copy the URL → enter it in Opsera Tool registry.

...

Tool Registry:

Login Opsera Portal → Tool Registry → Create new Tool → Select Google chat & Create

Enter the Webhook URL in Connection details & check “Test Connection”

...

To enable the notification from Pipeline/Task:

  1. Click the step notification Icon to open Pipeline step Notification Configuration

  2. Click Google Chat from the left hand panel to configure Slack Notifications.

  3. Enable the Gchat Notifications toggle.

  4. Provide the following values:

    Notification Level - Select the scenario which you want to be notified from the drop-down. Choose from Step Completed, On Error, or All Activity.
    GChat Tool - Select the correctly configured Slack tool from the drop-down.

    Image Added

  5. Sample Gchat notification message:

...

Service Now Notification Configuration

This area will contain information on how to successfully configure a Service Now pipeline notification.

Slack Notification Configuration

...

  1. Click Slack from the left hand panel to configure Slack Notifications.

  2. Enable the Slack Notifications toggle.

  3. Provide the following values:

    Notification Level - Select the scenario which you want to be notified from the drop-down. Choose from Step Completed, On Error, or All Activity.
    Slack Tool - Select the correctly configured Slack tool from the drop-down.
    Slack Channel - Provide the name of the slack channel where you previously added the Opsera app. The # is not required.

    Image Removed

    Include last 10 lines of log (limited to 1000 characters) - Enable the toggle in order to view logs appended with Slack notification for Step Completed, On Error, or All Activity and for approval gate step to append logs from all the prev steps in pipeline

    Image Added

     

  4. Click Save. The Slack Notification is now configured. Notifications will now be sent to this Slack channel when the selected conditions are met.

    Image RemovedImage Added

...

Approval Gate Approval/Rejection

Once the above Approval Gate step and pipeline notification has been properly configured and the running pipeline reaches the step, the configured Teams tool channel will receive a notification.

User will receive a notification via the selected Microsoft Teams channel. Approve or Reject either within the channel UI or within the Opsera portal.

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFF0B3

At this time Approval Gate step is not supported by Google Chat tool.

Teams Approval

...

Approval through the Opsera Platform

...