0.4.24 • Published 19 days ago

@backstage/plugin-splunk-on-call v0.4.24

Weekly downloads
215
License
Apache-2.0
Repository
github
Last release
19 days ago

Splunk On-Call

Overview

This plugin displays Splunk On-Call, formerly VictorOps, information about an entity.

There is a way to trigger an new incident directly to specific users or/and specific teams.

This plugin requires that entities are annotated with a team name. See more further down in this document.

This plugin provides:

  • A list of incidents
  • A way to trigger a new incident to specific users or/and teams
  • A way to acknowledge/resolve an incident
  • Information details about the persons on-call

Setup instructions

Install the plugin:

yarn add @backstage/plugin-splunk-on-call

Add it to the app in plugins.ts:

export { plugin as SplunkOnCall } from '@backstage/plugin-splunk-on-call';

Add it to the EntityPage.tsx:

import {
  isPluginApplicableToEntity as isSplunkOnCallAvailable,
  SplunkOnCallCard,
} from '@backstage/plugin-splunk-on-call';
// ...
{
  isSplunkOnCallAvailable(entity) && (
    <Grid item md={6}>
      <SplunkOnCallCard entity={entity} />
    </Grid>
  );
}

Client configuration

In order to be able to perform certain action (create-acknowledge-resolve an action), you need to provide the username of the user making the action. The user supplied must be a valid Splunk On-Call user and a member of your organization.

In app-config.yaml:

splunkOnCall:
  username: <SPLUNK_ON_CALL_USERNAME>

The user supplied must be a valid Splunk On-Call user and a member of your organization.

In order to make the API calls, you need to provide a new proxy config which will redirect to the Splunk On-Call API endpoint and add authentication information in the headers:

# app-config.yaml
proxy:
  # ...
  '/splunk-on-call':
    target: https://api.victorops.com/api-public
    headers:
      X-VO-Api-Id:
        $env: SPLUNK_ON_CALL_API_ID
      X-VO-Api-Key:
        $env: SPLUNK_ON_CALL_API_KEY

In addition, to make certain API calls (trigger-resolve-acknowledge an incident) you need to add the PATCH method to the backend cors methods list: [GET, POST, PUT, DELETE, PATCH].

Adding your team name to the entity annotation

The information displayed for each entity is based on the team name. If you want to use this plugin for an entity, you need to label it with the below annotation:

annotations:
  splunk.com/on-call-team': <SPLUNK_ON_CALL_TEAM_NAME>

Providing the API key and API id

In order for the client to make requests to the Splunk On-Call API it needs an API ID and an API Key.

Then start the backend passing the values as an environment variable:

$ SPLUNK_ON_CALL_API_KEY='' SPLUNK_ON_CALL_API_ID='' yarn start

This will proxy the request by adding X-VO-Api-Id and X-VO-Api-Key headers with the provided values.

You can also add the values in your helm template:

# backend-secret.yaml
stringData:
  # ...
  SPLUNK_ON_CALL_API_ID: { { .Values.auth.splunkOnCallApiId } }
  SPLUNK_ON_CALL_API_KEY: { { .Values.auth.splunkOnCallApiKey } }

To enable it you need to provide them in the chart's values:

# values.yaml
auth:
  # ...
  splunkOnCallApiId: h
  splunkOnCallApiKey: h
0.4.24

21 days ago

0.4.23

24 days ago

0.4.23-next.1

1 month ago

0.4.23-next.0

1 month ago

0.4.22

1 month ago

0.4.21

2 months ago

0.4.20

2 months ago

0.4.20-next.2

2 months ago

0.4.20-next.1

2 months ago

0.4.20-next.0

2 months ago

0.4.19

3 months ago

0.4.19-next.3

3 months ago

0.4.19-next.2

3 months ago

0.4.19-next.1

3 months ago

0.4.19-next.0

4 months ago

0.4.18

4 months ago

0.4.18-next.2

4 months ago

0.4.18-next.1

4 months ago

0.4.18-next.0

5 months ago

0.4.17

5 months ago

0.4.17-next.3

5 months ago

0.4.17-next.2

5 months ago

0.4.17-next.1

5 months ago

0.4.14-next.0

8 months ago

0.4.14-next.2

7 months ago

0.4.14-next.1

7 months ago

0.4.15-next.2

6 months ago

0.4.15-next.1

6 months ago

0.4.15-next.0

7 months ago

0.4.13-next.2

8 months ago

0.4.13-next.3

8 months ago

0.4.13-next.1

8 months ago

0.4.10-next.1

9 months ago

0.4.10-next.0

10 months ago

0.4.9-next.2

10 months ago

0.4.9-next.1

10 months ago

0.4.10

9 months ago

0.4.15

6 months ago

0.4.16

6 months ago

0.4.13

8 months ago

0.4.14

7 months ago

0.4.11

9 months ago

0.4.12

9 months ago

0.4.17-next.0

6 months ago

0.4.9

10 months ago

0.4.12-next.0

9 months ago

0.4.9-next.0

11 months ago

0.4.8

11 months ago

0.4.8-next.3

11 months ago

0.4.8-next.2

11 months ago

0.4.7-next.1

1 year ago

0.4.7-next.2

1 year ago

0.4.8-next.1

12 months ago

0.4.8-next.0

12 months ago

0.4.7

12 months ago

0.4.7-next.0

1 year ago

0.4.6-next.3

1 year ago

0.4.6

1 year ago

0.4.6-next.1

1 year ago

0.4.6-next.0

1 year ago

0.4.6-next.2

1 year ago

0.4.5-next.1

1 year ago

0.4.5-next.2

1 year ago

0.4.5-next.0

1 year ago

0.4.5

1 year ago

0.4.4

1 year ago

0.4.3-next.1

1 year ago

0.4.3-next.2

1 year ago

0.4.4-next.2

1 year ago

0.4.4-next.1

1 year ago

0.4.4-next.0

1 year ago

0.4.3

1 year ago

0.4.1-next.2

1 year ago

0.4.1-next.1

1 year ago

0.4.1-next.0

1 year ago

0.4.1-next.4

1 year ago

0.4.1-next.3

1 year ago

0.3.35-next.0

2 years ago

0.4.3-next.0

1 year ago

0.4.0-next.1

2 years ago

0.4.1

1 year ago

0.4.0

1 year ago

0.4.2

1 year ago

0.3.34

2 years ago

0.3.34-next.0

2 years ago

0.3.34-next.1

2 years ago

0.3.34-next.2

2 years ago

0.3.33-next.3

2 years ago

0.3.33-next.1

2 years ago

0.3.33-next.2

2 years ago

0.3.33-next.0

2 years ago

0.3.33

2 years ago

0.3.30-next.1

2 years ago

0.3.30-next.0

2 years ago

0.3.31-next.0

2 years ago

0.3.31-next.1

2 years ago

0.3.31-next.2

2 years ago

0.3.31-next.3

2 years ago

0.3.32-next.1

2 years ago

0.3.32-next.0

2 years ago

0.3.31

2 years ago

0.3.30

2 years ago

0.3.32

2 years ago

0.3.29

2 years ago

0.3.29-next.1

2 years ago

0.3.29-next.0

2 years ago

0.3.29-next.2

2 years ago

0.3.28-next.1

2 years ago

0.3.28-next.0

2 years ago

0.3.26-next.0

2 years ago

0.3.28

2 years ago

0.3.27

2 years ago

0.3.26

2 years ago

0.3.25

2 years ago

0.3.22-next.0

2 years ago

0.3.20-next.0

2 years ago

0.3.20

2 years ago

0.3.24

2 years ago

0.3.23

2 years ago

0.3.22

2 years ago

0.3.21

2 years ago

0.3.19

2 years ago

0.3.18

2 years ago

0.3.17

2 years ago

0.3.16

2 years ago

0.3.21-next.0

2 years ago

0.3.15

2 years ago

0.3.14

3 years ago

0.3.13

3 years ago

0.3.12

3 years ago

0.3.11

3 years ago

0.3.10

3 years ago

0.3.9

3 years ago

0.3.8

3 years ago

0.3.7

3 years ago

0.3.6

3 years ago

0.3.5

3 years ago

0.3.4

3 years ago

0.3.3

3 years ago

0.3.2

3 years ago

0.3.1

3 years ago

0.3.0

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago