Skip to content

Commit

Permalink
Merge branch 'main' into external_provider_curl
Browse files Browse the repository at this point in the history
  • Loading branch information
atrull committed Nov 19, 2023
2 parents c3f1627 + ae4c706 commit b71d07b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,37 @@

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).

<<<<<<< HEAD
=======
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 `curl2` nor `http` providers are perfect. The `curl2` provider is slightly more reliable than the `http` provider. We should ideally check DNS prior to polling, or find a provider that won't poll unless dns resolves - or won't fail if it doesn't resolve.

>>>>>>> main
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.0 |
| <a name="requirement_curl2"></a> [curl2](#requirement\_curl2) | ~> 1.6 |
<<<<<<< HEAD
| <a name="requirement_external"></a> [external](#requirement\_external) | ~> 2.3.1 |
=======
>>>>>>> main
| <a name="requirement_http"></a> [http](#requirement\_http) | ~> 3 |
## Providers

| Name | Version |
|------|---------|
| <a name="provider_curl2"></a> [curl2](#provider\_curl2) | 1.6.1 |
<<<<<<< HEAD
| <a name="provider_external"></a> [external](#provider\_external) | 2.3.1 |
=======
>>>>>>> main
| <a name="provider_http"></a> [http](#provider\_http) | 3.4.0 |
## Modules
Expand All @@ -31,7 +46,10 @@ No modules.
| Name | Type |
|------|------|
| [curl2_curl2.myip](https://registry.terraform.io/providers/mehulgohil/curl2/latest/docs/data-sources/curl2) | data source |
<<<<<<< HEAD
| [external_external.external_curl](https://registry.terraform.io/providers/hashicorp/external/latest/docs/data-sources/external) | data source |
=======
>>>>>>> main
| [http_http.myip](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | data source |

## Inputs
Expand Down
2 changes: 1 addition & 1 deletion outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ output "ipv4_all_matches" {
output "ipv6_all_matches" {
value = local.ipv6_matches
description = "List of all the ipv6 matches (informational/testing)"
}
}

0 comments on commit b71d07b

Please sign in to comment.