Improves the module examples/complete

Author: MrWolong

.gitignore

@@ -1,29 +1,24 @@
-# Local .terraform directories
-**/.terraform/*
-
-# .tfstate files
+# Compiled files
 *.tfstate
-*.tfstate.*
+*.tfstate.backup
+*.terraform.*
 
-# Crash log files
-crash.log
+# Module directory
+.terraform/
 
-# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
-# .tfvars files are managed as part of configuration and so should be included in
-# version control.
-#
-# example.tfvars
+# terraform log
+*.log
 
-# Ignore override files as they are usually used to override resources locally and so
-# are not checked in
-override.tf
-override.tf.json
-*_override.tf
-*_override.tf.json
+# auto-generated key pair file
+*.pem
 
-# Include override files you do wish to add to version control using negated pattern
-#
-# !example_override.tf
+# tools files
+.DS_Store
+.idea
 
-# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
-# example: *tfplan*
+# others
+*.bak
+*.bk
+**/.terraform/*
+.terraform.lock.hcl
+.terraform.tfstate.lock.info

README.md

@@ -5,7 +5,7 @@ terraform-alicloud-prometheus
 
 English | [简体中文](https://github.com/terraform-alicloud-modules/terraform-alicloud-prometheus/blob/master/README-CN.md)
 
-Terraform module which creates Mybase and its account on Alibaba Cloud.
+Terraform module which creates monitor of Prometheus on Alibaba Cloud.
 
 These types of resources are supported:
 

examples/complete/.terraform.lock.hcl

@@ -14,6 +14,15 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+This example provides the tf variables file in the folder `tfvars`. If you want to create or update this example,
+you can run this example as the following commands:
+```bash
+$ terraform plan -var-file=tfvars/01-update.tfvars
+$ terraform apply -var-file=tfvars/01-update.tfvars
+```
+
+Also, you can add more variables files in the folder `tfvars`.
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 

examples/complete/README.md

@@ -1,26 +1,45 @@
-resource "alicloud_arms_alert_contact" "default" {
-  alert_contact_name = "example_value"
-  email              = "[email protected]"
+data "alicloud_cs_managed_kubernetes_clusters" "default" {
 }
 
-data "alicloud_cs_managed_kubernetes_clusters" "default" {
-  name_regex = "tf_Acc"
+resource "alicloud_arms_alert_contact" "default" {
+  alert_contact_name = var.alert_contact_name
+  email              = var.email
 }
 
 module "example" {
-  source                   = "../.."
-  create                   = true
-  alert_name               = "tf_prometheus_alert_name"
-  alert_expression         = "node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10"
-  alert_message            = "node available memory is less than 10%"
-  prometheus_type          = "Kubernetes component alert"
-  alert_contact_group_name = "tf-arms-contract-group-name"
-  dispatch_rule_name       = "tf-dispatch-rule-name"
-  group_wait_time          = 5
-  group_interval           = 15
-  repeat_interval          = 100
-  notification_name        = "tf-arms-notification"
+  source = "../.."
+
+  #alicloud_arms_alert_contact_group
+  create = true
+
+  alert_contact_group_name = var.alert_contact_group_name
   contact_ids              = [alicloud_arms_alert_contact.default.id]
-  cluster_id               = data.alicloud_cs_managed_kubernetes_clusters.default.id
-  match_expressions        = [{ key = "aliyun_arms_involvedObject_kind", value = "app", operator = "eq" }]
+
+  #alicloud_arms_dispatch_rule
+  dispatch_rule_name = var.dispatch_rule_name
+  dispatch_type      = var.dispatch_type
+  group_wait_time    = var.group_wait_time
+  group_interval     = var.group_interval
+  repeat_interval    = var.repeat_interval
+  grouping_fields    = var.grouping_fields
+  match_expressions = [
+    {
+      key      = "_aliyun_arms_alert_name",
+      value    = "tf-testacc-app",
+      operator = "eq"
+    }
+  ]
+  notify_type       = var.notify_type
+  notification_name = var.notification_name
+  notify_channels   = var.notify_channels
+
+  #alicloud_arms_prometheus_alert_rule
+  alert_name        = "tf-testacc-alert"
+  cluster_id        = data.alicloud_cs_managed_kubernetes_clusters.default.clusters.0.id
+  alert_expression  = "node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10"
+  alert_message     = "node available memory is less than 10%"
+  alert_duration    = "1"
+  alert_notify_type = var.alert_notify_type
+  prometheus_type   = "alert"
+
 }

examples/complete/main.tf

@@ -0,0 +1,4 @@
+output "this_prometheus_alert_rule" {
+  description = "The alert rule ID of prometheus."
+  value       = module.example.this_prometheus_alert_rule
+}

examples/complete/outputs.tf

@@ -0,0 +1,27 @@
+#alicloud_arms_alert_contact
+alert_contact_name = "update-tf-testacc-user"
+email              = "[email protected]"
+
+#alicloud_arms_alert_contact_group
+alert_contact_group_name = "update-tf-testacc-group"
+
+#alicloud_arms_dispatch_rule
+dispatch_rule_name = "update-tf-testacc-rule"
+dispatch_type      = "DISCARD_ALERT"
+group_wait_time    = 20
+group_interval     = 20
+repeat_interval    = 20
+grouping_fields    = ["alertname"]
+match_expressions = [
+  {
+    key      = "_aliyun_arms_alert_name",
+    value    = "update-tf-testacc-app",
+    operator = "eq"
+  }
+]
+notify_type       = "ARMS_CONTACT"
+notification_name = "update-tf-testacc-notification"
+notify_channels   = ["email"]
+
+#alicloud_arms_prometheus_alert_rule
+alert_notify_type = "DISPATCH_RULE"

examples/complete/tfvars/01-update.tfvars

@@ -0,0 +1,97 @@
+#alicloud_arms_alert_contact
+variable "alert_contact_name" {
+  description = "The name of the alert contact."
+  type        = string
+  default     = "tf-testacc-user"
+}
+
+variable "email" {
+  description = "The email address of the alert contact."
+  type        = string
+  default     = "[email protected]"
+}
+
+#alicloud_arms_alert_contact_group
+variable "alert_contact_group_name" {
+  description = "The name of arms contract group."
+  type        = string
+  default     = "tf-testacc-group"
+}
+
+#alicloud_arms_dispatch_rule
+variable "dispatch_rule_name" {
+  description = "The rule name of dispatch."
+  type        = string
+  default     = "tf-testacc-rule"
+}
+
+variable "dispatch_type" {
+  description = "The type of dispatch."
+  type        = string
+  default     = "CREATE_ALERT"
+}
+
+variable "group_wait_time" {
+  description = "The waiting time of arms contract group."
+  type        = number
+  default     = 10
+}
+
+variable "group_interval" {
+  description = "The interval time of arms contract group."
+  type        = number
+  default     = 10
+}
+
+variable "repeat_interval" {
+  description = "The repeat interval time of arms contract group."
+  type        = number
+  default     = 10
+}
+
+variable "grouping_fields" {
+  description = "The files of arms contract group."
+  type        = list(string)
+  default     = ["CreateDispatchRuleValue"]
+}
+
+variable "match_expressions" {
+  description = "The lable of match expresoins."
+  type = list(object({
+    key      = string
+    value    = string
+    operator = string
+  }))
+  default = [
+    {
+      key      = "_aliyun_arms_alert_name",
+      value    = "tf-testacc-app",
+      operator = "eq"
+    }
+  ]
+}
+
+variable "notify_type" {
+  description = "The type of the alert contact. Valid values: ARMS_CONTACT: contact. ARMS_CONTACT_GROUP: contact group."
+  type        = string
+  default     = "ARMS_CONTACT_GROUP"
+}
+
+variable "notification_name" {
+  description = "The name of arms notification."
+  type        = string
+  default     = "tf-testacc-notification"
+}
+
+variable "notify_channels" {
+  description = "The name of arms notification."
+  type        = list(string)
+  default     = ["dingTalk"]
+}
+
+#alicloud_arms_prometheus_alert_rule
+variable "alert_notify_type" {
+  description = "The notify type of prometheus."
+  type        = string
+  default     = "ALERT_MANAGER"
+}

examples/complete/variables.tf

@@ -26,11 +26,10 @@ resource "alicloud_arms_dispatch_rule" "arms_dispatch_rule" {
       }
     }
   }
-
   notify_rules {
     notify_objects {
       notify_object_id = alicloud_arms_alert_contact_group.arms_alert_contact_group.0.id
-      notify_type      = "ARMS_CONTACT_GROUP"
+      notify_type      = var.notify_type
       name             = var.notification_name
     }
     notify_channels = var.notify_channels
@@ -43,7 +42,7 @@ resource "alicloud_arms_prometheus_alert_rule" "arms_prometheus_alert_rule" {
   cluster_id                 = var.cluster_id
   expression                 = var.alert_expression
   message                    = var.alert_message
-  duration                   = 1
+  duration                   = var.alert_duration
   notify_type                = var.alert_notify_type
   dispatch_rule_id           = alicloud_arms_dispatch_rule.arms_dispatch_rule.0.id
   type                       = var.prometheus_type