Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(IAM): fix docs issues #1014

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
10 changes: 6 additions & 4 deletions docs/data-sources/identity_project_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ data "flexibleengine_identity_project_v3" "project_1" {

The following arguments are supported:

* `name` - (Optional) The name of the project.
* `name` - (Optional, String) The name of the project.

* `domain_id` - (Optional) The domain this project belongs to.
* `domain_id` - (Optional, String) The domain this project belongs to.

* `parent_id` - (Optional) The parent of this project.
* `parent_id` - (Optional, String) The parent of this project.

## Attributes Reference
* `enabled` - (Optional, Bool) The enabling status of this project.

## Attribute Reference

`id` is set to the ID of the found project. In addition, the following attributes
are exported:
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/lb_certificate_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ 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
* `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:

Expand Down
5 changes: 4 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,7 +31,7 @@ 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:

Expand Down
36 changes: 12 additions & 24 deletions docs/resources/elb_backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,15 @@ 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.

* `server_id` - (Required, String, ForceNew) Specifies the backend member ID.

* `address` - (Required, String, ForceNew) Specifies the private IP address of the backend member.

## Timeouts

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minutes.
* `delete` - Default is 10 minutes.
14 changes: 3 additions & 11 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,14 @@ 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

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `update` - Default is 10 minute.
* `delete` - Default is 5 minute.
* `expire_time` - Indicates the expired time.

## Import

Expand Down
28 changes: 18 additions & 10 deletions docs/resources/elb_health.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,41 +27,41 @@ resource "flexibleengine_elb_health" "healthcheck" {

The following arguments are supported:

* `region` - (Optional) The region in which to create the elb health. If
* `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
* `listener_id` - (Required, String, ForceNew) Specifies the ID of the listener to which the health
check belongs.

* `healthcheck_protocol` - (Optional) Specifies the protocol used for the health
* `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
* `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
* `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
* `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
* `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
* `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
* `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:

Expand All @@ -75,3 +75,11 @@ The following attributes are exported:
* `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
68 changes: 37 additions & 31 deletions docs/resources/elb_listener.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,85 +37,85 @@ resource "flexibleengine_elb_listener" "listener" {

The following arguments are supported:

* `region` - (Optional) The region in which to create the elb listener. If
* `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
* `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
* `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
* `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.
be HTTP, TCP, or UDP. Changing this creates a new elb listener.

* `backend_port` - (Required) Specifies the backend port. The value ranges from
* `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
* `lb_algorithm` - (Required, String) Specifies the load balancing algorithm for the
listener. The value can be roundrobin, leastconn, or source.

* `description` - (Optional) Provides supplementary information about the listener.
* `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.
* `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 roundrobin, the value
of this parameter can only be false.
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.
* `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.
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).
* `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.
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
* `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
* `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)
* `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
* `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.
viewing the details of the SSL certificate. Changing this creates a new elb listener.

* `udp_timeout` - (Optional) Specifies the UDP timeout duration (minutes). This
* `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
* `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.
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.
* `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:

Expand All @@ -139,5 +139,11 @@ The following attributes are exported:
* `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.
Loading
Loading