https://github.com/iksaif/opsgenie-notification
Rundeck notification plugin for OpsGenie
https://github.com/iksaif/opsgenie-notification
automation opsgenie plugin rundeck
Last synced: about 2 months ago
JSON representation
Rundeck notification plugin for OpsGenie
- Host: GitHub
- URL: https://github.com/iksaif/opsgenie-notification
- Owner: iksaif
- Created: 2017-05-19T08:55:45.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T18:21:53.000Z (over 2 years ago)
- Last Synced: 2025-03-30T08:11:27.538Z (3 months ago)
- Topics: automation, opsgenie, plugin, rundeck
- Language: Groovy
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Use this [notification](http://rundeck.org/docs/developer/notification-plugin-development.html)
plugin to send [alert](https://www.opsgenie.com/docs/web-api/alert-api#createAlertRequest)
events to your [OpsGenie](https://www.opsgenie.com) service.
The plugin requires one parameter:
* subject: This string will be set as the description for the generated incident.
Context variables usable in the subject line:
* `${job.id}`: Job ID.
* `${job.status}`: Job execution status (eg, FAILED, SUCCESS).
* `${job.project}`: Job project name.
* `${job.name}`: Job name.
* `${job.group}`: Job group name.
* `${job.username}`: User that executed the job.
* `${job.user.email}`: Email address of user that executed the job.
* `${job.execid}`: Job execution ID.
* `${job.retryAttempt}`: Retry attempt number.
* `${job.wasRetry}`: True if execution is retry.
## Installation
Copy the groovy script to the plugins directory:
cp src/OpsGenieNotification.groovy to $RDECK_BASE/libext
and start using it!
## Configuration
The plugin only requires the 'api_key' configuration entry. There are also a few optional configurations.
* api_key: This is the API Key to your service.
Configure the api_key in your project configuration by
adding an entry like so: $RDECK_BASE/projects/{project}/etc/project.properties
project.plugin.Notification.OpsGenieNotification.api_key=xx123049e89dd45f28ce35467a08577yz
Or configure it at the instance level: $RDECK_BASE/etc/framework.properties
framework.plugin.Notification.OpsGenieNotification.api_key=xx123049e89dd45f28ce35467a08577yz
### All options
|Option|Scope|Default|Required|Description|
|-|-|-|-|-|
|`api_key`|Any|None|Yes|Integration API Key|
|`message`|Any|`${job.status} [${job.project}] \"${job.name}\"`|Yes|Message template.|
|`description`|Any|`${job.status} [${job.project}] \"${job.name}\" run by ${job.user} (#${job.execid}) [${job.href}]`|No|Description template.|
|`alias`|Any|`${job.id}`|No|alias template.|
|`source`|Any|`${job.href}`|No|Source template.|
|`proxy_host`|Project|None|Yes|Your egress proxy host.|
|`proxy_port`|Project|None|If `proxy_host` is set|the port the network egress proxy accepts traffic on.|