From 305a57a8367d486b8f50c01a19b5333e80ddcce4 Mon Sep 17 00:00:00 2001 From: wangzepeng <65212374+Zippo-Wang@users.noreply.github.com> Date: Mon, 16 Oct 2023 15:46:54 +0800 Subject: [PATCH] docs(elb): fix docs issues (#1010) --- docs/data-sources/elb_certificate.md | 2 +- docs/data-sources/lb_certificate_v2.md | 19 ++- docs/data-sources/lb_loadbalancer_v2.md | 7 +- docs/resources/elb_backend.md | 41 ++--- docs/resources/elb_certificate.md | 15 +- docs/resources/elb_health.md | 70 ++++----- docs/resources/elb_ipgroup.md | 15 +- docs/resources/elb_listener.md | 145 ++++++++---------- docs/resources/elb_loadbalancer.md | 91 +++++------ docs/resources/lb_certificate_v2.md | 37 ++--- docs/resources/lb_l7policy_v2.md | 59 +++---- docs/resources/lb_l7rule_v2.md | 54 +++---- docs/resources/lb_listener_v2.md | 77 +++++----- docs/resources/lb_loadbalancer_v2.md | 63 ++++---- docs/resources/lb_loadbalancer_v3.md | 9 +- docs/resources/lb_member_v2.md | 58 +++---- docs/resources/lb_monitor_v2.md | 71 ++++----- docs/resources/lb_pool_v2.md | 82 +++++----- docs/resources/lb_pool_v3.md | 29 ++-- docs/resources/lb_whitelist_v2.md | 26 ++-- ...rce_flexibleengine_elb_certificate_test.go | 17 +- ..._flexibleengine_lb_loadbalancer_v3_test.go | 16 +- .../resource_flexibleengine_lb_l7policy_v2.go | 16 +- .../resource_flexibleengine_lb_l7rule_v2.go | 16 +- ...ource_flexibleengine_lb_loadbalancer_v2.go | 33 ++-- .../resource_flexibleengine_lb_member_v2.go | 28 ++-- .../resource_flexibleengine_lb_monitor_v2.go | 27 ++-- ...resource_flexibleengine_lb_whitelist_v2.go | 15 +- 28 files changed, 529 insertions(+), 609 deletions(-) diff --git a/docs/data-sources/elb_certificate.md b/docs/data-sources/elb_certificate.md index d3376f6e1..a5f35d9bb 100644 --- a/docs/data-sources/elb_certificate.md +++ b/docs/data-sources/elb_certificate.md @@ -27,7 +27,7 @@ The following arguments are supported: -> **NOTE:** The certificate name is not unique. Only returns the last created one when matched multiple certificates. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: diff --git a/docs/data-sources/lb_certificate_v2.md b/docs/data-sources/lb_certificate_v2.md index e639da6d0..3313c1249 100644 --- a/docs/data-sources/lb_certificate_v2.md +++ b/docs/data-sources/lb_certificate_v2.md @@ -23,23 +23,22 @@ data "flexibleengine_lb_certificate_v2" "by_name" { The arguments of this data source act as filters for querying the available Certificates in the current region. The given filters must match exactly one Certificate whose data will be exported as attributes. -* `id` - (Optional) The id of the specific Certificate to retrieve. +* `id` - (Optional, String) The id of the specific Certificate to retrieve. -* `name` - (Optional) Human-readable name for the Certificate. Does not have - to be unique. +* `name` - (Optional, String) Human-readable name for the Certificate. Does not have to be unique. -* `description` - (Optional) Human-readable description for the Certificate. +* `description` - (Optional, String) Human-readable description for the Certificate. -* `domain` - (Optional) The domain of the Certificate. +* `domain` - (Optional, String) The domain of the Certificate. -## Attributes Reference +## Attribute Reference -The following attributes are exported: +In addition to all arguments above, the following attributes are exported: -* `name` - See Argument Reference above. -* `description` - See Argument Reference above. -* `domain` - See Argument Reference above. * `private_key` - The private encrypted key of the Certificate, PEM format. + * `certificate` - The public encrypted key of the Certificate, PEM format. + * `update_time` - Indicates the update time. + * `create_time` - Indicates the creation time. diff --git a/docs/data-sources/lb_loadbalancer_v2.md b/docs/data-sources/lb_loadbalancer_v2.md index 47c712535..e08382caa 100644 --- a/docs/data-sources/lb_loadbalancer_v2.md +++ b/docs/data-sources/lb_loadbalancer_v2.md @@ -18,6 +18,9 @@ data "flexibleengine_lb_loadbalancer_v2" "test" { ## Argument Reference +* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region + will be used. + * `name` - (Optional, String) Specifies the name of the load balancer. * `id` - (Optional, String) Specifies the data source ID of the load balancer in UUID format. @@ -28,10 +31,12 @@ data "flexibleengine_lb_loadbalancer_v2" "test" { * `vip_address` - (Optional, String) Specifies the private IP address of the load balancer. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `vip_port_id` - The ID of the port bound to the private IP address of the load balancer. + * `status` - The operating status of the load balancer. + * `tags` - The tags associated with the load balancer. diff --git a/docs/resources/elb_backend.md b/docs/resources/elb_backend.md index 1e9de9f65..4a9bb20b0 100644 --- a/docs/resources/elb_backend.md +++ b/docs/resources/elb_backend.md @@ -24,27 +24,20 @@ resource "flexibleengine_elb_backend" "backend" { The following arguments are supported: -* `listener_id` - (Required) Specifies the listener ID. - -* `server_id` - (Required) Specifies the backend member ID. - -* `address` - (Required) Specifies the private IP address of the backend member. - -## Attributes Reference - -The following attributes are exported: - -* `id` - Specifies the backend member ID. -* `listener_id` - See Argument Reference above. -* `server_id` - See Argument Reference above. -* `address` - See Argument Reference above. -* `server_address` - Specifies the floating IP address assigned to the backend member. -* `status` - Specifies the backend ECS status. The value is ACTIVE, PENDING, - or ERROR. -* `health_status` - Specifies the health check status. The value is NORMAL, - ABNORMAL, or UNAVAILABLE. -* `update_time` - Specifies the time when information about the backend member - was updated. -* `create_time` - Specifies the time when the backend member was created. -* `server_name` - Specifies the backend member name. -* `listeners` - Specifies the listener to which the backend member belongs. +* `listener_id` - (Required, String, ForceNew) Specifies the listener ID. Changing this will create a new resource. + +* `server_id` - (Required, String, ForceNew) Specifies the backend member ID. Changing this will create a new resource. + +* `address` - (Required, String, ForceNew) Specifies the private IP address of the backend member. + Changing this will create a new resource. + +## Attribute Reference + +All the arguments above can also be exported attributes. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `delete` - Default is 10 minutes. diff --git a/docs/resources/elb_certificate.md b/docs/resources/elb_certificate.md index 632b9a2b8..f55423368 100644 --- a/docs/resources/elb_certificate.md +++ b/docs/resources/elb_certificate.md @@ -84,7 +84,7 @@ The following arguments are supported: * `description` - (Optional, String) Specifies the description of the certificate. * `type` - (Optional, String, ForceNew) Specifies the certificate type. The default value is "server". - The value can be one of the following: + Changing this creates a new certificate. The value can be one of the following: + server: indicates the server certificate. + client: indicates the CA certificate. @@ -96,22 +96,17 @@ The following arguments are supported: * `domain` - (Optional, String) Specifies the domain of the certificate. The value contains a maximum of 100 characters. This parameter is valid only when `type` is set to "server". -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - Specifies a resource ID in UUID format. -* `update_time` - Indicates the update time. -* `create_time` - Indicates the creation time. -* `expire_time` - Indicates the expire time. -## Timeouts +* `update_time` - Indicates the update time. -This resource provides the following timeouts configuration options: +* `create_time` - Indicates the creation time. -* `create` - Default is 10 minute. -* `update` - Default is 10 minute. -* `delete` - Default is 5 minute. +* `expire_time` - Indicates the expired time. ## Import diff --git a/docs/resources/elb_health.md b/docs/resources/elb_health.md index a5328a8c0..df2baa6e9 100644 --- a/docs/resources/elb_health.md +++ b/docs/resources/elb_health.md @@ -27,51 +27,49 @@ resource "flexibleengine_elb_health" "healthcheck" { The following arguments are supported: -* `region` - (Optional) The region in which to create the elb health. If - omitted, the `region` argument of the provider is used. Changing this - creates a new elb health. +* `region` - (Optional, String, ForceNew) The region in which to create the elb health. If + omitted, the `region` argument of the provider is used. Changing this creates a new elb health. -* `listener_id` - (Required) Specifies the ID of the listener to which the health - check belongs. +* `listener_id` - (Required, String, ForceNew) Specifies the ID of the listener to which the health + check belongs. Changing this creates a new elb health. -* `healthcheck_protocol` - (Optional) Specifies the protocol used for the health - check. The value can be HTTP or TCP (case-insensitive). +* `healthcheck_protocol` - (Optional, String) Specifies the protocol used for the health + check. The value can be HTTP or TCP (case-insensitive). -* `healthcheck_uri` - (Optional) Specifies the URI for health check. This parameter - is valid when healthcheck_ protocol is HTTP. The value is a string of 1 to 80 - characters that must start with a slash (/) and can only contain letters, digits, - and special characters, such as -/.%?#&. +* `healthcheck_uri` - (Optional, String) Specifies the URI for health check. This parameter + is valid when healthcheck_ protocol is HTTP. The value is a string of 1 to 80 + characters that must start with a slash (/) and can only contain letters, digits, + and special characters, such as -/.%?#&. -* `healthcheck_connect_port` - (Optional) Specifies the port used for the health - check. The value ranges from 1 to 65535. +* `healthcheck_connect_port` - (Optional, Int) Specifies the port used for the health + check. The value ranges from 1 to 65535. -* `healthy_threshold` - (Optional) Specifies the threshold at which the health - check result is success, that is, the number of consecutive successful health - checks when the health check result of the backend server changes from fail - to success. The value ranges from 1 to 10. +* `healthy_threshold` - (Optional, Int) Specifies the threshold at which the health + check result is success, that is, the number of consecutive successful health + checks when the health check result of the backend server changes from fail + to success. The value ranges from 1 to 10. -* `unhealthy_threshold` - (Optional) Specifies the threshold at which the health - check result is fail, that is, the number of consecutive failed health checks - when the health check result of the backend server changes from success to fail. - The value ranges from 1 to 10. +* `unhealthy_threshold` - (Optional, Int) Specifies the threshold at which the health + check result is fail, that is, the number of consecutive failed health checks + when the health check result of the backend server changes from success to fail. + The value ranges from 1 to 10. -* `healthcheck_timeout` - (Optional) Specifies the maximum timeout duration - (s) for the health check. The value ranges from 1 to 50. +* `healthcheck_timeout` - (Optional, Int) Specifies the maximum timeout duration + (s) for the health check. The value ranges from 1 to 50. -* `healthcheck_interval` - (Optional) Specifies the maximum interval (s) for - health check. The value ranges from 1 to 5. +* `healthcheck_interval` - (Optional, Int) Specifies the maximum interval (s) for + health check. The value ranges from 1 to 5. -## Attributes Reference +## Attribute Reference -The following attributes are exported: +In addition to all arguments above, the following attributes are exported: * `id` - Specifies the health check ID. -* `region` - See Argument Reference above. -* `listener_id` - See Argument Reference above. -* `healthcheck_protocol` - See Argument Reference above. -* `healthcheck_uri` - See Argument Reference above. -* `healthcheck_connect_port` - See Argument Reference above. -* `healthy_threshold` - See Argument Reference above. -* `unhealthy_threshold` - See Argument Reference above. -* `healthcheck_timeout` - See Argument Reference above. -* `healthcheck_interval` - See Argument Reference above. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 10 minutes. diff --git a/docs/resources/elb_ipgroup.md b/docs/resources/elb_ipgroup.md index 8c84e065c..a7655fab7 100644 --- a/docs/resources/elb_ipgroup.md +++ b/docs/resources/elb_ipgroup.md @@ -33,28 +33,23 @@ The following arguments are supported: * `description` - (Optional, String) Specifies the description of the ip group. -* `ip_list` - (Required, List) Specifies an array of one or more ip addresses. The ip_list object structure is - documented below. +* `ip_list` - (Required, List) Specifies an array of one or more ip addresses. The [ip_list](#elb_ip_list) object + structure is documented below. + The `ip_list` block supports: * `ip` - (Required, String) IP address or CIDR block. * `description` - (Optional, String) Human-readable description for the ip. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: * `id` - The uuid of the ip group. -## Timeouts - -This resource provides the following timeouts configuration options: - -* `create` - Default is 10 minute. -* `update` - Default is 10 minute. -* `delete` - Default is 5 minute. +## Import ELB IP group can be imported using the IP group ID, e.g. diff --git a/docs/resources/elb_listener.md b/docs/resources/elb_listener.md index fa6ae69f6..293c14af4 100644 --- a/docs/resources/elb_listener.md +++ b/docs/resources/elb_listener.md @@ -37,107 +37,88 @@ resource "flexibleengine_elb_listener" "listener" { The following arguments are supported: -* `region` - (Optional) The region in which to create the elb listener. If - omitted, the `region` argument of the provider is used. Changing this - creates a new elb listener. +* `region` - (Optional, String, ForceNew) The region in which to create the elb listener. If + omitted, the `region` argument of the provider is used. Changing this creates a new elb listener. -* `loadbalancer_id` - (Required) Specifies the ID of the load balancer to which - the listener belongs. +* `loadbalancer_id` - (Required, String, ForceNew) Specifies the ID of the load balancer to which + the listener belongs. Changing this creates a new elb listener. -* `name` - (Required) Specifies the load balancer name. The name is a string - of 1 to 64 characters that consist of letters, digits, underscores (_), and - hyphens (-). +* `name` - (Optional, String) Specifies the load balancer name. The name is a string + of 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-). -* `protocol` - (Required) Specifies the listening protocol used for layer 4 - or 7. The value can be HTTP, TCP, HTTPS, or UDP. +* `protocol` - (Required, String, ForceNew) Specifies the listening protocol used for layer 4 + or 7. The value can be HTTP, TCP, HTTPS, or UDP. Changing this creates a new elb listener. -* `protocol_port` - (Required) Specifies the listening port. The value ranges from 1 - to 65535. +* `protocol_port` - (Required, Int) Specifies the listening port. The value ranges from 1 to 65535. -* `backend_protocol` - (Required) Specifies the backend protocol. If the value - of protocol is UDP, the value of this parameter can only be UDP. The value can - be HTTP, TCP, or UDP. +* `backend_protocol` - (Required, String, ForceNew) Specifies the backend protocol. If the value + of protocol is UDP, the value of this parameter can only be UDP. The value can + be HTTP, TCP, or UDP. Changing this creates a new elb listener. -* `backend_port` - (Required) Specifies the backend port. The value ranges from - 1 to 65535. +* `backend_port` - (Required, Int) Specifies the backend port. The value ranges from 1 to 65535. -* `lb_algorithm` - (Required) Specifies the load balancing algorithm for the - listener. The value can be roundrobin, leastconn, or source. +* `lb_algorithm` - (Required, String) Specifies the load balancing algorithm for the + listener. The value can be round-robin, leastconn, or source. -* `description` - (Optional) Provides supplementary information about the listener. - The value is a string of 0 to 128 characters and cannot be <>. +* `description` - (Optional, String) Provides supplementary information about the listener. + The value is a string of 0 to 128 characters and cannot be <>. -* `session_sticky` - (Optional) Specifies whether to enable sticky session. - The value can be true or false. The Sticky session is enabled when the value - is true, and is disabled when the value is false. If the value of protocol is - HTTP, HTTPS, or TCP, and the value of lb_algorithm is not roundrobin, the value - of this parameter can only be false. +* `session_sticky` - (Optional, Bool, ForceNew) Specifies whether to enable sticky session. + The value can be true or false. The Sticky session is enabled when the value + is true, and is disabled when the value is false. If the value of protocol is + HTTP, HTTPS, or TCP, and the value of lb_algorithm is not round-robin, the value + of this parameter can only be false. Changing this creates a new elb listener. -* `session_sticky_type` - (Optional) Specifies the cookie processing method. - The value is insert. insert indicates that the cookie is inserted by the load - balancer. This parameter is valid when protocol is set to HTTP, and session_sticky - to true. The default value is insert. This parameter is invalid when protocol - is set to TCP or UDP, which means the parameter is empty. +* `session_sticky_type` - (Optional, String, ForceNew) Specifies the cookie processing method. + The value is insert. insert indicates that the cookie is inserted by the load + balancer. This parameter is valid when protocol is set to HTTP, and session_sticky + to true. The default value is insert. This parameter is invalid when protocol + is set to TCP or UDP, which means the parameter is empty. Changing this creates a new elb listener. -* `cookie_timeout` - (Optional) Specifies the cookie timeout period (minutes). - This parameter is valid when protocol is set to HTTP, session_sticky to true, - and session_sticky_type to insert. This parameter is invalid when protocol is - set to TCP or UDP. The value ranges from 1 to 1440. +* `cookie_timeout` - (Optional, Int, ForceNew) Specifies the cookie timeout period (minutes). + This parameter is valid when protocol is set to HTTP, session_sticky to true, + and session_sticky_type to insert. This parameter is invalid when protocol is + set to TCP or UDP. The value ranges from 1 to 1440. Changing this creates a new elb listener. -* `tcp_timeout` - (Optional) Specifies the TCP timeout period (minutes). This - parameter is valid when protocol is set to TCP. The value ranges from 1 to 5. +* `tcp_timeout` - (Optional, Int) Specifies the TCP timeout period (minutes). This + parameter is valid when protocol is set to TCP. The value ranges from 1 to 5. -* `tcp_draining` - (Optional) Specifies whether to maintain the TCP connection - to the backend ECS after the ECS is deleted. This parameter is valid when protocol - is set to TCP. The value can be true or false. +* `tcp_draining` - (Optional, Bool) Specifies whether to maintain the TCP connection + to the backend ECS after the ECS is deleted. This parameter is valid when protocol + is set to TCP. The value can be true or false. -* `tcp_draining_timeout` - (Optional) Specifies the timeout duration (minutes) - for the TCP connection to the backend ECS after the ECS is deleted. This parameter - is valid when protocol is set to TCP, and tcp_draining to true. The value ranges - from 0 to 60. +* `tcp_draining_timeout` - (Optional, Int) Specifies the timeout duration (minutes) + for the TCP connection to the backend ECS after the ECS is deleted. This parameter + is valid when protocol is set to TCP, and tcp_draining to true. The value ranges from 0 to 60. -* `certificate_id` - (Optional) Specifies the ID of the SSL certificate used - for security authentication when HTTPS is used to make API calls. This parameter - is mandatory if the value of protocol is HTTPS. The value can be obtained by - viewing the details of the SSL certificate. +* `certificate_id` - (Optional, String, ForceNew) Specifies the ID of the SSL certificate used + for security authentication when HTTPS is used to make API calls. This parameter + is mandatory if the value of protocol is HTTPS. The value can be obtained by + viewing the details of the SSL certificate. Changing this creates a new elb listener. -* `udp_timeout` - (Optional) Specifies the UDP timeout duration (minutes). This - parameter is valid when protocol is set to UDP. The value ranges from 1 to 1440. +* `udp_timeout` - (Optional, Int) Specifies the UDP timeout duration (minutes). This + parameter is valid when protocol is set to UDP. The value ranges from 1 to 1440. -* `ssl_protocols` - (Optional) Specifies the SSL protocol standard supported - by a tracker, which is used for enabling specified encryption protocols. This - parameter is valid only when the value of protocol is set to HTTPS. The value - is TLSv1.2 or TLSv1.2 TLSv1.1 TLSv1. The default value is TLSv1.2. +* `ssl_protocols` - (Optional, String, ForceNew) Specifies the SSL protocol standard supported + by a tracker, which is used for enabling specified encryption protocols. This + parameter is valid only when the value of protocol is set to HTTPS. The value + is TLSv1.2 or TLSv1.2 TLSv1.1 TLSv1. The default value is TLSv1.2. Changing this creates a new elb listener. -* `ssl_ciphers` - (Optional) Specifies the cipher suite of an encryption protocol. - This parameter is valid only when the value of protocol is set to HTTPS. The - value is Default, Extended, or Strict. The default value is Default. The value - can only be set to Extended if the value of ssl_protocols is set to TLSv1.2 - TLSv1.1 TLSv1. +* `ssl_ciphers` - (Optional, String) Specifies the cipher suite of an encryption protocol. + This parameter is valid only when the value of protocol is set to HTTPS. The + value is Default, Extended, or Strict. The default value is Default. The value + can only be set to Extended if the value of ssl_protocols is set to TLSv1.2 TLSv1.1 TLSv1. -## Attributes Reference +## Attribute Reference -The following attributes are exported: +In addition to all arguments above, the following attributes are exported: * `id` - Specifies the listener ID. -* `region` - See Argument Reference above. -* `name` - See Argument Reference above. -* `description` - See Argument Reference above. -* `loadbalancer_id` - See Argument Reference above. -* `protocol` - See Argument Reference above. -* `protocol_port` - See Argument Reference above. -* `backend_protocol` - See Argument Reference above. -* `backend_port` - See Argument Reference above. -* `lb_algorithm` - See Argument Reference above. -* `session_sticky` - See Argument Reference above. -* `session_sticky_type` - See Argument Reference above. -* `cookie_timeout` - See Argument Reference above. -* `tcp_timeout` - See Argument Reference above. -* `tcp_draining` - See Argument Reference above. -* `tcp_draining_timeout` - See Argument Reference above. -* `certificate_id` - See Argument Reference above. -* `udp_timeout` - See Argument Reference above. -* `ssl_protocols` - See Argument Reference above. -* `ssl_ciphers` - See Argument Reference above. -* `admin_state_up` - Specifies the status of the load balancer. Value range: - false: The load balancer is disabled. true: The load balancer runs properly. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 10 minutes. diff --git a/docs/resources/elb_loadbalancer.md b/docs/resources/elb_loadbalancer.md index 3d4f320fe..9a77e5fce 100644 --- a/docs/resources/elb_loadbalancer.md +++ b/docs/resources/elb_loadbalancer.md @@ -52,67 +52,58 @@ resource "flexibleengine_elb_loadbalancer" "elb" { The following arguments are supported: -* `region` - (Optional) The region in which to create the loadbalancer. If - omitted, the `region` argument of the provider is used. Changing this - creates a new loadbalancer. +* `region` - (Optional, String, ForceNew) The region in which to create the loadbalancer. If + omitted, the `region` argument of the provider is used. Changing this creates a new loadbalancer. -* `name` - (Required) Specifies the load balancer name. The name is a string - of 1 to 64 characters that consist of letters, digits, underscores (_), - and hyphens (-). +* `name` - (Optional, String) Specifies the load balancer name. The name is a string + of 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-). -* `type` - (Required) Specifies the load balancer type. The value can be - Internal or External. +* `type` - (Required, String, ForceNew) Specifies the load balancer type. The value can be + Internal or External. Changing this creates a new loadbalancer. -* `vpc_id` - (Required) Specifies the VPC ID. +* `vpc_id` - (Required, String, ForceNew) Specifies the VPC ID. Changing this creates a new loadbalancer. -* `description` - (Optional) Provides supplementary information about the - listener. The value is a string of 0 to 128 characters and cannot be <>. +* `description` - (Optional, String) Provides supplementary information about the + listener. The value is a string of 0 to 128 characters and cannot be <>. -* `vip_address` - (Optional) Specifies the IP address provided by ELB. - When type is set to External, the value of this parameter is the elastic - IP address. When type is set to Internal, the value of this parameter is - the private network IP address. You can select an existing elastic IP address - and create a public network load balancer. When this parameter is configured, - parameter `bandwidth` is invalid. +* `vip_address` - (Optional, String, ForceNew) Specifies the IP address provided by ELB. + When type is set to External, the value of this parameter is the elastic + IP address. When type is set to Internal, the value of this parameter is + the private network IP address. You can select an existing elastic IP address + and create a public network load balancer. When this parameter is configured, + parameter `bandwidth` is invalid. Changing this creates a new loadbalancer. -* `bandwidth` - (Optional) Specifies the bandwidth (Mbit/s). This parameter - is valid when type is set to External, and it is invalid when type - is set to Internal. The value ranges from 1 to 300. +* `bandwidth` - (Optional, Int) Specifies the bandwidth (Mbit/s). This parameter + is valid when type is set to External, and it is invalid when type + is set to Internal. The value ranges from 1 to 300. -* `vip_subnet_id` - (Optional) Specifies the ID of the private network - to be added. This parameter is mandatory when type is set to Internal, - and it is invalid when type is set to External. +* `vip_subnet_id` - (Optional, String, ForceNew) Specifies the ID of the private network + to be added. This parameter is mandatory when type is set to Internal, + and it is invalid when type is set to External. Changing this creates a new loadbalancer. -* `security_group_id` - (Optional) Specifies the security group ID. The - value is a string of 1 to 200 characters that consists of uppercase and - lowercase letters, digits, and hyphens (-). This parameter is mandatory - when type is set to Internal, and it is invalid when type is set to External. +* `security_group_id` - (Optional, String, ForceNew) Specifies the security group ID. The + value is a string of 1 to 200 characters that consists of uppercase and + lowercase letters, digits, and hyphens (-). This parameter is mandatory + when type is set to Internal, and it is invalid when type is set to External. + Changing this creates a new loadbalancer. -* `az` - (Optional) Specifies the ID of the availability zone (AZ). This - parameter is mandatory when type is set to Internal, and it is invalid - when type is set to External. +* `az` - (Optional, String, ForceNew) Specifies the ID of the availability zone (AZ). This + parameter is mandatory when type is set to Internal, and it is invalid + when type is set to External. Changing this creates a new loadbalancer. -* `admin_state_up` - (Optional) Specifies the status of the load balancer. Defaults to true. - + true: indicates that the load balancer is running. - + false: indicates that the load balancer is stopped. +* `tenantid` - (Optional, String, ForceNew) Specifies the tenant ID. This parameter is mandatory + only when type is set to Internal. Changing this creates a new loadbalancer. -* `tenantid` - (Optional) Specifies the tenant ID. This parameter is mandatory - only when type is set to Internal. +## Attribute Reference -## Attributes Reference - -The following attributes are exported: +In addition to all arguments above, the following attributes are exported: * `id` - Specifies the load balancer ID. -* `region` - See Argument Reference above. -* `name` - See Argument Reference above. -* `description` - See Argument Reference above. -* `vpc_id` - See Argument Reference above. -* `bandwidth` - See Argument Reference above. -* `type` - See Argument Reference above. -* `admin_state_up` - See Argument Reference above. -* `vip_subnet_id` - See Argument Reference above. -* `az` - See Argument Reference above. -* `security_group_id` - See Argument Reference above. -* `vip_address` - See Argument Reference above. -* `tenantid` - See Argument Reference above. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 5 minutes. diff --git a/docs/resources/lb_certificate_v2.md b/docs/resources/lb_certificate_v2.md index 2f06603cc..46cb12e9b 100644 --- a/docs/resources/lb_certificate_v2.md +++ b/docs/resources/lb_certificate_v2.md @@ -79,31 +79,32 @@ EOT The following arguments are supported: -* `region` - (Optional) The region in which to obtain the V2 Networking client. - A Networking client is needed to create an LB certificate. If omitted, the - `region` argument of the provider is used. Changing this creates a new - LB certificate. +* `region` - (Optional, String, ForceNew) The region in which to obtain the V2 Networking client. + A Networking client is needed to create an LB certificate. If omitted, the + `region` argument of the provider is used. Changing this creates a new LB certificate. -* `name` - (Optional) Human-readable name for the Certificate. Does not have - to be unique. +* `name` - (Optional, String) Human-readable name for the Certificate. Does not have to be unique. -* `private_key` - (Required) The private encrypted key of the Certificate, PEM format. +* `private_key` - (Required, String) The private encrypted key of the Certificate, PEM format. -* `certificate` - (Required) The public encrypted key of the Certificate, PEM format. +* `certificate` - (Required, String) The public encrypted key of the Certificate, PEM format. -* `description` - (Optional) Human-readable description for the Certificate. +* `description` - (Optional, String) Human-readable description for the Certificate. -* `domain` - (Optional) The domain of the Certificate. +* `domain` - (Optional, String) The domain of the Certificate. -## Attributes Reference +## Attribute Reference -The following attributes are exported: +In addition to all arguments above, the following attributes are exported: -* `region` - See Argument Reference above. -* `name` - See Argument Reference above. -* `description` - See Argument Reference above. -* `domain` - See Argument Reference above. -* `private_key` - See Argument Reference above. -* `certificate` - See Argument Reference above. * `update_time` - Indicates the update time. + * `create_time` - Indicates the creation time. + +## Timeouts + +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 5 minutes. diff --git a/docs/resources/lb_l7policy_v2.md b/docs/resources/lb_l7policy_v2.md index a090d7eee..f266aa196 100644 --- a/docs/resources/lb_l7policy_v2.md +++ b/docs/resources/lb_l7policy_v2.md @@ -44,53 +44,42 @@ resource "flexibleengine_lb_l7policy_v2" "l7policy_1" { The following arguments are supported: -* `region` - (Optional) The region in which to obtain the V2 Networking client. - A Networking client is needed to create an . If omitted, the - `region` argument of the provider is used. Changing this creates a new - L7 Policy. +* `region` - (Optional, String, ForceNew) The region in which to obtain the V2 Networking client. + A Networking client is needed to create an . If omitted, the + `region` argument of the provider is used. Changing this creates a new L7 Policy. -* `name` - (Optional) Human-readable name for the L7 Policy. Does not have - to be unique. +* `name` - (Optional, String) Human-readable name for the L7 Policy. Does not have to be unique. -* `description` - (Optional) Human-readable description for the L7 Policy. +* `description` - (Optional, String) Human-readable description for the L7 Policy. -* `action` - (Required) The L7 Policy action - can either be REDIRECT_TO_POOL, - or REDIRECT_TO_LISTENER. Changing this creates a new L7 Policy. +* `action` - (Required, String, ForceNew) The L7 Policy action - can either be REDIRECT_TO_POOL, + or REDIRECT_TO_LISTENER. Changing this creates a new L7 Policy. -* `listener_id` - (Required) The Listener on which the L7 Policy will be associated with. - Changing this creates a new L7 Policy. +* `listener_id` - (Required, String, ForceNew) The Listener on which the L7 Policy will be associated with. + Changing this creates a new L7 Policy. -* `position` - (Optional) The position of this policy on the listener. Positions start at 1. - Changing this creates a new L7 Policy. +* `position` - (Optional, Int, ForceNew) The position of this policy on the listener. Positions start at 1. + Changing this creates a new L7 Policy. -* `redirect_pool_id` - (Optional) Requests matching this policy will be redirected to - the pool with this ID. Only valid if action is REDIRECT_TO_POOL. +* `redirect_pool_id` - (Optional, String) Requests matching this policy will be redirected to + the pool with this ID. Only valid if action is REDIRECT_TO_POOL. -* `redirect_listener_id` - (Optional) Requests matching this policy will be redirected to - the listener with this ID. Only valid if action is REDIRECT_TO_LISTENER. +* `redirect_listener_id` - (Optional, String) Requests matching this policy will be redirected to + the listener with this ID. Only valid if action is REDIRECT_TO_LISTENER. -* `admin_state_up` - (Optional) The administrative state of the L7 Policy. - This value can only be true (UP). +## Attribute Reference -* `tenant_id` - (Optional) The UUID of the tenant who owns the L7 Policy. - Only administrative users can specify a tenant UUID other than their own. - Changing this creates a new L7 Policy. +In addition to all arguments above, the following attributes are exported: -## Attributes Reference +* `id` - The unique ID for the L7 policy. -The following attributes are exported: +## Timeouts -* `id` - The unique ID for the L7 {olicy. -* `region` - See Argument Reference above. -* `tenant_id` - See Argument Reference above. -* `name` - See Argument Reference above. -* `description` - See Argument Reference above. -* `action` - See Argument Reference above. -* `listener_id` - See Argument Reference above. -* `position` - See Argument Reference above. -* `redirect_pool_id` - See Argument Reference above. -* `redirect_listener_id` - See Argument Reference above. -* `admin_state_up` - See Argument Reference above. +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 10 minutes. ## Import diff --git a/docs/resources/lb_l7rule_v2.md b/docs/resources/lb_l7rule_v2.md index d25b5dbb6..94ae56258 100644 --- a/docs/resources/lb_l7rule_v2.md +++ b/docs/resources/lb_l7rule_v2.md @@ -51,50 +51,38 @@ resource "flexibleengine_lb_l7rule_v2" "l7rule_1" { The following arguments are supported: -* `region` - (Optional) The region in which to obtain the V2 Networking client. - A Networking client is needed to create an . If omitted, the - `region` argument of the provider is used. Changing this creates a new - L7 Rule. +* `region` - (Optional, String, ForceNew) The region in which to obtain the V2 Networking client. + A Networking client is needed to create an . If omitted, the + `region` argument of the provider is used. Changing this creates a new L7 Rule. -* `description` - (Optional) Human-readable description for the L7 Rule. +* `type` - (Required, String, ForceNew) The L7 Rule type - can either be HOST_NAME or PATH. + Changing this creates a new L7 Rule. -* `type` - (Required) The L7 Rule type - can either be HOST_NAME or PATH. - Changing this creates a new L7 Rule. +* `compare_type` - (Required, String) The comparison type for the L7 rule - can either be + STARTS_WITH, EQUAL_TO or REGEX -* `compare_type` - (Required) The comparison type for the L7 rule - can either be - STARTS_WITH, EQUAL_TO or REGEX +* `l7policy_id` - (Required, String, ForceNew) The ID of the L7 Policy to query. Changing this creates a new L7 Rule. -* `l7policy_id` - (Required) The ID of the L7 Policy to query. Changing this creates a new - L7 Rule. +* `value` - (Required, String) The value to use for the comparison. For example, the file type to compare. -* `value` - (Required) The value to use for the comparison. For example, the file type to - compare. +* `key` - (Optional, String, ForceNew) The key to use for the comparison. For example, the name of the cookie to + evaluate. Valid when `type` is set to COOKIE or HEADER. Changing this creates a new L7 Rule. -* `key` - (Optional) The key to use for the comparison. For example, the name of the cookie to - evaluate. Valid when `type` is set to COOKIE or HEADER. Changing this creates a new L7 Rule. +## Attribute Reference -* `admin_state_up` - (Optional) The administrative state of the L7 Rule. - The value can only be true (UP). +In addition to all arguments above, the following attributes are exported: -* `tenant_id` - (Optional) The UUID of the tenant who owns the L7 Rule. - Only administrative users can specify a tenant UUID other than their own. - Changing this creates a new L7 Rule. +* `id` - The unique ID for the L7 Rule. -## Attributes Reference +* `listener_id` - The ID of the Listener owning this resource. -The following attributes are exported: +## Timeouts -* `id` - The unique ID for the L7 Rule. -* `region` - See Argument Reference above. -* `tenant_id` - See Argument Reference above. -* `type` - See Argument Reference above. -* `compare_type` - See Argument Reference above. -* `l7policy_id` - See Argument Reference above. -* `value` - See Argument Reference above. -* `key` - See Argument Reference above. -* `invert` - See Argument Reference above. -* `admin_state_up` - See Argument Reference above. -* `listener_id` - The ID of the Listener owning this resource. +This resource provides the following timeouts configuration options: + +* `create` - Default is 10 minutes. +* `update` - Default is 10 minutes. +* `delete` - Default is 10 minutes. ## Import diff --git a/docs/resources/lb_listener_v2.md b/docs/resources/lb_listener_v2.md index 39d785f18..05d71054e 100644 --- a/docs/resources/lb_listener_v2.md +++ b/docs/resources/lb_listener_v2.md @@ -111,31 +111,29 @@ resource "flexibleengine_lb_listener_v2" "listener_1" { The following arguments are supported: -* `region` - (Optional) The region in which to create the listener resource. - If omitted, the `region` argument of the provider is used. - Changing this creates a new listener. +* `region` - (Optional, String, ForceNew) The region in which to create the listener resource. + If omitted, the `region` argument of the provider is used. Changing this creates a new listener. -* `loadbalancer_id` - (Required) The load balancer on which to provision this - listener. Changing this creates a new listener. +* `loadbalancer_id` - (Required, String, ForceNew) The load balancer on which to provision this + listener. Changing this creates a new listener. -* `protocol` - (Required) The protocol - can either be TCP, UDP, HTTP or TERMINATED_HTTPS. - Changing this creates a new listener. +* `protocol` - (Required, String, ForceNew) The protocol - can either be TCP, UDP, HTTP or TERMINATED_HTTPS. + Changing this creates a new listener. -* `protocol_port` - (Required) The port on which to listen for client traffic. - Changing this creates a new listener. +* `protocol_port` - (Required, Int, ForceNew) The port on which to listen for client traffic. + Changing this creates a new listener. -* `default_pool_id` - (Optional) The ID of the default pool with which the - listener is associated. Changing this creates a new listener. +* `default_pool_id` - (Optional, String, ForceNew) The ID of the default pool with which the + listener is associated. Changing this creates a new listener. -* `name` - (Optional) Human-readable name for the listener. Does not have - to be unique. +* `name` - (Optional, String) Human-readable name for the listener. Does not have to be unique. -* `description` - (Optional) Human-readable description for the listener. +* `description` - (Optional, String) Human-readable description for the listener. -* `tags` - (Optional) The key/value pairs to associate with the listener. +* `tags` - (Optional, Map) The key/value pairs to associate with the listener. * `http2_enable` - (Optional, Bool) Specifies whether to use HTTP/2. The default value is false. - This parameter is valid only when the protocol is set to *TERMINATED_HTTPS*. + This parameter is valid only when the protocol is set to *TERMINATED_HTTPS*. * `transparent_client_ip_enable` - (Optional, Bool) Specifies whether to pass source IP addresses of the clients to backend servers. @@ -155,21 +153,20 @@ The following arguments are supported: server, in seconds. This parameter is available only for HTTP and HTTPS listeners. The value ranges from 1 to 300, and the default value is 60. -* `default_tls_container_ref` - (Optional) A reference to a Barbican Secrets - container which stores TLS information. This is required if the protocol - is `TERMINATED_HTTPS`. See - [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) - for more information. +* `default_tls_container_ref` - (Optional, String) A reference to a Barbican Secrets + container which stores TLS information. This is required if the protocol is `TERMINATED_HTTPS`. See + [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) + for more information. -* `sni_container_refs` - (Optional) A list of references to Barbican Secrets - containers which store SNI information. See - [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) - for more information. +* `sni_container_refs` - (Optional, List) A list of references to Barbican Secrets + containers which store SNI information. See + [here](https://wiki.openstack.org/wiki/Network/LBaaS/docs/how-to-create-tls-loadbalancer) + for more information. -* `tls_ciphers_policy` - (Optional) Specifies the security policy used by the listener. - This parameter is valid only when the load balancer protocol is set to TERMINATED_HTTPS. - The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. - For details of cipher suites for each security policy, see the table below. +* `tls_ciphers_policy` - (Optional, String) Specifies the security policy used by the listener. + This parameter is valid only when the load balancer protocol is set to TERMINATED_HTTPS. + The value can be tls-1-0, tls-1-1, tls-1-2, or tls-1-2-strict, and the default value is tls-1-0. + For details of cipher suites for each security policy, see the table below.