Skip to content

Commit

Permalink
docs(elb): fix docs issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Zippo-Wang committed Oct 16, 2023
1 parent f653c6b commit 976389c
Show file tree
Hide file tree
Showing 28 changed files with 529 additions and 609 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/elb_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
19 changes: 9 additions & 10 deletions docs/data-sources/lb_certificate_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
7 changes: 6 additions & 1 deletion docs/data-sources/lb_loadbalancer_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
41 changes: 17 additions & 24 deletions docs/resources/elb_backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 5 additions & 10 deletions docs/resources/elb_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down
70 changes: 34 additions & 36 deletions docs/resources/elb_health.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 5 additions & 10 deletions docs/resources/elb_ipgroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a name="elb_ip_list"></a>
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.

Expand Down
Loading

0 comments on commit 976389c

Please sign in to comment.