Skip to content

Commit

Permalink
Update docs (d/mlb_*_v1)
Browse files Browse the repository at this point in the history
  • Loading branch information
hico-horiuchi committed Feb 19, 2024
1 parent e859a0c commit ec8820b
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 22 deletions.
2 changes: 2 additions & 0 deletions website/docs/d/mlb_certificate_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_certificate_v1" "certificate" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `tenant_id` - (Optional) ID of the owner tenant of the resource
* `ca_cert_status` - (Optional) CA certificate file upload status of the certificate
* Must be one of these values:
Expand Down
10 changes: 6 additions & 4 deletions website/docs/d/mlb_health_monitor_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_health_monitor_v1" "health_monitor" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down Expand Up @@ -94,15 +96,15 @@ In addition, the following attributes are exported:
* `load_balancer_id` - ID of the load balancer which the health monitor belongs to
* `tenant_id` - ID of the owner tenant of the health monitor
* `port` - Port number of the health monitor for healthchecking
* Returns `0` when `protocol` is `"icmp"`
* If `protocol` is `"icmp"`, returns `0`
* `protocol` - Protocol of the health monitor for healthchecking
* `interval` - Interval of healthchecking (in seconds)
* `retry` - Retry count of healthchecking
* Initial monitoring is not included
* Retry is executed at the interval specified by `interval`
* Retry is executed at the interval set in `interval`
* `timeout` - Timeout of healthchecking (in seconds)
* `path` - URL path of healthchecking
* Used when `protocol` is `"http"` or `"https"`
* If `protocol` is `"http"` or `"https"`, uses this parameter
* `http_status_code` - HTTP status codes expected in healthchecking
* Used when `protocol` is `"http"` or `"https"`
* If `protocol` is `"http"` or `"https"`, uses this parameter
* Format: `"xxx"` or `"xxx-xxx"` ( `xxx` between [100, 599])
2 changes: 2 additions & 0 deletions website/docs/d/mlb_listener_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_listener_v1" "listener" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down
15 changes: 9 additions & 6 deletions website/docs/d/mlb_load_balancer_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_load_balancer_v1" "load_balancer" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down Expand Up @@ -94,18 +96,19 @@ In addition, the following attributes are exported:
* `primary_availability_zone` - The zone / group where the primary virtual server of load balancer is deployed
* `secondary_availability_zone` - The zone / group where the secondary virtual server of load balancer is deployed
* `active_availability_zone` - Primary or secondary availability zone where the load balancer is currently running
* Return `"UNDEFINED"` if can not define active availability zone
* If can not define active availability zone, returns `"UNDEFINED"`
* `revision` - Revision of the load balancer
* `plan_id` - ID of the plan
* `plan_name` - Name of the plan
* `tenant_id` - ID of the owner tenant of the load balancer
* `syslog_servers` - Syslog servers to which access logs are transferred
* The facility code of syslog is 0 (kern), and the severity level is 6 (info)
* Only access logs to listeners which `protocol` is either `"http"` or `"https"` are transferred
* When `protocol` of `syslog_servers` is `"tcp"`
* Access logs are transferred to all healthy syslog servers specified in `syslog_servers`
* When `protocol` of `syslog_servers` is `"udp"`
* Access logs are transferred to the syslog server specified first in `syslog_servers` as long as it is healthy
* Access logs are transferred to the syslog server specified second (last) in `syslog_servers` when the first syslog server is not healthy
* If `protocol` of `syslog_servers` is `"tcp"`
* Access logs are transferred to all healthy syslog servers set in `syslog_servers`
* If `protocol` of `syslog_servers` is `"udp"`
* Access logs are transferred to the syslog server set first in `syslog_servers` as long as it is healthy
* Access logs are transferred to the syslog server set second (last) in `syslog_servers` if the first syslog server is not healthy
* Structure is [documented below](#syslog-servers)
* `interfaces` - Interfaces that attached to the load balancer
* Structure is [documented below](#interfaces)
Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/mlb_operation_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ data "ecl_mlb_operation_v1" "" {
* `"ERROR"`
* `"STUCK"`
* `tenant_id` - (Optional) ID of the owner tenant of the resource
* `no_deleted` - (Optional) When `true` is specified, operations of deleted resource is not displayed
* `latest` - (Optional) When `true` is specified, only the latest operation of each resource is displayed
* `no_deleted` - (Optional) If `true` is set, operations of deleted resource is not displayed
* `latest` - (Optional) If `true` is set, only the latest operation of each resource is displayed

## Attributes Reference

Expand Down
2 changes: 2 additions & 0 deletions website/docs/d/mlb_plan_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_plan_v1" "50M_HA_4IF" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `bandwidth` - (Optional) Bandwidth of the plan
* Must be one of these values:
* `"50M"`
Expand Down
17 changes: 9 additions & 8 deletions website/docs/d/mlb_policy_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_policy_v1" "policy" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand All @@ -51,8 +53,7 @@ data "ecl_mlb_policy_v1" "policy" {
* `"none"`
* `"source-ip"`
* `"cookie"`
* `sorry_page_url` - (Optional) URL of the sorry page to which accesses are redirected when all members in the target group are down
* Must be specified as URL format
* `sorry_page_url` - (Optional) URL of the sorry page to which accesses are redirected if all members in the target group are down
* `source_nat` - (Optional) Source NAT setting of the policy
* Must be one of these values:
* `"enable"`
Expand Down Expand Up @@ -104,17 +105,17 @@ In addition, the following attributes are exported:
* `tenant_id` - ID of the owner tenant of the policy
* `algorithm` - Load balancing algorithm (method) of the policy
* `persistence` - Persistence setting of the policy
* `"cookie"` is used when `listener.protocol` is `"http"` or `"https"`
* `sorry_page_url` - URL of the sorry page to which accesses are redirected when all members in the target group are down
* Returns `""` when protocol is not `"http"` or `"https"`
* If `listener.protocol` is `"http"` or `"https"`, `"cookie"` is available
* `sorry_page_url` - URL of the sorry page to which accesses are redirected if all members in the target group are down
* If protocol is not `"http"` or `"https"`, returns `""`
* `source_nat` - Source NAT setting of the policy
* When `source_nat` is `"enable"` and `listener.protocol` is `"http"` or `"https"` ,
* If `source_nat` is `"enable"` and `listener.protocol` is `"http"` or `"https"` ,
* The source IP address of the request is replaced with `virtual_ip_address` which is assigned to the interface from which the request was sent
* `X-Forwarded-For` header with the IP address of the client is added
* `certificate_id` - ID of the certificate that assigned to the policy
* Returns `""` when protocol is not `"https"`
* If protocol is not `"https"`, returns `""`
* `health_monitor_id` - ID of the health monitor that assigned to the policy
* `listener_id` - ID of the listener that assigned to the policy
* `default_target_group_id` - ID of the default target group that assigned to the policy
* `tls_policy_id` - ID of the TLS policy that assigned to the policy
* Returns `""` when protocol is not `"https"`
* If protocol is not `"https"`, returns `""`
2 changes: 2 additions & 0 deletions website/docs/d/mlb_route_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_route_v1" "route" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down
2 changes: 2 additions & 0 deletions website/docs/d/mlb_rule_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_rule_v1" "rule" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down
4 changes: 3 additions & 1 deletion website/docs/d/mlb_system_update_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ data "ecl_mlb_system_update_v1" "security_update_202210" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `href` - (Optional) URL of announcement for the system update (for example, Knowledge Center news)
* `current_revision` - (Optional) Current revision for the system update
* `next_revision` - (Optional) Next revision for the system update
* `applicable` - (Optional) Whether the system update can be applied to the load balancer
* `latest` - (Optional) When `true` is specified, only the latest resource is displayed
* `latest` - (Optional) If `true` is set, only the latest resource is displayed

## Attributes Reference

Expand Down
4 changes: 3 additions & 1 deletion website/docs/d/mlb_target_group_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_target_group_v1" "target_group" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `configuration_status` - (Optional) Configuration status of the resource
* Must be one of these values:
* `"ACTIVE"`
Expand Down Expand Up @@ -87,4 +89,4 @@ In addition, the following attributes are exported:
* `ip_address` - IP address of the member (real server)
* `port` - Port number of the member (real server)
* `weight` - Weight for the member (real server)
* Used when `policy.algorithm` is `"weighted-round-robin"` or `"weighted-least-connection"`
* If `policy.algorithm` is `"weighted-round-robin"` or `"weighted-least-connection"`, uses this parameter
2 changes: 2 additions & 0 deletions website/docs/d/mlb_tls_policy_v1.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ data "ecl_mlb_tls_policy_v1" "TLSv1.2_202210_01" {

* `id` - (Optional) ID of the resource
* `name` - (Optional) Name of the resource
* This field accepts single-byte characters only
* `description` - (Optional) Description of the resource
* This field accepts single-byte characters only
* `default` - (Optional) Whether the TLS policy will be set `policy.tls_policy_id` when that is not specified

## Attributes Reference
Expand Down

0 comments on commit ec8820b

Please sign in to comment.