Skip to content

Commit 28527cb

Browse files
authored
fixed docs for is_lb_listener_policy_rule and container_cluster_config (IBM-Cloud#6438)
* fixed ibm_container_cluster_config example 6 * fixed load balancer listener policy rule docs * fixed ibm_is_lb_pool_member resource documentation * fixed lb_listener_policy_rule example and type description * updated the import section to add import block * Update is_lb_listener_policy_rule.html.markdown
1 parent 7304215 commit 28527cb

File tree

3 files changed

+38
-15
lines changed

3 files changed

+38
-15
lines changed

website/docs/d/container_cluster_config.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Example for getting kubeconfig for VPC Kubernetes cluster with admin certificate
110110
data "ibm_container_cluster_config" "cluster_foo" {
111111
cluster_name_id = "FOO"
112112
config_dir = "/home/foo_config"
113-
admint = "true"
113+
admin = "true"
114114
endpoint_type = "vpe"
115115
}
116116
```

website/docs/r/is_lb_listener_policy_rule.html.markdown

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |-
77
Manages IBM VPC load balancer listener policy rule.
88
---
99

10-
# ibm_is_lb_listener_policy
10+
# ibm_is_lb_listener_policy_rule
1111
Create, update, or delete a VPC load balancer listener policy rule. For more information, about load balancer listener policy and rules, see [layer 7 load balancing policies and rules](https://cloud.ibm.com/docs/vpc?topic=vpc-layer-7-load-balancing).
1212

1313
**Note:**
@@ -85,7 +85,7 @@ resource "ibm_is_lb_listener_policy" "example" {
8585
target_url = "https://www.redirect.com"
8686
rules {
8787
condition = "contains"
88-
type = "header"
88+
type = "tcp"
8989
field = "1"
9090
value = "2"
9191
}
@@ -105,7 +105,7 @@ resource "ibm_is_lb_listener_policy_rule" "example" {
105105

106106

107107
## Timeouts
108-
The `ibm_is_lb_listener_policy` rule provides the following [Timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:
108+
The `ibm_is_lb_listener_policy_rule` rule provides the following [Timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:
109109

110110
- **Create**: The creation of the resource is considered failed if no response is received for 10 minutes.
111111
- **Update**: The update of the resource is considered failed if no response is received for 10 minutes.
@@ -119,27 +119,50 @@ Review the argument references that you can specify for your resource.
119119
- `lb` - (Required, Forces new resource, String) The ID of the load balancer for which you want to create a listener policy rule.
120120
- `listener` - (Required, Forces new resource, String) The ID of the load balancer listener for which you want to create a policy rule.
121121
- `policy` - (Required, Forces new resource, String) The ID of the load balancer listener policy for which you want to create a policy rule.
122-
- `type` - (Required, String) The object where you want to apply the rule. Supported values are `header`, `hostname`,`sni_hostname` and `path`.
122+
- `type` - (Required, String) The object where you want to apply the rule. Supported values are `body`, `header`, `hostname`, `path`, `query`, and `sni_hostname`.
123+
The content the rule applies to:
124+
- `body`: The UTF-8 form-encoded HTTP request body
125+
- `header`: The HTTP header
126+
- `hostname`: The fully-qualified domain name of the server specified in the Host HTTP request header
127+
- `path`: The path of the HTTP request
128+
- `query`: The query of the HTTP request URL
129+
- `sni_hostname`: The fully-qualified domain name of the server provided in the "server name indicator" extension during TLS negotiation
130+
- For listeners with protocol http or https, any type may be specified.
131+
- For listeners with protocol tcp, only type `sni_hostname` may be specified.
132+
123133
- `value` - (Required, String) The value that must match the rule condition. The value can be between 1 and 128 characters long. No.
124134

125135
## Attribute reference
126136
In addition to all argument reference list, you can access the following attribute reference after your resource is created.
127137

128-
- `id` - (String) The ID of the load balancer listener policy rule. The ID is composed of ` <loadbalancer_ID>/<listener_ID>/<policy>ID>`.
138+
- `id` - (String) The ID of the load balancer listener policy rule. The ID is composed of ` <loadbalancer_ID>/<listener_ID>/<policy_ID>/<rule_ID>`.
129139
- `rule` - (String) The ID of the rule.
130-
- `status` - (String) The status of the load balancer listener.
140+
- `status` - (String) The status of the load balancer listener policy rule.
141+
131142

132143
## Import
133-
The `ibm_is_lb_listener_policy_rule` resource can be imported by using `lb_ID`, `listener_ID`, `policy_ID` and `rule_ID`.
134144

135-
**Syntax**
145+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import the **listener policy rule** using `lb_ID`, `listener_ID`, `policy_ID`, and `rule_ID`.
146+
147+
**Example**
136148

149+
```hcl
150+
import {
151+
to = ibm_is_lb_listener_policy_rule.example
152+
id = "c1e3d5d3-8836-4328-b473-a90e0c9ba941/3ea13dc7-25b4-4c62-8cc7-0f7e092e7a8f/2161a3fb-123c-4a33-9a3d-b3154ef42009/356789523dc7-25b4-4c62-8cc7-0f7e092e7a8f"
153+
}
137154
```
138-
$ terraform import ibm_is_lb_listener_policy.example <loadbalancer_ID>/<listener_ID>/<policy>ID>
155+
156+
For versions prior to Terraform v1.5.0, use the `terraform import` command:
157+
158+
**Syntax**
159+
160+
```console
161+
$ terraform import ibm_is_lb_listener_policy_rule.example <loadbalancer_ID>/<listener_ID>/<policy_ID>/<rule_ID>
139162
```
140163

141164
**Example**
142165

143-
```
144-
$ terraform import ibm_is_lb_listener_policy.example c1e3d5d3-8836-4328-b473-a90e0c9ba941/3ea13dc7-25b4-4c62-8cc7-0f7e092e7a8f/2161a3fb-123c-4a33-9a3d-b3154ef42009/356789523dc7-25b4-4c62-8cc7-0f7e092e7a8f
166+
```console
167+
$ terraform import ibm_is_lb_listener_policy_rule.example c1e3d5d3-8836-4328-b473-a90e0c9ba941/3ea13dc7-25b4-4c62-8cc7-0f7e092e7a8f/2161a3fb-123c-4a33-9a3d-b3154ef42009/356789523dc7-25b4-4c62-8cc7-0f7e092e7a8f
145168
```

website/docs/r/is_lb_pool_member.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ The `ibm_is_lb_pool_member` resource provides the following [Timeouts](https://w
7171
## Argument reference
7272
Review the argument references that you can specify for your resource.
7373

74-
- `lb` - (Required, Forces new resource, String) The load balancer unique identifier.
74+
- `lb` - (Required, Forces new resource, String) The load balancer unique identifier.
7575
- `pool` - (Required, Forces new resource, String) The load balancer pool unique identifier.
7676
- `port`- (Required, Integer) The port number of the application running in the server member.
77-
- `target_address` - (Required, String) The IP address of the pool member.
78-
- `target_id` - (Required, String) The unique identifier for the virtual server instance or application load balancer pool member. Required for network load balancer.
77+
- `target_address` - (Required, String) The IP address of the pool member.(Mutually exclusive with `target_id`)
78+
- `target_id` - (Required, String) The unique identifier for the virtual server instance or application load balancer pool member. Required for network load balancer. (Mutually exclusive with `target_address`)
7979

8080
- `weight` - (Optional, Integer) Weight of the server member. This option takes effect only when the load-balancing algorithm of its belonging pool is `weighted_round_robin`, Minimum allowed weight is `0` and Maximum allowed weight is `100`. Default: 50, Weight of the server member. Applicable only if the pool algorithm is weighted_round_robin.
8181

0 commit comments

Comments
 (0)