Repository files navigation

• Website:https://registry.terraform.io/providers/PagerDuty/pagerduty/latest
• Documentation:https://registry.terraform.io/providers/PagerDuty/pagerduty/latest/docs
• Terraform Gitter:
• Mailing list:Terraform Google Groups

PagerDuty is an alarm aggregation and dispatching service for system administrators and support teams. It collects alerts from your monitoring tools, gives you an overall view of all of your monitoring alarms, and alerts an on duty engineer if there’s a problem. The Terraform Pagerduty provider is a plugin for Terraform that allows for the management of PagerDuty resources using HCL (HashiCorp Configuration Language).

• Terraform >= 1.1.0
• Go 1.21 (to build the provider plugin)

Clone repository to:$GOPATH/src/github.com/PagerDuty/terraform-provider-pagerduty

$ mkdir -p$GOPATH/src/github.com/PagerDuty;cd$GOPATH/src/github.com/PagerDuty$ git clone git@github.com:PagerDuty/terraform-provider-pagerduty

Enter the provider directory and build the provider

$cd$GOPATH/src/github.com/PagerDuty/terraform-provider-pagerduty$ make build...$$GOPATH/bin/terraform-provider-pagerduty...

This will build the provider and put the provider binary in the$GOPATH/bin directory.

Please refer to Terraform docs forPagerDuty Providerfor examples on how to use the provider and detailed documentation about the Resources and Data Sources the provider has.

Thego-pagerduty library relies on various APIs to interact with PagerDuty's resources. However, some of these APIs lack efficient ways to query specific resources by their attributes. When an implementation in the Terraform Provider requires such logic, the library lists all resources of a specific entity and performs a lookup in memory. This can result in inefficient use of the APIs, especially when dealing with a large number of resources, as the repetitive API calls for listing resource definitions can lead to significant time consumption and performance penalties. To address this issue, we have introduced caching to improve the user experience when interacting with Terraform resources that rely on API calls to list all available data for a specific entity, and then perform a lookup by attribute value in memory. With this improvement, the Terraform Provider users can expect better performance and faster response times when working with PagerDuty's resources.

• pagerduty_team_membership
• pagerduty_user_contact_method
• pagerduty_user_notification_rule
• pagerduty_user

• In memory.
• MongoDB.

Before developing the provider, ensure that you have go correctly installed.

• InstallGo on your machine (version 1.11+ isrequired).
• Correctly setup aGOPATH, as well as adding$GOPATH/bin to your$PATH.

Make changes to the PagerDuty provider and post a pull request for review.

1. Create a fork of theupstream repositoryhttps://github.com/PagerDuty/terraform-provider-pagerduty
2. Clone the neworigin repository to your local go src path:$GOPATH/src/github.com/<your-github-username>/terraform-provider-pagerduty
3. optionally make development easier by setting theupstream repository

   $ git remote add upstream git@github.com:PagerDuty/terraform-provider-pagerduty.git

4. Make any changes on your local machine and post a PR to theupstream repository

Note: Development overrides work only in Terraform v0.14 and later. Using a dev_overrides block in your CLI configuration will cause Terraform v0.13 to reject the configuration as invalid.

1. Build the provider with your latest changes. (SeeBuilding the Provider)
2. Override the pagerduty provider with your local build. (SeeDevelopment Overrides for Provider Developers)
   • Create the file$HOME/.terraformrc and paste the following content into it. Be sure to change the path to wherever your binary is located. It is currently set to the default for go builds.

   provider_installation {dev_overrides {"pagerduty/pagerduty" ="/<ABSOLUTE_PATH_TO>/<YOUR_HOME_PATH>/go/bin"   }direct {}}

3. Goto a local terraform module and start running terraform. (SeeUsing the Provider). You may need to first install the latest module and providerversions allowed within the new configured constraints. Verify with the below warning message.

   $ terraform init -upgrade$ terraform plan...│ Warning: Provider development overrides arein effect

4. Seeapi_url_override from Terraform docs forPagerDuty Provider to set a custom proxy endpoint as PagerDuty client api url overriding service_region setup.

Modify thego.mod file using aGo module replacement for `github.com/heimweh/go-pagerduty:

$ go mod edit -replace github.com/heimweh/go-pagerduty=/PATH/TO/LOCAL/github.com/<USERNAME>/<REPO>

Or update the file directly:

replace github.com/heimweh/go-pagerduty => /PATH/TO/LOCAL/go-pagerduty

Update vendored dependencies or configure compiler to prefer using downloaded modules based ongo.mod file:

$ export GOFLAGS="-mod=mod"

Or:

$ go mod vendor

1. SeeDebugging Terraform. Either add this to your shell's profile(example:~/.bashrc), or just execute these commands:

   export TF_LOG=traceexport TF_LOG_PATH="/PATH/TO/YOUR/LOG_FILE.log"

2. stream logs

   $ tail -f /PATH/TO/YOUR/LOG_FILE.log

In addition to thelog levels provided by Terraform, namelyTRACE,DEBUG,INFO,WARN, andERROR (in descending order of verbosity), the PagerDuty Provider introduces an extra level calledSECURE. This level offers verbosity similar to Terraform's debug logging level, specifically for the output of API calls and HTTP request/response logs. The key difference is that API keys within the request's Authorization header will be obfuscated, revealing only the last four characters. An example is provided below:

---[ REQUEST ]---------------------------------------GET /teams/DER8RFS HTTP/1.1Accept: application/vnd.pagerduty+json;version=2Authorization:<OBSCURED>kCjQContent-Type: application/jsonUser-Agent: (darwin arm64) Terraform/1.5.1

To enable theSECURE log level, you must set two environment variables:

• TF_LOG=INFO
• TF_LOG_PROVIDER_PAGERDUTY=SECURE

In order to test the provider, you can simply runmake test.

$ maketest

In order to run the full suite of Acceptance tests, runmake testacc. Running the acceptance tests requiresthat thePAGERDUTY_TOKEN environment variable be set to a valid API Token and that thePAGERDUTY_USER_TOKEN environment variable be set to a valid API User Token. Many tests alsorequire that theEmail Domain Restriction featureeither be disabledor be configured to includefoo.test as an allowed domain.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

Additional Note: In order for the tests on the Slack Connection resources to pass you will need valid Slack workspace and channel IDs from aSlack workspace connected to your PagerDuty account.

Run a specific subset of tests by name use theTESTARGS="-run TestName" option which will run all test functions with "TestName" in their name.

$ make testacc TESTARGS="-run TestAccPagerDutyTeam"

Some tests require additional environment variables to be set to enable them due to account restrictions on certainfeatures. Similarly toTF_ACC,the value of the environment variable is not relevant.

For example:

PAGERDUTY_ACC_INCIDENT_WORKFLOWS=1 make testacc TESTARGS="-run PagerDutyIncidentWorkflow"PAGERDUTY_ACC_SERVICE_INTEGRATION_GENERIC_EMAIL_NO_FILTERS="user@<your_domain>.pagerduty.com" make testacc TESTARGS="-run PagerDutyServiceIntegration_GenericEmailNoFilters"PAGERDUTY_ACC_INCIDENT_CUSTOM_FIELDS=1 make testacc TESTARGS="-run PagerDutyIncidentCustomField"PAGERDUTY_ACC_LICENSE_NAME="Full User" make testacc TESTARGS="-run DataSourcePagerDutyLicense_Basic"PAGERDUTY_ACC_SCHEDULE_USED_BY_EP_W_1_LAYER=1 make testacc TESTARGS="-run PagerDutyScheduleWithTeams_EscalationPolicyDependantWithOneLayer"