GCLOUD2-13375: Enhanced load balancer docs (#77)

* GCLOUD2-13375: Enhanced load balancer docs

Author: ArtsiomAntropau

docs/data-sources/lblistener.md

@@ -17,23 +17,24 @@ provider gcore {
   permanent_api_token = "251$d3361.............1b35f26d8"
 }
 
-data "gcore_project" "pr" {
-  name = "test"
+data "gcore_project" "project" {
+  name = "Default"
 }
 
-data "gcore_region" "rg" {
-  name = "ED-10 Preprod"
+data "gcore_region" "region" {
+  name = "Luxembourg-2"
 }
 
-data "gcore_lblistener" "l" {
+data "gcore_lblistener" "listener" {
+  region_id  = data.gcore_region.region.id
+  project_id = data.gcore_project.project.id
+
   name            = "test-listener"
-  loadbalancer_id = "59b2eabc-c0a8-4545-8081-979bd963c6ab" //optional
-  region_id       = data.gcore_region.rg.id
-  project_id      = data.gcore_project.pr.id
+  // loadbalancer_id = gcore.loadbalancer_v2.lb.id
 }
 
 output "view" {
-  value = data.gcore_lblistener.l
+  value = data.gcore_lblistener.listener
 }
 ```
 
@@ -42,25 +43,25 @@ output "view" {
 
 ### Required
 
-- `name` (String)
+- `name` (String) Name of the load balancer listener.
 
 ### Optional
 
-- `connection_limit` (Number)
-- `loadbalancer_id` (String)
-- `project_id` (Number)
-- `project_name` (String)
-- `region_id` (Number)
-- `region_name` (String)
-- `timeout_client_data` (Number)
-- `timeout_member_connect` (Number)
-- `timeout_member_data` (Number)
+- `connection_limit` (Number) Number of simultaneous connections for this listener, between 1 and 1,000,000.
+- `loadbalancer_id` (String) ID of the load balancer to which listener was attached.
+- `project_id` (Number) ID of the project in which load balancer listener was created.
+- `project_name` (String) Name of the project in which load balancer listener was created.
+- `region_id` (Number) ID of the region in which load balancer listener was created.
+- `region_name` (String) Name of the region in which load balancer listener was created.
+- `timeout_client_data` (Number) Frontend client inactivity timeout in milliseconds.
+- `timeout_member_connect` (Number) Backend member connection timeout in milliseconds.
+- `timeout_member_data` (Number) Backend member inactivity timeout in milliseconds.
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `operating_status` (String)
-- `pool_count` (Number)
-- `protocol` (String) Available values is 'HTTP', 'HTTPS', 'TCP', 'UDP'
-- `protocol_port` (Number)
-- `provisioning_status` (String)
+- `operating_status` (String) Operating status of this listener.
+- `pool_count` (Number) Number of pools in this listener.
+- `protocol` (String) Available values are 'HTTP', 'HTTPS', 'TCP', 'UDP', 'TERMINATED_HTTPS', 'PROMETHEUS'
+- `protocol_port` (Number) Port number to listen, between 1 and 65535.
+- `provisioning_status` (String) Provisioning status of this listener.

docs/data-sources/lbpool.md

@@ -17,18 +17,19 @@ provider gcore {
   permanent_api_token = "251$d3361.............1b35f26d8"
 }
 
-data "gcore_project" "pr" {
-  name = "test"
+data "gcore_project" "project" {
+  name = "Default"
 }
 
-data "gcore_region" "rg" {
-  name = "ED-10 Preprod"
+data "gcore_region" "region" {
+  name = "Luxembourg-2"
 }
 
 data "gcore_lbpool" "pool" {
+  region_id  = data.gcore_region.region.id
+  project_id = data.gcore_project.project.id
+
   name       = "test-pool"
-  region_id  = data.gcore_region.rg.id
-  project_id = data.gcore_project.pr.id
 }
 
 output "view" {
@@ -41,24 +42,24 @@ output "view" {
 
 ### Required
 
-- `name` (String)
+- `name` (String) Name of the load balancer pool.
 
 ### Optional
 
-- `listener_id` (String)
-- `loadbalancer_id` (String)
-- `project_id` (Number)
-- `project_name` (String)
-- `region_id` (Number)
-- `region_name` (String)
+- `listener_id` (String) ID of the load balancer listener to which pool was attached.
+- `loadbalancer_id` (String) ID of the load balancer to which pool was attached.
+- `project_id` (Number) ID of the project in which load balancer pool was created.
+- `project_name` (String) Name of the project in which load balancer pool was created.
+- `region_id` (Number) ID of the region in which load balancer pool was created.
+- `region_name` (String) Name of the region in which load balancer pool was created.
 
 ### Read-Only
 
-- `health_monitor` (List of Object) (see [below for nested schema](#nestedatt--health_monitor))
+- `health_monitor` (List of Object) Health Monitor settings for defining health state of members inside this pool. (see [below for nested schema](#nestedatt--health_monitor))
 - `id` (String) The ID of this resource.
 - `lb_algorithm` (String) Available values is 'ROUND_ROBIN', 'LEAST_CONNECTIONS', 'SOURCE_IP', 'SOURCE_IP_PORT'
-- `protocol` (String) Available values is 'HTTP' (currently work, other do not work on ed-8), 'HTTPS', 'TCP', 'UDP'
-- `session_persistence` (List of Object) (see [below for nested schema](#nestedatt--session_persistence))
+- `protocol` (String) Available values are 'HTTP', 'HTTPS', 'TCP', 'UDP', 'PROXY'
+- `session_persistence` (List of Object) Pool session persistence tells the load balancer to attempt to send future requests from a client to the same backend member as the initial request. (see [below for nested schema](#nestedatt--session_persistence))
 
 <a id="nestedatt--health_monitor"></a>
 ### Nested Schema for `health_monitor`

docs/data-sources/loadbalancer.md

@@ -17,18 +17,19 @@ provider gcore {
   permanent_api_token = "251$d3361.............1b35f26d8"
 }
 
-data "gcore_project" "pr" {
-  name = "test"
+data "gcore_project" "project" {
+  name = "Default"
 }
 
-data "gcore_region" "rg" {
-  name = "ED-10 Preprod"
+data "gcore_region" "region" {
+  name = "Luxembourg-2"
 }
 
 data "gcore_loadbalancer" "lb" {
-  name       = "test-lb"
-  region_id  = data.gcore_region.rg.id
-  project_id = data.gcore_project.pr.id
+  region_id  = data.gcore_region.region.id
+  project_id = data.gcore_project.project.id
+
+  name = "test-lb"
 }
 
 output "view" {

docs/data-sources/loadbalancerv2.md

@@ -17,48 +17,53 @@ provider gcore {
   permanent_api_token = "251$d3361.............1b35f26d8"
 }
 
-data "gcore_project" "pr" {
-  name = "test"
+data "gcore_project" "project" {
+  name = "Default"
 }
 
-data "gcore_region" "rg" {
-  name = "ED-10 Preprod"
+data "gcore_region" "region" {
+  name = "Luxembourg-2"
 }
 
 data "gcore_loadbalancerv2" "lb" {
+  region_id  = data.gcore_region.region.id
+  project_id = data.gcore_project.project.id
+
   name       = "test-lb"
-  region_id  = data.gcore_region.rg.id
-  project_id = data.gcore_project.pr.id
 }
 
 output "view" {
   value = data.gcore_loadbalancerv2.lb
 }
+
+output "lb_ip" {
+  value = data.gcore_loadbalancerv2.lb.vip_address
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `name` (String)
+- `name` (String) Name of the load balancer.
 
 ### Optional
 
-- `metadata_k` (String)
-- `metadata_kv` (Map of String)
-- `project_id` (Number)
-- `project_name` (String)
-- `region_id` (Number)
-- `region_name` (String)
-- `vip_ip_family` (String)
+- `metadata_k` (String) Metadata string of the load balancer.
+- `metadata_kv` (Map of String) Metadata map of the load balancer.
+- `project_id` (Number) ID of the project in which load balancer was created.
+- `project_name` (String) Name of the project in which load balancer was created.
+- `region_id` (Number) ID of the region in which load balancer was created.
+- `region_name` (String) Name of the region in which load balancer was created.
+- `vip_ip_family` (String) Available values are 'ipv4', 'ipv6', 'dual'
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only))
-- `vip_address` (String)
-- `vip_port_id` (String)
+- `metadata_read_only` (List of Object) List of metadata items. (see [below for nested schema](#nestedatt--metadata_read_only))
+- `vip_address` (String) Load balancer IP address.
+- `vip_port_id` (String) Load balancer Port ID.
 - `vrrp_ips` (List of Object) (see [below for nested schema](#nestedatt--vrrp_ips))
 
 <a id="nestedatt--metadata_read_only"></a>

docs/resources/floatingip.md

@@ -31,7 +31,6 @@ resource "gcore_floatingip" "floating_ip" {
 ### Optional
 
 - `fixed_ip_address` (String)
-- `last_updated` (String)
 - `metadata_map` (Map of String)
 - `port_id` (String)
 - `project_id` (Number)
@@ -44,6 +43,7 @@ resource "gcore_floatingip" "floating_ip" {
 - `created_at` (String)
 - `floating_ip_address` (String)
 - `id` (String) The ID of this resource.
+- `last_updated` (String)
 - `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only))
 - `router_id` (String)
 - `status` (String)

docs/resources/lblistener.md

@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "gcore_lblistener Resource - terraform-provider-gcore"
 subcategory: ""
 description: |-
@@ -12,25 +11,60 @@ Represent load balancer listener. Can not be created without load balancer. A li
 
 ## Example Usage
 
+### Prerequisite
+
 ```terraform
 provider gcore {
   permanent_api_token = "251$d3361.............1b35f26d8"
 }
 
+data "gcore_project" "project" {
+  name = "Default"
+}
+
+data "gcore_region" "region" {
+  name = "Luxembourg-2"
+}
+```
+
+```terraform
 resource "gcore_loadbalancerv2" "lb" {
-  project_id = 1
-  region_id  = 1
-  name       = "test"
+  project_id = data.gcore_project.project.id
+  region_id  = data.gcore_region.region.id
+
+  name       = "My first load balancer with listeners"
   flavor     = "lb1-1-2"
 }
+```
+
+### TCP
+
+```terraform
+resource "gcore_lblistener" "tcp_80" {
+  project_id = data.gcore_project.project.id
+  region_id  = data.gcore_region.region.id
+
+  loadbalancer_id = gcore_loadbalancerv2.lb.id
+
+  name          = "tcp-80"
+  protocol      = "TCP"
+  protocol_port = 80
+}
+```
+
+### Prometheus metrics (from private network)
+
+```terraform
+resource "gcore_lblistener" "prometheus_80" {
+  project_id = data.gcore_project.project.id
+  region_id  = data.gcore_region.region.id
 
-resource "gcore_lblistener" "listener" {
-  project_id      = 1
-  region_id       = 1
-  name            = "test"
-  protocol        = "TCP"
-  protocol_port   = 36621
   loadbalancer_id = gcore_loadbalancerv2.lb.id
+
+  name          = "prometheus-80"
+  protocol      = "PROMETHEUS"
+  protocol_port = 8080
+  allowed_cidrs = ["10.0.0.0/8"]  # example of how to allow access only from private network
 }
 ```
 
@@ -39,33 +73,33 @@ resource "gcore_lblistener" "listener" {
 
 ### Required
 
-- `loadbalancer_id` (String)
-- `name` (String)
+- `loadbalancer_id` (String) ID of the target load balancer to attach newly created listener.
+- `name` (String) Listener name.
 - `protocol` (String) Available values are 'HTTP', 'HTTPS', 'TCP', 'UDP', 'TERMINATED_HTTPS', 'PROMETHEUS'
-- `protocol_port` (Number)
+- `protocol_port` (Number) Port number to listen, between 1 and 65535.
 
 ### Optional
 
-- `connection_limit` (Number)
-- `insert_x_forwarded` (Boolean) Insert *-forwarded headers
-- `last_updated` (String)
-- `project_id` (Number)
-- `project_name` (String)
-- `region_id` (Number)
-- `region_name` (String)
-- `secret_id` (String)
-- `sni_secret_id` (List of String)
-- `timeout_client_data` (Number)
-- `timeout_member_connect` (Number)
-- `timeout_member_data` (Number)
+- `connection_limit` (Number) Number of simultaneous connections for this listener, between 1 and 1,000,000.
+- `insert_x_forwarded` (Boolean) Insert X-Forwarded headers for 'HTTP', 'HTTPS', 'TERMINATED_HTTPS' protocols.
+- `project_id` (Number) ID of the desired project to create load balancer listener in. Alternative for `project_name`. One of them should be specified.
+- `project_name` (String) Name of the desired project to create load balancer listener in. Alternative for `project_id`. One of them should be specified.
+- `region_id` (Number) ID of the desired region to create load balancer listener in. Alternative for `region_name`. One of them should be specified.
+- `region_name` (String) Name of the desired region to create load balancer listener in. Alternative for `region_id`. One of them should be specified.
+- `secret_id` (String) Secret ID to use with 'TERMINATED_HTTPS' protocol.
+- `sni_secret_id` (List of String) List of additional Secret IDs to use with 'TERMINATED_HTTPS' protocol.
+- `timeout_client_data` (Number) Frontend client inactivity timeout in milliseconds.
+- `timeout_member_connect` (Number) Backend member connection timeout in milliseconds.
+- `timeout_member_data` (Number) Backend member inactivity timeout in milliseconds.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `operating_status` (String)
-- `pool_count` (Number)
-- `provisioning_status` (String)
+- `last_updated` (String) Datetime when load balancer was updated at the last time.
+- `operating_status` (String) Operating status of this listener.
+- `pool_count` (Number) Number of pools in this listener.
+- `provisioning_status` (String) Provisioning status of this listener.
 
 <a id="nestedblock--timeouts"></a>
 ### Nested Schema for `timeouts`
@@ -75,6 +109,10 @@ Optional:
 - `create` (String)
 - `delete` (String)
 
+
+
+
+
 ## Import
 
 Import is supported using the following syntax:
@@ -83,3 +121,4 @@ Import is supported using the following syntax:
 # import using <project_id>:<region_id>:<lblistener_id>:<loadbalancer_id> format
 terraform import gcore_lblistener.lblistener1 1:6:a775dd94-4e9c-4da7-9f0e-ffc9ae34446b:447d2959-8ae0-4ca0-8d47-9f050a3637d7
 ```
+