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.
Pipelines Approval Gate Configuration
Use the following documentation as a guideline to configuring an Approval Gate pipeline step.
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.
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.
2. Click on the gear icon to open Step 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.
To complete Approval Gate step configuration you must configure the pipeline notification to the Approval Gate step.
Pipeline Step Notification Configuration
To configure notifications for a pipeline step, navigate to the pipeline Workflow and click the pencil icon (✏️) in the pipeline step. To configure an Approval Gate, configure the notifications in a configured Approval Gate pipeline step. This will open the Pipeline Step Notification Configuration popup.
Email Notification Configuration
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.
Jira Notification Configuration
This area will contain information on how to successfully configure a Jira notification.
Microsoft Teams Notification Configuration
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.
Google Chat Notification Configuration
Click Google Chat from the left hand panel to configure Slack Notifications.
Enable the Gchat 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.
GChat Tool - Select the correctly configured Slack tool from the drop-down.
Service Now Notification Configuration
This area will contain information on how to successfully configure a Service Now pipeline notification.
Slack Notification Configuration
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.
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 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.
At this time Approval Gate step is not supported by Google Chat tool.
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.
