create-incident

JFrog Pipelines Documentation

ft:sourceType
Paligo

This Pipelines Task can be used for creating incident for Atlassian status page.

This task performs the following:

  • Reads API key required for updating Atlassian status page.

  • Creates incident with the given name and adds identified as default status. Incident name, status, and body are read from the input parameters for the task, but status and body optional.

  • Sends create-incident on the component specified in status page.

Prerequisites

This task requires the following:

  • API key for Atlassian status page, and a generic integration with STATUS_PAGE_API_KEY as key in it

  • Valid status page with pageID

  • ComponentID where incident has to be created

Usage

Basic:

- task: jfrog/create-incident@v0.0.1
  id: pipelines_build
  input:
    apiKeysIntegration: value1
    componentID: value2
    pageID: value3

Input Variables

Name

Required

Default

Description

apiKeysIntegration

true

A Generic integration with STATUS_PAGE_API_KEY key to access status page

pageID

true

Page ID where component and incident has to be created

incidentName

false

Pipelines Builds are Failing

Name of the incident which has to be created in a status page

componentID

true

ID of the component where will incident has to be created

incidentStatus

false

"identified"

One of these values "investigating", "identified", "monitoring", "resolved"

incidentBody

false

url to step

A small description about the description which contains URL to the pipeline

hostName

false

https://api.statuspage.io

hostname of status page default is api.statuspage.io

Output Variables

None

Exported Environment Variables

  • incidentId

  • incidentURL

  • After task execution, access values via ${OUT_<TASK_ID>_incidentId}, ${OUT_<TASK_ID>_incidentURL}

How does it work?

  • Reads API key required for updating Atlassian status page

  • Creates incident with name given and adds identified as default status

    • Incident name, status and body are read from input parameters to task but status and body optional

  • Checks for any existing incidents already in open state if so skips creating incident

  • If there are no unresolved incidents on component sends create-incident on the component specified in status page

  • Adds [JFROG PIPELINES] prefix to incident name to identify incident is created via this task

License

This project is licensed under Apache 2.0 license.

Related Tasks

update-tasks