Pipelines Approval Gate Configuration
An Approval Gate step can be added to pipeline in order to obtain approval by selected user before continuation of steps can occur.
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.
Teams Tool Setup
In Tool Registry, create a new tool using ‘Teams’ as Tool Identifier.
In the newly created tool, navigate to the Connections tab.
In Teams Webhook URL paste your webhook URL from the selected Team’s portal.
Click Save to save the configuration.
Approval Gate Step Configuration
To add 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.
Click on the gear icon to open the
Step Configurations and add a Custom Step Message and Point of Contact.
Click Save then proceed to add a Step Notification to the step by clicking the mail icon on the step.
Select the type of notification the user will receive. Choose from Slack Teams, Jira, ServiceNow, or Email Notifications. Once the notification type is selected you can select a Notification Level and configured Tool.
Notification Level - Select when you would like to receive approval.
Teams Tool - Select the configured teams tool where approval will be sent.
Click the ‘Save’ button.
Approval Gate Process in Pipeline
Once the above Approval Gate step has been set up properly, and the pipeline begins running, the configured Teams tool will receive a notification once the Approval Gate pipeline step is reached.
User will receive a notification in Teams UI and has the option to ‘Approve’ or ‘Reject’ either here or within the Opsera portal.
Teams approval:
Approval through the Opsera Platform
Click Approve button.
Add any comments, enable the Approved toggle, and click Approve button.
You will then receive an Approval Status message verifying that the approval has been received. The pipeline will continue to run.
Prerequisite - In order to configure notifications for Slack, MS Teams, Jira, Service Now, or Google Chat, ensure you have created a respective tool in Tool Registry with a valid connection.
Pipelines Notification Configuration
Use the instructions below to successfully configure notifications for a pipeline step using the following tools. To configure notifications for a pipeline step, navigate to the pipeline Workflow and click the pencil icon (✏️) in the pipeline step. This will open the Pipeline Step Notification Configuration popup.
Provide Approval Gate Flow Setup & Notification Setup for the following:
Slack
Prerequisite - In addition to having a successfully configured Slack tool in the Tool Registry, the Opsera app must be added to the Slack channel where notifications will be received.
Add the Opsera App to a Slack Channel
To receive a notification within a specific Slack channel, navigate to the slack channel. In the text field, type “/app” to search through your connected app directory and locate Opsera. Click Add apps to this channel.
Locate Opsera and click Add. The Opsera app has been added to the Slack channel and can be configured in Notifications.
Slack Notification Configuration
Click Slack from the left hand panel to configure Slack Notifications.
Enable the Slack Notifications toggle.
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.
Click Save. The Slack Notification is now configured. Notifications will now be sent to this Slack channel when the selected conditions are met.
Microsoft Teams
Click Microsoft Teams from the left hand panel to configure Microsoft Teams Notifications.
Enable the Microsoft Teams toggle.
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.
Teams Tool - Select the correctly configured Teams tool from the drop-down.
Click Save. The Microsoft Teams Notification is now configured. Notifications will now be sent to this Teams channel when the selected conditions are met.
Click Email from the left hand panel to configure Email Notifications.
Enable the Email Notifications toggle.
Provide the following values:
Email Address - Enter the email address where you would like to receive notifications. Once the email is entered, click +Add Email Address. You can select up to five Email Addresses.
Notification Level - Select the scenario which you want to be notified from the drop-down. Choose from Step Completed, On Error, or All Activity.
Click Save. The Email Notification is now configured. Notifications will now be sent to the email(s) provided when the selected conditions are met.
