From 9abc5d0e255ca61cabb47c71a8140d2f4960a200 Mon Sep 17 00:00:00 2001 From: Alex Trull Date: Sun, 19 Nov 2023 11:33:54 +0100 Subject: [PATCH] switched to curl2 provider which includes timeout configuration --- README.md | 14 ++++++++------ main.tf | 29 ++++++++++++++++++++--------- variables.tf | 16 ++++++++++++++-- 3 files changed, 42 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5fcaa7a..8342fdb 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ This module polls a series of fairly well known but occasionally unreliable 'what is my ip' services. It then produces the most common response that is a valid ipv4 or ipv6 address (both outputs are separately provided). -We support two providers - `curl` and `http`. `curl` is the default provider because it has better failure handling whereas `http` provider will fail a plan/apply if the endpoint doesn't respond. +We support two providers - `curl2` and `http`. `curl2` is the default provider because it has better failure handling whereas `http` provider will fail a plan/apply if the endpoint doesn't respond. ## Limitations -Neither the `curl` nor `http` providers are perfect. The `curl` provider is slightly more reliable than the `http` provider, but `curl` is missing a timeout option (for now). +Neither the `curl2` nor `http` providers are perfect. The `curl2` provider is slightly more reliable than the `http` provider. ## Requirements @@ -16,14 +16,14 @@ Neither the `curl` nor `http` providers are perfect. The `curl` provider is slig | Name | Version | |------|---------| | [terraform](#requirement\_terraform) | ~> 1.0 | -| [curl](#requirement\_curl) | ~> 1.0.2 | +| [curl2](#requirement\_curl2) | ~> 1.6 | | [http](#requirement\_http) | ~> 3 | ## Providers | Name | Version | |------|---------| -| [curl](#provider\_curl) | 1.0.2 | +| [curl2](#provider\_curl2) | 1.6.1 | | [http](#provider\_http) | 3.4.0 | ## Modules @@ -34,15 +34,17 @@ No modules. | Name | Type | |------|------| -| [curl_curl.myip](https://registry.terraform.io/providers/anschoewe/curl/latest/docs/data-sources/curl) | data source | +| [curl2_curl2.myip](https://registry.terraform.io/providers/mehulgohil/curl2/latest/docs/data-sources/curl2) | data source | | [http_http.myip](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | data source | ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [data\_provider](#input\_data\_provider) | `curl` or `http` providers are both supported - we recommend `curl` | `string` | `"curl"` | no | +| [data\_provider](#input\_data\_provider) | `curl2` or `http` providers are both supported - we recommend `curl2` | `string` | `"curl2"` | no | | [extra\_service\_urls](#input\_extra\_service\_urls) | Put your own in here if you want extra ones, this gets merged with the `service_urls` list | `list(string)` | `[]` | no | +| [request\_timeout](#input\_request\_timeout) | Request timeout in milliseconds | `number` | `500` | no | +| [retry\_attempts](#input\_retry\_attempts) | Request retries | `number` | `0` | no | | [service\_urls](#input\_service\_urls) | List of urls to use for getting our IP | `list(string)` | 
[
  "https://api.seeip.org",
  "https://ipinfo.io/ip",
  "https://ifconfig.co",
  "https://icanhazip.com",
  "https://api.ipify.org",
  "https://ifconfig.me",
  "https://ipecho.net/plain",
  "https://ifconfig.io",
  "https://ident.me",
  "https://ipv4.ident.me"
]
| no | ## Outputs diff --git a/main.tf b/main.tf index 53ac921..2dc3fe2 100644 --- a/main.tf +++ b/main.tf @@ -1,9 +1,9 @@ terraform { required_version = "~> 1.0" required_providers { - curl = { - version = "~> 1.0.2" - source = "anschoewe/curl" + curl2 = { + version = "~> 1.6" + source = "mehulgohil/curl2" } http = { version = "~> 3" @@ -12,11 +12,19 @@ terraform { } } -# curl is the default method -data "curl" "myip" { - for_each = var.data_provider == "curl" ? toset(local.service_urls) : [] - http_method = "GET" +provider "curl2" { + timeout_ms = var.request_timeout + retry { + retry_attempts = var.retry_attempts + } +} + +# curl2 is the default method +data "curl2" "myip" { + for_each = var.data_provider == "curl2" ? toset(local.service_urls) : [] uri = each.key + http_method = "GET" + } # but we can use http if you prefer @@ -24,7 +32,10 @@ data "http" "myip" { for_each = var.data_provider == "http" ? toset(local.service_urls) : [] url = each.key method = "GET" - request_timeout_ms = 500 + request_timeout_ms = var.request_timeout + retry { + attempts = var.retry_attempts + } } locals { @@ -32,7 +43,7 @@ locals { service_urls = distinct(concat(var.service_urls, var.extra_service_urls)) # build a list of responses - service_response_bodies = var.data_provider == "curl" ? values(data.curl.myip)[*].response : values(data.http.myip)[*].response_body + service_response_bodies = var.data_provider == "curl2" ? values(data.curl2.myip)[*].response.body : values(data.http.myip)[*].response_body # remunge it without whitespace as a list of strings split_output = split(",", replace(trimspace(join(",", local.service_response_bodies)), "/\\s/", "")) diff --git a/variables.tf b/variables.tf index 0891cd6..041be23 100644 --- a/variables.tf +++ b/variables.tf @@ -15,6 +15,18 @@ variable "service_urls" { description = "List of urls to use for getting our IP" } +variable "request_timeout" { + default = 500 + type = number + description = "Request timeout in milliseconds" +} + +variable "retry_attempts" { + default = 0 + type = number + description = "Request retries" +} + variable "extra_service_urls" { default = [] type = list(string) @@ -22,7 +34,7 @@ variable "extra_service_urls" { } variable "data_provider" { - default = "curl" + default = "curl2" type = string - description = "`curl` or `http` providers are both supported - we recommend `curl`" + description = "`curl2` or `http` providers are both supported - we recommend `curl2`" } \ No newline at end of file