opsgenie-team

Deprecated

This module is deprecated and will be archived on January 17, 2026. Please see the pinned issue for details and migration guidance.

Historical Description

This component provisions Opsgenie teams and related services, rules, and 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.

Opsgenie is now part of Atlassian, so you need to make sure you are creating an Opsgenie API Key, which looks like abcdef12-3456-7890-abcd-ef0123456789 and not an Atlassian API key, which looks like:

ATAfT3xFfGF0VFXAfl8EmQNPVv1Hlazp3wsJgTmM8Ph7iP-RtQyiEfw-fkDS2LvymlyUOOhc5XiSx46vQWnznCJolq-GMX4KzdvOSPhEWr-BF6LEkJQC4CSjDJv0N7d91-0gVekNmCD2kXY9haUHUSpO4H7X6QxyImUb9VmOKIWTbQi8rf4CF28=63CB21B9

Generate an API Key by going to Settings -> API key management on your Opsgenie control panel, which will have an address like https://<your-org>.app.opsgenie.com/settings/api-key-management, and click the "Add new API key" button.

Once you have the key, test it with 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 Free or Essentials in the plan, then you won't be able to use this component.

Getting Started

Stack Level: Global

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 from webapp
/v1/ - the oldest and furthest from the live UI.

Cannot create users

This module does not create users. Users must have already been created to be added to a team.

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

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 and v2 a service_incident_rule object has serviceId as type string, in webapp this becomes serviceIds of type list(string)
Opsgenie Provider appears to be inconsistent with how it uses time_restriction:
- restrictions for type weekday-and-time-of-day
- restriction for type time-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 of Europe/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 to Atlantic/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 for Asia/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

See OpsGenie in the Reference Architecture

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

create_only_integrations_enabled (bool) optional

Whether to reuse all existing resources and only create new integrations

Default value: false

datadog_integration_enabled (bool) optional

Whether to enable Datadog integration with opsgenie (datadog side)

Default value: true

escalations (map(any)) optional

Escalations to configure and create for the team.

Default value: { }

integrations (map(any)) optional

API Integrations for the team. If not specified, datadog is assumed.

Default value: { }

integrations_enabled (bool) optional

Whether to enable the integrations submodule or not

Default value: true

kms_key_arn (string) optional

AWS KMS key used for writing to SSM

Default value: "alias/aws/ssm"

members (set(any)) optional

Members as objects with their role within the team.

Default value: [ ]

routing_rules (any) optional

Routing Rules for the team

Default value: null

schedules (map(any)) optional

Schedules to create for the team

Default value: { }

services (map(any)) optional

Services to create and register to the team.

Default value: { }

ssm_parameter_name_format (string) optional

SSM parameter name format

Default value: "/%s/%s"

ssm_path (string) optional

SSM path

Default value: "opsgenie"

team_naming_format (string) optional

OpsGenie Team Naming Format

Default value: "%s_%s"

team_options optional

Configure the team options.
See opsgenie_team Terraform resource documentation for more details.

Type:

object({
description              = optional(string)
ignore_members           = optional(bool, false)
delete_default_resources = optional(bool, false)
})

Default value: { }

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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 be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

escalation: Escalation rules created
integration: Integrations created
routing: Routing rules created
team_id: Team ID
team_members: Team members
team_name: Team Name

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 4.9.0, < 6.0.0
datadog, version: >= 3.3.0
opsgenie, version: >= 0.6.7

Providers

aws, version: >= 4.9.0, < 6.0.0
datadog, version: >= 3.3.0
opsgenie, version: >= 0.6.7

Modules

Name	Version	Source	Description
`datadog_configuration`	v1.535.11	`github.com/cloudposse-terraform-components/aws-datadog-credentials//src/modules/datadog_keys`	n/a
`escalation`	latest	`./modules/escalation`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`integration`	latest	`./modules/integration`	n/a
`members_merge`	1.0.2	`cloudposse/config/yaml//modules/deepmerge`	n/a
`routing`	latest	`./modules/routing`	n/a
`schedule`	0.16.0	`cloudposse/incident-management/opsgenie//modules/schedule`	n/a
`service`	0.16.0	`cloudposse/incident-management/opsgenie//modules/service`	n/a
`team`	0.16.0	`cloudposse/incident-management/opsgenie//modules/team`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

datadog_integration_opsgenie_service_object.fake_service_name (resource)

Data Sources

The following data sources are used by this module:

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)

Deprecated​

Historical Description​

Usage​

Pre-requisites​

Getting Started​

ClickOps Work​

Known Issues​

Different API Endpoints in Use​

Cannot create users​

Cannot Add dependent Services​

Cannot Add Stakeholders​

No Resource to create Slack Integration​

Out of Date Terraform Docs​

GMT Style Timezones​

Related How-to Guides​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Deprecated

Historical Description

Usage

Pre-requisites

Getting Started

ClickOps Work

Known Issues

Different API Endpoints in Use

Cannot create users

Cannot Add dependent Services

Cannot Add Stakeholders

No Resource to create Slack Integration

Out of Date Terraform Docs

GMT Style Timezones

Related How-to Guides

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources