docs icon indicating copy to clipboard operation
docs copied to clipboard

Terraform Provider Documentation - Add values for supported notification plugins

Open pwonson opened this issue 4 years ago • 1 comments

The values for enterprise notification plugins should be added to the terraform provider documentation with the configuration values.

Here is an example I made for the PagerDuty v2 Event plugin.

For plugin type we should add each of the names of the plugins we provide, such as type = "PagerDutyEventNotification" for the PagerDuty v2 Event plugin and the configuration map was a pain to figure out the formatting as the function to map was used and it was a lot of guessing at syntax to figure out this should be the raw values the function expected.

Providing an example such as the following would help most customers figure it out.

terraform {
  required_providers {
    rundeck = {
      source = "rundeck/rundeck"
      version = "0.4.2"
    }
  }
}
provider "rundeck" {
  url         = "XXXXXXXXX"
  api_version = "35"
  auth_token  = "XXXXXXXXX"
}

resource "rundeck_job" "bounceweb-2" {
  name              = "Bounce Web Servers 2"
  project_name      = "Test"
  node_filter_query = "tags: web"
  description       = "Restart the service daemons on all the web servers"

  command {
    shell_command = "sudo service anvils restart"
  }
  notification {
    type = "on_success"
    plugin {
      type = "PagerDutyEventNotification"
      config = ({
        "action" = "acknowledge",
        "component" = "any",
        "dedupe_key" = "xxxxx",
        "group" = "prod-datapipe",
        "images" = "https://www.rundeck.com/hubfs/icon-rundeck.svg",
        "payload_class" = "first",
        "payload_severity" = "warning",
        "payload_source" = "test",
        "payload_summary" = "test",
        "service_key" = "xxxxx",
        "service_key_storage_path" = "keys/github/pam-rundeck.pw"})
      }
    }

  }

pwonson avatar Jul 22 '21 03:07 pwonson

Good timing. I was updating these today. I'll include this.

fdevans avatar Jul 22 '21 04:07 fdevans