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:
Here are automated tests for the examples using bats and Terratest (which tests and provisions the examples):
Requirements
Name | Version |
---|---|
terraform | >= 0.13.0 |
opsgenie | >= 0.4 |
Providers
No providers.
Modules
Name | Source | Version |
---|---|---|
alert_policy | ./modules/alert_policy | n/a |
api_integration | ./modules/api_integration | n/a |
escalation | ./modules/escalation | n/a |
integration_action | ./modules/integration_action | n/a |
notification_policy | ./modules/notification_policy | n/a |
service | ./modules/service | n/a |
service_incident_rule | ./modules/service_incident_rule | n/a |
team | ./modules/team | n/a |
team_routing_rule | ./modules/team_routing_rule | n/a |
this | cloudposse/label/null | 0.25.0 |
user | ./modules/user | n/a |
Resources
No resources.
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 |
alert_policy | Opsgenie Alert Policy configuration | map | {} | no |
api_integration | Opsgenie API Integration configuration | map(any) | {} | 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 |
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 |
escalation | Opsgenie Escalation configuration | map | {} | 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 |
integration_action | Opsgenie Integration Action configuration | map | {} | 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 |
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 |
notification_policy | Opsgenie Notification Policy configuration | map | {} | no |
opsgenie_provider_api_key | The API Key for the Opsgenie Integration. If omitted, the OPSGENIE_API_KEY environment variable is used | string | "" | 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 |
service | Opsgenie Service configuration | map | {} | no |
service_incident_rule | Opsgenie Service Incident Rule configuration | map | {} | 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 | Opsgenie Team configuration | map | {} | no |
team_routing_rule | Opsgenie Team Routing Rule configuration | map | {} | 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 |
user | Opsgenie User configuration | map | {} | no |
Outputs
Name | Description |
---|---|
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 |