- Notify respective parties such as developers, DevOps engineers, and on-call responders from events created in Shipa.
- Create events based on Application Events from Shipa such as updating an application image, deploying an application, changing of a Shipa Policy such as networking/volumes, etc.
- Events are sent to PagerDuty which can be on success and/or failure of events.
- PagerDuty integrations require an Admin base role for account authorization. If you do not have this role, please reach out to an Admin or Account Owner within your organization to configure the integration.
The integration of Shipa and PagerDuty is with PagerDuty’s REST API. via a PagerDuty Service. You can create a new Service or leverage an existing PagerDuty Service. You will need to create a PagerDuty API Key for Shipa to leverage.
You will also need the PagerDuty Service ID which Shipa will use to send the alerts. The URL for your Service will give you the Service ID. In the below case will be P**.
Now you are ready to configure Shipa.
In Shipa, click into an application then head to the Integrations Tab.
Shipa Cloud -> Applications -> YourApp -> Integrations
Then click on +Create.
In the Webhook UI, can give a name and description of an event to track. You can decide to send alerts on success, failure, or any invocation of an event.
Event kinds to track: app.deloy
Report any event
Click Next and select PagerDuty from the Provider drop-down. Enter the needed pieces of information.
Email Account: The e-mail account associated with your PagerDuty Account.
Authorization Key: Your PagerDuty API Key.
Service ID: The ID of your PagerDuty Service, can be found in your Service’s URL.
Then click Create. Now your “pdalert” will be configured.
Next to check out this alert in action, head back to your Application and re-deploy.
Shipa Cloud -> Applications -> YourApp +Deploy
Provide an updated image or re-deploy the same image.
Click Deploy and you will have a new alert in PagerDuty.
Details on specific field mappings.
|Name||The name of the integration. The name is not tied to PagerDuty but a custom name you can choose.|
|Email Account||The email account used to access PagerDuty.|
|Authorization Key||For Shipa to make successful requests to PagerDuty's REST API, you must provide a valid authorization key.|
You can find detailed information on how to create a REST API key here
|Webhook Description||A meaningful description for your Shipa / PagerDuty integration so other users in your team can quickly understand the integration.|
|Team||The Shipa team that will own the integration.|
|Service ID||The Service ID that Shipa will use to send alerts to.|
You can find your Service ID by clicking on Service --> Service Directory --> Service-Name
In the page URL, PagerDuty will give you the specific Service ID for that Service.
|Events to track||Which events you want Shipa to track for this application.|
You can select multiple options.
|Success only, Errors only, Any||The type of event you want Shipa to send the alert to PagerDuty.|
Updated 7 months ago