Module: `incident-management`

Terraform module to provision Opsgenie resources using the Opsgenie provider. The provider needs to be configured with the proper credentials before it can be used. It consist of root module which is only here as an example but can be used as a combination of all submodules. Submodules can also be combined to abstract away complexity of setting up for example a team escalation.

Introduction

Available modules:

Alert Policy
API Integration
Config
Escalation
Integration Action (advanced feature — not available to all OpsGenie plans)
Notification Policy
Team
Team Routing Rule
User
Service
Service Incident Rule

Note: Root module is just an example that uses all of submodules.

Note: See the Advanced Features Example for features only available to some OpsGenie plans.

Usage

Here's how to invoke team module in your projects

module "team-name" {
  source  = "cloudposse/incident-management/opsgenie//modules/team"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  team = {
    name        = "team-name"
    description = "team-description"
  }
}

Examples

Here are examples of using the module:

complete - complete example of using this module

Submodules examples:

alert_policy
api_integration
escalation
integration_action (advanced feature — not available to all OpsGenie plans)
notification_policy
team
team_routing_rule
user

Here is an example of using the config module, which incorporates all resource declarations into a single module:

config

Here are automated tests for the examples using bats and Terratest (which tests and provisions the examples):

test

Variables

Required Variables

Optional Variables

alert_policy (map) optional

Opsgenie Alert Policy configuration

Default value: { }

api_integration (map(any)) optional

Opsgenie API Integration configuration

Default value: { }

escalation (map) optional

Opsgenie Escalation configuration

Default value: { }

integration_action (map) optional

Opsgenie Integration Action configuration

Default value: { }

notification_policy (map) optional

Opsgenie Notification Policy configuration

Default value: { }

opsgenie_provider_api_key (string) optional

The API Key for the Opsgenie Integration. If omitted, the OPSGENIE_API_KEY environment variable is used

Default value: ""

service (map) optional

Opsgenie Service configuration

Default value: { }

service_incident_rule (map) optional

Opsgenie Service Incident Rule configuration

Default value: { }

team (map) optional

Opsgenie Team configuration

Default value: { }

team_routing_rule (map) optional

Opsgenie Team Routing Rule configuration

Default value: { }

user (map) optional

Opsgenie User configuration

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

alert_policy_filter: Filters of the Opsgenie Alert Policy
alert_policy_id: The ID of the Opsgenie Alert Policy
alert_policy_name: Name of the Opsgenie Alert Policy
alert_policy_priority: Priority of the Opsgenie Alert Policy
alert_policy_responders: Responders of the Opsgenie Alert Policy.
alert_policy_tags: Tags of the Opsgenie Alert Policy
api_integration_api_key: API key of the created integration
api_integration_id: The ID of the Opsgenie API Integration
api_integration_name: The name of the Opsgenie API Integration
escalation_id: The ID of the Opsgenie Escalation
escalation_name: Name of the Opsgenie Escalation
integration_action_id: The ID of the Opsgenie Integration Action
notification_policy_id: The ID of the Opsgenie Notification Policy
notification_policy_name: The name of the Opsgenie Notification Policy
service_id: The ID of the Opsgenie Service
service_incident_rule_id: The ID of the Opsgenie Service Incident Rule
service_name: The name of the Opsgenie Service
team_id: The ID of the Opsgenie Team
team_name: The name of the Opsgenie Team
team_routing_rule_id: The ID of the Opsgenie Team Routing Rule
team_routing_rule_name: The name of the Opsgenie Team Routing Rule
user_id: The ID of the Opsgenie User
user_name: The name of the Opsgenie User

Dependencies

Requirements

terraform, version: >= 0.13.0
opsgenie, version: >= 0.4

Modules

Name	Version	Source	Description
`alert_policy`	latest	`./modules/alert_policy`	n/a
`api_integration`	latest	`./modules/api_integration`	n/a
`escalation`	latest	`./modules/escalation`	n/a
`integration_action`	latest	`./modules/integration_action`	n/a
`notification_policy`	latest	`./modules/notification_policy`	n/a
`service`	latest	`./modules/service`	n/a
`service_incident_rule`	latest	`./modules/service_incident_rule`	n/a
`team`	latest	`./modules/team`	n/a
`team_routing_rule`	latest	`./modules/team_routing_rule`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`user`	latest	`./modules/user`	n/a

Module: incident-management

Introduction​

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Modules​

Module: `incident-management`

Introduction

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Modules