This plugin displays Splunk On-Call (formerly VictorOps) information associated with an entity.
It also provides the ability to trigger new incidents to specific users and/or specific teams from within Backstage.
This plugin requires that entities feature either a `splunk.com/on-call-team` or a `splunk.com/on-call-routing-key` annotation. See below for further details.
This plugin provides:
- A list of incidents
- A way to trigger a new incident to specific users and/or teams
To suppress the rendering of the actionable create-acknowledge-resolve incident buttons and UI controls, the `EntitySplunkOnCallCard` can also be instantiated in `readOnly` mode:
```ts
<EntitySplunkOnCallCardreadOnly/>
```
## Client configuration
In order to be able to perform certain actions (create-acknowledge-resolve an action), you need to provide a REST Endpoint.
To enable the REST Endpoint integration you can go on https://portal.victorops.com/ inside Integrations > 3rd Party Integrations > REST – Generic.
You can now copy the URL to notify: `<SPLUNK_ON_CALL_REST_ENDPOINT>/$routing_key`
In `app-config.yaml`:
```yaml
splunkOnCall:
eventsRestEndpoint:<SPLUNK_ON_CALL_REST_ENDPOINT>
```
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:
```yaml
# app-config.yaml
proxy:
# ...
'/splunk-on-call':
target:https://api.victorops.com/api-public
headers:
X-VO-Api-Id:${SPLUNK_ON_CALL_API_ID}
X-VO-Api-Key:${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]`.
**WARNING**: In current implementation, the Splunk OnCall plugin requires the `/splunk-on-call` proxy endpoint be exposed by the Backstage backend as an unprotected endpoint, in effect enabling Splunk OnCall API access using the configured `SPLUNK_ON_CALL_API_KEY` for any user or process with access to the `/splunk-on-call` Backstage backend endpoint. See below for further configuration options enabling protection of this endpoint. If you regard this as problematic, consider using the plugin in `readOnly` mode (`<EntitySplunkOnCallCard readOnly />`) using the following proxy configuration:
```yaml
proxy:
'/splunk-on-call':
target:https://api.victorops.com/api-public
headers:
X-VO-Api-Id:${SPLUNK_ON_CALL_API_ID}
X-VO-Api-Key:${SPLUNK_ON_CALL_API_KEY}
# prohibit the `/splunk-on-call` proxy endpoint from servicing non-GET requests
allowedMethods:['GET']
```
### Adding your team name to the entity annotation
The information displayed for each entity is based on either an associated team name or an associated routing key.
To use this plugin for an entity, the entity must be labeled with either a `splunk.com/on-call-team` or a `splunk.com/on-call-routing-key` annotation.
For example, by specifying a `splunk.com/on-call-team`, the plugin displays Splunk On-Call data associated with the specified team:
Alternatively, by specifying a `splunk.com/on-call-routing-key`, the plugin displays Splunk On-Call data associated with _each_ of the teams associated with the specified routing key:
To be able to use the REST Endpoint seen above, you must have created a routing key with the **same name** as the provided team.
You can create a new routing key on https://portal.victorops.com/ by going to Settings > Routing Keys.
You can read [Create & Manage Alert Routing Keys](https://help.victorops.com/knowledge-base/routing-keys/#routing-key-tips-tricks) for further information.
## Providing the API key and API id
In order for the client to make requests to the [Splunk On-Call API](https://portal.victorops.com/public/api-docs.html#/) it needs an [API ID and an API Key](https://help.victorops.com/knowledge-base/api/).
Then start the backend passing the values as an environment variable:
To enable it you need to provide them in the chart's values:
```yaml
# values.yaml
auth:
# ...
splunkOnCallApiId:h
splunkOnCallApiKey:h
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-splunk-on-call` instead.
"deprecated":"This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-splunk-on-call instead."
}
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
blam