feat: adding a simple uptime check sub-module (#67)

build/int.cloudbuild.yaml

@@ -39,6 +39,18 @@ steps:
 - id: destroy
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
   args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do destroy']
+- id: create-uptime
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestUptimeCheckModule --stage init --verbose']
+- id: apply-uptime
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestUptimeCheckModule --stage apply --verbose']
+- id: verify-uptime
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestUptimeCheckModule --stage verify --verbose']
+- id: destroy-uptime
+  name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
+  args: ['/bin/bash', '-c', 'cft test run TestUptimeCheckModule --stage destroy --verbose']
 tags:
 - 'ci'
 - 'integration'

examples/https_uptime_url_check/README.md

@@ -0,0 +1,29 @@
+# HTTPS Uptime URL Check Example
+
+This example illustrates how to use the `simple-uptime-check` module for a simple HTTPS Uptime URL check.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| email | Email address to alert if uptime check fails. | `string` | `"example-email@gmail.com"` | no |
+| hostname | The base hostname for the uptime check. | `string` | `"example-hostname.com"` | no |
+| project\_id | The ID of the project in which to provision resources. | `string` | n/a | yes |
+| uptime\_check\_display\_name | The ID of the project in which to provision resources. | `string` | `"example-uptime-check-name"` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| alert\_policy\_id | The id of the alert policy. |
+| notification\_channel\_ids | The ids of the notification channels |
+| uptime\_check\_id | The id of the uptime check. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+To provision this example, run the following from within this directory:
+- `terraform init` to get the plugins
+- `terraform plan` to see the infrastructure plan
+- `terraform apply` to apply the infrastructure build
+- `terraform destroy` to destroy the built infrastructure

examples/https_uptime_url_check/main.tf

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module "uptime-check" {
+  source = "./../../modules/simple-uptime-check"
+
+  project_id                = var.project_id
+  uptime_check_display_name = var.uptime_check_display_name
+  protocol                  = "HTTPS"
+  monitored_resource = {
+    monitored_resource_type = "uptime_url"
+    labels = {
+      "project_id" = var.project_id
+      "host"       = var.hostname
+    }
+  }
+
+  notification_channels = [
+    {
+      display_name = "Email Notification Channel"
+      type         = "email"
+      labels       = { email_address = var.email }
+    },
+    # {
+    #   display_name = "SMS Notification Channel"
+    #   type         = "sms"
+    #   labels       = { number = var.sms }
+    # }
+  ]
+}

examples/https_uptime_url_check/outputs.tf

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+output "uptime_check_id" {
+  description = "The id of the uptime check."
+  value       = module.uptime-check.uptime_check_id
+}
+
+output "alert_policy_id" {
+  description = "The id of the alert policy."
+  value       = module.uptime-check.alert_policy_id
+}
+
+output "notification_channel_ids" {
+  description = "The ids of the notification channels"
+  value       = module.uptime-check.notification_channel_ids
+}

examples/https_uptime_url_check/variables.tf

@@ -0,0 +1,45 @@
+/**
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+variable "project_id" {
+  description = "The ID of the project in which to provision resources."
+  type        = string
+}
+
+variable "uptime_check_display_name" {
+  description = "The ID of the project in which to provision resources."
+  type        = string
+  default     = "example-uptime-check-name"
+}
+
+variable "hostname" {
+  description = "The base hostname for the uptime check."
+  type        = string
+  default     = "example-hostname.com"
+}
+
+variable "email" {
+  description = "Email address to alert if uptime check fails."
+  type        = string
+  default     = "example-email@gmail.com"
+}
+
+# Uncomment if you'd like to add an SMS notification channel
+# variable "sms" {
+#   description = "Phone number (including country code) to alert if uptime check fails."
+#   type        = string
+#   default     = "example-number"
+# }

modules/simple-uptime-check/README.md

@@ -0,0 +1,62 @@
+## Simple Uptime Check
+
+This module is used to create a single uptime check along with an alert policy and new and/or existing notification channel(s) to notify if the uptime check fails.
+
+This module does not support multiple alert policies or multiple conditions for a single alert policy. For alert policies, conditions does not support `condition_absent`, `condition_monitoring_query_language` or `condition_matched_log` blocks.
+
+## Usage
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| accepted\_response\_status\_classes | Check will only pass if the HTTP response status code is in this set of status classes (combined with the set of status values). Possible values: STATUS\_CLASS\_1XX, STATUS\_CLASS\_2XX, STATUS\_CLASS\_3XX, STATUS\_CLASS\_4XX, STATUS\_CLASS\_5XX, STATUS\_CLASS\_ANY | `set(string)` | `[]` | no |
+| accepted\_response\_status\_values | Check will only pass if the HTTP response status code is in this set of status values (combined with the set of status classes). | `set(number)` | `[]` | no |
+| aggregations | Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together. | <pre>object({<br>    alignment_period     = string<br>    per_series_aligner   = string<br>    group_by_fields      = list(string)<br>    cross_series_reducer = string<br>  })</pre> | <pre>{<br>  "alignment_period": "1200s",<br>  "cross_series_reducer": "REDUCE_COUNT_FALSE",<br>  "group_by_fields": [<br>    "resource.label.*"<br>  ],<br>  "per_series_aligner": "ALIGN_NEXT_OLDER"<br>}</pre> | no |
+| alert\_policy\_combiner | Determines how to combine multiple conditions. One of: AND, OR, or AND\_WITH\_MATCHING\_RESOURCE. | `string` | `"OR"` | no |
+| alert\_policy\_display\_name | Display name for the alert policy. Defaults to "var.uptime\_check\_display\_name Uptime Failure Alert Policy" if left empty. | `string` | `""` | no |
+| alert\_policy\_user\_labels | This field is intended to be used for organizing and identifying the AlertPolicy objects. | `map(string)` | `{}` | no |
+| auth\_info | Optional username and password to authenticate. | <pre>object({<br>    username = string<br>    password = string<br>  })</pre> | `null` | no |
+| auto\_close | Open incidents will close if an alert policy that was active has no data for this long (in seconds, must be at least 30 minutes). For example "18000s". | `string` | `null` | no |
+| body | The request body associated with the HTTP POST request. | `string` | `null` | no |
+| checker\_type | One of: STATIC\_IP\_CHECKERS, VPC\_CHECKERS | `string` | `"STATIC_IP_CHECKERS"` | no |
+| condition\_display\_name | A unique name to identify condition in dashboards, notifications, and incidents. If left empty, defaults to Failure of uptime check\_id | `string` | `""` | no |
+| condition\_threshold\_comparison | The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold\_value). | `string` | `"COMPARISON_GT"` | no |
+| condition\_threshold\_duration | The amount of time that a time series must violate the threshold to be considered failing, in seconds. Must be a multiple of 60 seconds. | `string` | `"60s"` | no |
+| condition\_threshold\_filter | A filter that identifies which time series should be compared with the threshold. Defaults to uptime check failure filter if left as empty string. | `string` | `""` | no |
+| condition\_threshold\_trigger | Defines the percent and number of time series that must fail the predicate for the condition to be triggered | <pre>object({<br>    percent = number<br>    count   = number<br>  })</pre> | <pre>{<br>  "count": 1,<br>  "percent": null<br>}</pre> | no |
+| condition\_threshold\_value | A value against which to compare the time series. | `number` | `1` | no |
+| content | String or regex content to match. | `string` | `null` | no |
+| content\_type | Content type to use for the http(s) check. Can be one of: TYPE\_UNSPECIFIED, URL\_ENCODED | `string` | `null` | no |
+| enabled | Whether or not the policy is enabled (defaults to true) | `bool` | `true` | no |
+| existing\_notification\_channels | List of existing notification channel IDs to use for alerting if the uptime check fails. | `list(string)` | `[]` | no |
+| headers | The list of headers to send as part of the uptime check request. | `map(string)` | `{}` | no |
+| json\_path\_matcher | If matcher is MATCHES\_JSON\_PATH or NOT\_MATCHES\_JSON\_PATH, the json matcher and path to use. The json matcher must be either EXACT\_MATCH or REGEX\_MATCH. | <pre>object({<br>    json_path    = string<br>    json_matcher = string<br>  })</pre> | `null` | no |
+| mask\_headers | Whether to encrypt the header information. | `bool` | `false` | no |
+| matcher | Type of content matcher. One of: CONTAINS\_STRING, NOT\_CONTAINS\_STRING, MATCHES\_REGEX, NOT\_MATCHES\_REGEX, MATCHES\_JSON\_PATH, NOT\_MATCHES\_JSON\_PATH | `string` | `"CONTAINS_STRING"` | no |
+| monitored\_resource | Monitored resource type and labels. One of: uptime\_url, gce\_instance, gae\_app, aws\_ec2\_instance, aws\_elb\_load\_balancer, k8s\_service, servicedirectory\_service. See https://cloud.google.com/monitoring/api/resources for a list of labels. | <pre>object({<br>    monitored_resource_type = string<br>    labels                  = map(string)<br>  })</pre> | `null` | no |
+| notification\_channel\_strategy | Control over how the notification channels in notification\_channels are notified when this alert fires, on a per-channel basis. | <pre>object({<br>    notification_channel_names = list(string)<br>    renotify_interval          = number<br>  })</pre> | `null` | no |
+| notification\_channels | List of all the notification channels to create for alerting if the uptime check fails. See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list for a list of types and labels. | <pre>list(object({<br>    display_name = string<br>    type         = string<br>    labels       = map(string)<br>  }))</pre> | `[]` | no |
+| notification\_rate\_limit\_period | Not more than one notification per specified period (in seconds), for example "30s". | `string` | `null` | no |
+| path | Path to the page to run the check against. The path to the page to run the check against. Will be combined with the host in monitored\_resource block to construct the entire URL. | `string` | `"/"` | no |
+| period | How frequently uptime check is run. Must be one of the following: 60s, 300s, 600s, 900s | `string` | `"60s"` | no |
+| port | The port to the page to run the check against. If left null, defaults to 443 for HTTPS and 80 for HTTP. | `number` | `null` | no |
+| project\_id | The project ID to host the uptime check in (required). | `string` | n/a | yes |
+| protocol | Protocol for uptime check. One of: HTTPS, HTTP, or TCP (required). | `string` | n/a | yes |
+| request\_method | HTTP request method to use for the check. One of: METHOD\_UNSPECIFIED, GET, POST | `string` | `"GET"` | no |
+| resource\_group | Group resource associated with configuration. Resource types must be one of: RESOURCE\_TYPE\_UNSPECIFIED, INSTANCE, AWS\_ELB\_LOAD\_BALANCER | <pre>object({<br>    resource_type = string<br>    group_id      = string<br>  })</pre> | `null` | no |
+| selected\_regions | Regions from which to run the uptime check from. Defaults to all regions. | `list(string)` | `[]` | no |
+| timeout | The maximum amount of time to wait for the request to complete. | `string` | `"10s"` | no |
+| uptime\_check\_display\_name | The display name for the uptime check (required). | `string` | n/a | yes |
+| validate\_ssl | If https, whether to validate SSL certificates. | `string` | `true` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| alert\_policy\_id | The id of the alert policy. |
+| notification\_channel\_ids | The ids of the notification channels |
+| uptime\_check\_id | The id of the uptime check. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->