Merge pull request #3702 from lwander/f-gcp-global-forwarding-rule

provider/google: global forwarding rule tests & documentation
2024-07-09 19:38:32 +00:00 · 2015-11-03 13:41:08 -05:00 · 2015-11-03 13:41:08 -05:00 · ce8c9d25d0
commit ce8c9d25d0
parent dc71df8455 26c676036a
1 changed files with 93 additions and 0 deletions
--- a/r/compute_global_forwarding_rule.html.markdown
+++ b/r/compute_global_forwarding_rule.html.markdown
@ -0,0 +1,93 @@
+---
+layout: "google"
+page_title: "Google: google_compute_global_forwarding_rule"
+sidebar_current: "docs-google-compute-global-forwarding_rule"
+description: |-
+  Manages a Target Pool within GCE.
+---
+
+# google\_compute\_global\_forwarding\_rule
+
+Manages a Global Forwarding Rule within GCE.  This binds an ip and port to a target HTTP(s) proxy.  For more
+information see [the official
+documentation](https://cloud.google.com/compute/docs/load-balancing/network/forwarding-rules) and
+[API](https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules).
+
+## Example Usage
+
+```
+resource "google_compute_global_forwarding_rule" "default" {
+    name = "test"
+    target = "${google_compute_target_http_proxy.default.self_link}"
+    port_range = "80"
+}
+
+resource "google_compute_target_http_proxy" "default" {
+    name = "test-proxy"
+    description = "a description"
+    url_map = "${google_compute_url_map.default.self_link}"
+}
+
+resource "google_compute_url_map" "default" {
+    name = "url-map"
+    description = "a description"
+    default_service = "${google_compute_backend_service.default.self_link}"
+
+    host_rule {
+        hosts = ["mysite.com"]
+        path_matcher = "allpaths"
+    }
+
+    path_matcher {
+        default_service = "${google_compute_backend_service.default.self_link}"
+        name = "allpaths"
+        path_rule {
+            paths = ["/*"]
+            service = "${google_compute_backend_service.default.self_link}"
+        }
+    }
+}
+
+resource "google_compute_backend_service" "default" {
+    name = "default-backend"
+    port_name = "http"
+    protocol = "HTTP"
+    timeout_sec = 10
+    region = "us-central1"
+
+    health_checks = ["${google_compute_http_health_check.default.self_link}"]
+}
+
+resource "google_compute_http_health_check" "default" {
+    name = "test"
+    request_path = "/"
+    check_interval_sec = 1
+    timeout_sec = 1
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `description` - (Optional) Textual description field.
+
+* `ip_address` - (Optional) The static IP. (if not set, an ephemeral IP is used).
+
+* `ip_protocol` - (Optional) The IP protocol to route, one of "TCP" "UDP" "AH" "ESP" or "SCTP". (default "TCP").
+
+* `name` - (Required) A unique name for the resource, required by GCE.  Changing
+  this forces a new resource to be created.
+
+* `port_range` - (Optional) A range e.g. "1024-2048" or a single port "1024"
+  (defaults to all ports!).
+
+* `target` - URL of target HTTP or HTTPS proxy.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `self_link` - The URL of the created resource.
+
+* `ip_address` - The IP address that was chosen (or specified).