Component: opsgenie-team
This component is responsible for provisioning Opsgenie teams and related services, rules, schedules.
Usage
Pre-requisites
You need an API Key stored in /opsgenie/opsgenie_api_key
of SSM, this is configurable using the ssm_parameter_name_format
and ssm_path
variables.
Generate an API Key by going here and Clicking Create API Token.
Once you have the key, you'll need to test it with a curl to verify that you are at least on a Standard plan with OpsGenie:
curl -X GET 'https://api.opsgenie.com/v2/account'
--header "Authorization: GenieKey $API_KEY"
The result should be something similar to below:
{
"data": {
"name": "opsgenie",
"plan": {
"maxUserCount": 1500,
"name": "Enterprise",
...
}
If you see anything other than Standard
or Enterprise
in the plan, then you won't be able
to use this component. You can see more details here:
OpsGenie pricing/features
Getting Started
Stack Level: Global
Here's an example snippet for how to use this component.
This component should only be applied once as the resources it creates are regional, but it works with integrations. This is typically done via the auto or corp stack (e.g. gbl-auto.yaml
).
# 9-5 Mon-Fri
business_hours: &business_hours
type: "weekday-and-time-of-day"
restrictions:
- start_hour: 9
start_min: 00
start_day: "monday"
end_hour: 17
end_min: 00
end_day: "friday"
# 9-5 Every Day
waking_hours: &waking_hours
type: "time-of-day"
restrictions:
- start_hour: 9
start_min: 00
end_hour: 17
end_min: 00
# This is a partial incident mapping, we use this as a base to add P1 & P2 below. This is not a complete mapping as there is no P0
priority_level_to_incident: &priority_level_to_incident
enabled: true
type: incident
priority: P1
order: 1
notify: # if omitted, this will default to the default schedule
type: schedule
name: default
criteria:
type: "match-all-conditions"
conditions:
- field: priority
operation: equals
expected_value: P0
p1: &p1_is_incident
<<: *priority_level_to_incident
priority: P1
criteria:
type: "match-all-conditions"
conditions:
- field: priority
operation: equals
expected_value: P1
p2: &p2_is_incident
<<: *priority_level_to_incident
priority: P2
criteria:
type: "match-all-conditions"
conditions:
- field: priority
operation: equals
expected_value: P2
components:
terraform:
# defaults
opsgenie-team-defaults:
metadata:
type: abstract
component: opsgenie-team
vars:
schedules:
london_schedule:
enabled: false
description: "London Schedule"
timezone: "Europe/London"
# Routing Rules determine how alerts are routed to the team,
# this includes priority changes, incident mappings, and schedules.
routing_rules:
london_schedule:
enabled: false
type: alert
# https://support.atlassian.com/opsgenie/docs/supported-timezone-ids/
timezone: Europe/London
notify:
type: schedule # could be escalation, could be none
name: london_schedule
time_restriction: *waking_hours
criteria:
type: "match-all-conditions"
conditions:
- field: priority
operation: greater-than
expected_value: P2
# Since Incidents require a service, we create a rule for every `routing_rule` type `incident` for every service on the team.
# This is done behind the scenes by the `opsgenie-team` component.
# These rules below map P1 & P2 to incidents, using yaml anchors from above.
p1: *p1_is_incident
p2: *p2_is_incident
# New team
opsgenie-team-sre:
metadata:
type: real
component: opsgenie-team
inherits:
- opsgenie-team-defaults
vars:
enabled: true
name: sre
# These members will be added with an opsgenie_user
# To clickops members, set this key to an empty list `[]`
members:
- user: [email protected]
role: owner
escalations:
otherteam_escalation:
enabled: true
name: otherteam_escalation
description: Other team escalation
rules:
condition: if-not-acked
notify_type: default
delay: 60
recipients:
- type: team
name: otherteam
yaep_escalation:
enabled: true
name: yaep_escalation
description: Yet another escalation policy
rules:
condition: if-not-acked
notify_type: default
delay: 90
recipients:
- type: user
name: [email protected]
schedule_escalation:
enabled: true
name: schedule_escalation
description: Schedule escalation policy
rules:
condition: if-not-acked
notify_type: default
delay: 30
recipients:
- type: schedule
name: secondary_on_call
The API keys relating to the Opsgenie Integrations are stored in SSM Parameter Store and can be accessed via chamber.
AWS_PROFILE=foo chamber list opsgenie-team/<team>
ClickOps Work
- After deploying the opsgenie-team component the created team will have a schedule named after the team. This is purposely left to be clickOps’d so the UI can be used to set who is on call, as that is the usual way (not through code). Additionally We do not want a re-apply of the terraform to delete or shuffle who is planned to be on call, thus we left who is on-call on a schedule out of the component.
Known Issues
Different API Endpoints in Use
The problem is there are 3 different api endpoints in use
/webapp
- the most robust - only exposed to the UI (that we've seen)/v2/
- robust with some differences fromwebapp
/v1/
- the oldest and furthest from the live UI.
Cannot Add dependent Services
- Api Currently doesn't support Multiple ServiceIds for incident Rules
Cannot Add Stakeholders
- Track the issue: https://github.com/opsgenie/terraform-provider-opsgenie/issues/278
There isn’t a resource for datadog to create an opsgenie integration so this has to be done manually via ClickOps
- Track the issue: x
No Resource to create Slack Integration
- Track the issue: https://github.com/DataDog/terraform-provider-datadog/issues/67
Out of Date Terraform Docs
Another Problem is the terraform docs are not always up to date with the provider code.
The OpsGenie Provider uses a mix of /v1
and /v2
. This means there are many things you can only do from the UI.
Listed below in no particular order
- Incident Routing cannot add dependent services - in
v1
andv2
aservice_incident_rule
object hasserviceId
as type string, in webapp this becomesserviceIds
of typelist(string)
- Opsgenie Provider appears to be inconsistent with how it uses
time_restriction
:restrictions
for typeweekday-and-time-of-day
restriction
for typetime-of-day
Unfortunately none of this is in the terraform docs, and was found via errors and digging through source code.
Track the issue: https://github.com/opsgenie/terraform-provider-opsgenie/issues/282
GMT Style Timezones
We recommend to use the human readable timezone such as Europe/London
.
Setting a schedule to a GMT-style timezone with offsets can cause inconsistent plans.
Setting the timezone to
Etc/GMT+1
instead ofEurope/London
, will lead to permadrift as OpsGenie converts the GMT offsets to regional timezones at deploy-time. In the previous deploy, the GMT style get converted toAtlantic/Cape_Verde
.# module.routing["london_schedule"].module.team_routing_rule[0].opsgenie_team_routing_rule.this[0] will be updated in-place
~ resource "opsgenie_team_routing_rule" "this" {
id = "4b4c4454-8ccf-41a9-b856-02bec6419ba7"
name = "london_schedule"
~ timezone = "Atlantic/Cape_Verde" -> "Etc/GMT+1"
# (2 unchanged attributes hidden)Some GMT styles will not cause a timezone change on subsequent applies such as
Etc/GMT+8
forAsia/Taipei
.If the calendar date has crossed daylight savings time, the
Etc/GMT+
GMT style will need to be updated to reflect the correct timezone.
Track the issue: https://github.com/opsgenie/terraform-provider-opsgenie/issues/258
Requirements
Name | Version |
---|---|
terraform | >= 1.0.0 |
aws | >= 4.9.0 |
datadog | >= 3.3.0 |
opsgenie | >= 0.6.7 |
Providers
Name | Version |
---|---|
aws | >= 4.9.0 |
datadog | >= 3.3.0 |
opsgenie | >= 0.6.7 |
Modules
Name | Source | Version |
---|---|---|
datadog_configuration | ../datadog-configuration/modules/datadog_keys | n/a |
escalation | ./modules/escalation | n/a |
iam_roles | ../account-map/modules/iam-roles | n/a |
integration | ./modules/integration | n/a |
members_merge | cloudposse/config/yaml//modules/deepmerge | 1.0.2 |
routing | ./modules/routing | n/a |
schedule | cloudposse/incident-management/opsgenie//modules/schedule | 0.16.0 |
service | cloudposse/incident-management/opsgenie//modules/service | 0.16.0 |
team | cloudposse/incident-management/opsgenie//modules/team | 0.16.0 |
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
datadog_integration_opsgenie_service_object.fake_service_name | resource |
aws_ssm_parameter.opsgenie_api_key | data source |
aws_ssm_parameter.opsgenie_team_api_key | data source |
opsgenie_team.existing | data source |
opsgenie_user.team_members | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. | list(string) | [] | no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. | any |
| no |
create_only_integrations_enabled | Whether to reuse all existing resources and only create new integrations | bool | false | no |
datadog_integration_enabled | Whether to enable Datadog integration with opsgenie (datadog side) | bool | true | no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
escalations | Escalations to configure and create for the team. | map(any) | {} | no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . | number | null | no |
integrations | API Integrations for the team. If not specified, datadog is assumed. | map(any) | {} | no |
integrations_enabled | Whether to enable the integrations submodule or not | bool | true | no |
kms_key_arn | AWS KMS key used for writing to SSM | string | "alias/aws/ssm" | no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . | string | null | no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . | string | null | no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
members | Members as objects with their role within the team. | set(any) | [] | no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
region | AWS Region | string | n/a | yes |
routing_rules | Routing Rules for the team | any | null | no |
schedules | Schedules to create for the team | map(any) | {} | no |
services | Services to create and register to the team. | map(any) | {} | no |
ssm_parameter_name_format | SSM parameter name format | string | "/%s/%s" | no |
ssm_path | SSM path | string | "opsgenie" | no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
team | Configure the team inputs | map(any) | {} | no |
team_name | Current OpsGenie Team Name | string | null | no |
team_naming_format | OpsGenie Team Naming Format | string | "%s_%s" | no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
Outputs
Name | Description |
---|---|
escalation | Escalation rules created |
integration | Integrations created |
routing | Routing rules created |
team_id | Team ID |
team_members | Team members |
team_name | Team Name |
Related How-to Guides
- How to Add Users to a Team in OpsGenie
- How to Pass Tags Along to Datadog
- How to Onboard a New Service with Datadog and OpsGenie
- How to Create Escalation Rules in OpsGenie
- How to Setup Rotations in OpsGenie
- How to Create New Teams in OpsGenie
- How to Sign Up for OpsGenie?
- How to Implement Incident Management with OpsGenie
References
- cloudposse/terraform-aws-components - Cloud Posse's upstream component