update-incident

JFrog Pipelines Documentation

ft:sourceType
Paligo

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

This task performs the following:

  • Reads API key required for updating Atlassian status page.

  • Lists all unresolved incidents on page.

  • Filter unresolved incidents.

  • Updates incidents related to a component and also updates status of component.

  • Updates all incidents to resolved state and components to operational state.

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/update-incident@v0.0.1
  id: pipelines_build
  input:
    apiKeysIntegration: value1
    pageID: value2
    componentID: value3

Input Variables

Name

Required

Default

Description

apiKeysIntegration

true

A Generic integration with API keys in STATUS_PAGE_API_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 on which the incident has to be raised, ideally available on manage status page

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

  • Lists all unresolved incidents on page

  • Filter unresolved incidents

  • Updates incidents related to a component and also updates status of component

  • Updates all incidents to resolved state and component to operational state if component and incident status are not given

License

This project is licensed under Apache 2.0 license.

Related Tasks

create-task