Skip to content

Commit

Permalink
Doc corrections for resource group to intimate id and subnet floating…
Browse files Browse the repository at this point in the history
… ip changes (#4025)

* resource group and floating ip changes

* upd

* upd

* consistency update
  • Loading branch information
BShrivastav authored Sep 16, 2022
1 parent 0865cd3 commit c3d43d1
Show file tree
Hide file tree
Showing 30 changed files with 65 additions and 66 deletions.
2 changes: 1 addition & 1 deletion website/docs/d/is_backup_policies.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ In addition to all argument reference list, you can access the following attribu
- `id` - (String) The unique identifier for this backup policy plan.
- `name` - (String) The unique user-defined name for this backup policy plan.
- `resource_type` - (String) The type of resource referenced.
- `resource_group` - (List) The resource group for this backup policy.
- `resource_group` - (List) The resource group object, for this backup policy.

Nested `resource_group` blocks have the following structure:
- `href` - (String) The URL for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_backup_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ In addition to all argument reference list, you can access the following attribu
- `id` - (String) The unique identifier for this backup policy plan.
- `name` - (String) The unique user-defined name for this backup policy plan.
- `resource_type` - (String) The type of resource referenced.
- `resource_group` - (List) The resource group for this backup policy.
- `resource_group` - (List) The resource group object, for this backup policy.

Nested `resource_group` blocks have the following structure:
- `href` - (String) The URL for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_floating_ips.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In addition to all argument references listed, you can access the following attr
- `href` - (String) The URL for this floating IP.
- `id` - (String) The unique identifier for this floating IP.
- `name` - (String) The unique user-defined name for this floating IP.
- `resource_group` - (List) The resource group for this floating IP.
- `resource_group` - (List) The resource group object, for this floating IP.

Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_flow_log.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In addition to all argument references listed, you can access the following attr
- `href` - (String) The URL for this flow log collector.
- `lifecycle_state` - (String) The lifecycle state of the flow log collector.
- `name` - (String) The unique user-defined name for this flow log collector.
- `resource_group` - (List) The resource group for this flow log collector.
- `resource_group` - (List) The resource group object, for this flow log collector.

Nested scheme for `resource_group`:
- `href` - (Required, String) The URL for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_flow_logs.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Review the attribute references that you can access after you retrieve your data
- `id` - (String) The unique identifier of the flow log collector.
- `lifecycle_state` - (String) The lifecycle state of the flow log collector.
- `name` - (String) The flow log collector name.
- `resource_group` - (String) The resource group of the flow log.
- `resource_group` - (String) The resource group Id of the flow log.
- `storage_bucket` - (String) The IBM Cloud Object Storage bucket name where the flow logs are logged.
- `target` - (String) The target ID that the flow log collector collects the flow logs.
- `vpc` - (String) The VPC of the flow log collector that are associated.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_ike_policies.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In addition to all argument references listed, you can access the following attr
- `key_lifetime` - (Integer) The key lifetime in seconds.
- `name` - (String) The user-defined name for this IKE policy.
- `negotiation_mode` - (String) The IKE negotiation mode. Only `main` is supported.
- `resource_group` - (List) The resource group for this IKE policy.
- `resource_group` - (List) The resource group object, for this IKE policy.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_ike_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ In addition to all argument references listed, you can access the following attr
- `key_lifetime` - (Integer) The key lifetime in seconds.
- `name` - (String) The user-defined name for this IKE policy.
- `negotiation_mode` - (String) The IKE negotiation mode. Only `main` is supported.
- `resource_group` - (List) The resource group for this IKE policy.
- `resource_group` - (List) The resource group object, for this IKE policy.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ In addition to all argument reference list, you can access the following attribu
- `subnet` - (String) The ID of the subnet that is used in the primary network interface.
- `security_groups` (List)A list of security groups that were created for the interface.
- `resource_controller_url` - (String) The URL of the IBM Cloud dashboard that you can use to see details for your instance.
- `resource_group` - (String) The name of the resource group where the instance was created.
- `resource_group` - (String) The resource group id, where the instance was created.
- `status` - (String) The status of the instance.
- `status_reasons` - (List) Array of reasons for the current status.

Expand Down
46 changes: 23 additions & 23 deletions website/docs/d/is_ipsec_policies.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,30 @@ data "ibm_is_ipsec_policies" "example" {

In addition to all argument references listed, you can access the following attribute references after your data source is created.

- `ipsec_policies` - (Required, List) Collection of IPsec policies.
- `ipsec_policies` - (List) Collection of IPsec policies.
Nested scheme for **ipsec_policies**:
- `authentication_algorithm` - (Required, String) The authentication algorithm.
- `connections` - (Required, List) The VPN gateway connections that use this IPsec policy.
- `authentication_algorithm` - (String) The authentication algorithm.
- `connections` - (List) The VPN gateway connections that use this IPsec policy.
Nested scheme for **connections**:
- `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for **deleted**:
- `more_info` - (Required, String) Link to documentation about deleted resources.
- `href` - (Required, String) The VPN connection's canonical URL.
- `id` - (Required, String) The unique identifier for this VPN gateway connection.
- `name` - (Required, String) The user-defined name for this VPN connection.
- `resource_type` - (Required, String) The resource type.
- `created_at` - (Required, String) The date and time that this IPsec policy was created.
- `encapsulation_mode` - (Required, String) The encapsulation mode used. Only `tunnel` is supported.
- `encryption_algorithm` - (Required, String) The encryption algorithm.
- `href` - (Required, String) The IPsec policy's canonical URL.
- `id` - (Required, String) The unique identifier for this IPsec policy.
- `key_lifetime` - (Required, Integer) The key lifetime in seconds.
- `name` - (Required, String) The user-defined name for this IPsec policy.
- `pfs` - (Required, String) Perfect Forward Secrecy.
- `resource_group` - (Required, List) The resource group for this IPsec policy.
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The VPN connection's canonical URL.
- `id` - (String) The unique identifier for this VPN gateway connection.
- `name` - (String) The user-defined name for this VPN connection.
- `resource_type` - (String) The resource type.
- `created_at` - (String) The date and time that this IPsec policy was created.
- `encapsulation_mode` - (String) The encapsulation mode used. Only `tunnel` is supported.
- `encryption_algorithm` - (String) The encryption algorithm.
- `href` - (String) The IPsec policy's canonical URL.
- `id` - (String) The unique identifier for this IPsec policy.
- `key_lifetime` - (Integer) The key lifetime in seconds.
- `name` - (String) The user-defined name for this IPsec policy.
- `pfs` - (String) Perfect Forward Secrecy.
- `resource_group` - (List) The resource group object, for this IPsec policy.
Nested scheme for **resource_group**:
- `href` - (Required, String) The URL for this resource group.
- `id` - (Required, String) The unique identifier for this resource group.
- `name` - (Required, String) The user-defined name for this resource group.
- `resource_type` - (Required, String) The resource type.
- `transform_protocol` - (Required, String) The transform protocol used. Only `esp` is supported.
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
- `name` - (String) The user-defined name for this resource group.
- `resource_type` - (String) The resource type.
- `transform_protocol` - (String) The transform protocol used. Only `esp` is supported.
2 changes: 1 addition & 1 deletion website/docs/d/is_ipsec_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ In addition to all argument references listed, you can access the following attr
- `key_lifetime` - (Integer) The key lifetime in seconds.
- `name` - (String) The user-defined name for this IPsec policy.
- `pfs` - (String) Perfect Forward Secrecy.
- `resource_group` - (List) The resource group for this IPsec policy.
- `resource_group` - (List) The resource group object, for this IPsec policy.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_lb.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ In addition to all argument reference list, you can access the following attribu
- `reserved_ip`- (String) The unique identifier for this reserved IP
- `resource_type`- (String) The resource type.
- `private_ips` - (List) The private IP addresses assigned to this load balancer. Same as `private_ip.[].address`
- `resource_group` - (String) The resource group where the load balancer is created.
- `resource_group` - (String) The resource group id, where the load balancer is created.
- `route_mode` - (Bool) Indicates whether route mode is enabled for this load balancer.
- `security_groups`- (String) A list of security groups that are used with this load balancer. This option is supported only for application load balancers.
- `security_groups_supported`- (Bool) Indicates if this load balancer supports security groups.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_lbs.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Review the attribute references that you can access after you retrieve your data
- `private_ips` - (String) The private IP addresses assigned to this load balancer. Same as `private_ip.[].address`
- `provisioning_status` - (String) The provisioning status of this load balancer. Possible values are: **active**, **create_pending**, **delete_pending**, **failed**, **maintenance_pending**, **update_pending**-
- `public_ips` - (String) The public IP addresses assigned to this load balancer.
- `resource_group` - (String) The resource group where the load balancer is created.
- `resource_group` - (String) The resource group id, where the load balancer is created.
- `route_mode` - (Bool) Indicates whether route mode is enabled for this load balancer.
- `status` - (String) The status of the load balancers.
- `type` - (String) The type of the load balancer.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_network_acl.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In addition to all argument references listed, you can access the following attr
- `href` - (String) The URL for this network ACL.
- `id` - The unique identifier of the NetworkACL.
- `name` - (String) The user-defined name for this network ACL.
- `resource_group` - (List) The resource group for this network ACL.
- `resource_group` - (List) The resource group object, for this network ACL.

Nested scheme for `resource_group`:
- `href` - (String) The URL for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_network_acls.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In addition to all argument references listed, you can access the following attr
- `href` - (String) The URL for this network ACL.
- `id` - (String) The unique identifier for this network ACL.
- `name` - (String) The user-defined name for this network ACL.
- `resource_group` - (List) The resource group for this network ACL.
- `resource_group` - (List) The resource group object, for this network ACL.

Nested scheme for `resource_group`:
- `href` - (String) The URL for this resource group.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/d/is_security_groups.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,19 +62,19 @@ In addition to all argument references listed, you can access the following attr
- `vpc_crn` - Filters the collection to resources in the VPC with the specified CRN
- `resource_group` - Filters the collection to resources in the resource group with the specified identifier
- `security_groups` - (List) Collection of security groups.
Nested scheme for `security_groups`:
Nested scheme for `security_groups`:
- `created_at` - (String) The date and time that this security group was created.
- `crn` - (String) The security group's CRN.
- `href` - (String) The security group's canonical URL.
- `id` - (String) The unique identifier for this security group.
- `name` - (String) The user-defined name for this security group. Names must be unique within the VPC the security group resides in.
- `resource_group` - (List) The resource group for this security group.
Nested scheme for `resource_group`:
- `resource_group` - (List) The resource group object, for this security group.
Nested scheme for `resource_group`:
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
- `name` - (String) The user-defined name for this resource group.
- `rules` - (List) The rules for this security group. If no rules exist, all traffic will be denied.
Nested scheme for `rules`:
Nested scheme for `rules`:
- `code` - (Integer) The ICMP traffic code to allow.
- `direction` - (String) The direction of traffic to enforce, either `inbound` or `outbound`.
- `href` - (String) The URL for this security group rule.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/d/is_ssh_keys.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In addition to all argument references listed, you can access the following attr

- `id` - The unique identifier of the KeyCollection.
- `keys` - (List) Collection of keys.
Nested scheme for **keys**:
Nested scheme for **keys**:
- `created_at` - (String) The date and time that the key was created.
- `crn` - (String) The CRN for this key.
- `fingerprint` - (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always `SHA256`).
Expand All @@ -37,8 +37,8 @@ Nested scheme for **keys**:
- `name` - (String) The unique user-defined name for this key. If unspecified, the name will be a hyphenated list of randomly-selected words.
- Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$/`.
- `public_key` - (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
- `resource_group` - (List) The resource group for this key.
Nested scheme for **resource_group**:
- `resource_group` - (List) The resource group object, for this key.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`.
- `id` - (String) The unique identifier for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_subnet_reserved_ip.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In addition to all argument reference list, you can access the following attribu
- `created_at` - (String) The creation timestamp for the reserved IP.
- `href` - (String) The unique reference for the reserved IP.
- `id` - (String) The ID for the reserved IP.
- `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ]
- `lifecycle_state` - (String) The lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ]
- `name` - (String) The name for the reserved IP.
- `owner` - (String) The owner of the reserved IP.
- `reserved_ip` - (String) The ID for the reserved IP.
Expand Down
5 changes: 1 addition & 4 deletions website/docs/d/is_subnet_reserved_ips.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,18 @@ Review the argument references that you can specify for your data source.
## Attribute reference
In addition to the argument reference list, you can access the following attribute references after your data source is created.

- `id` - (String) The ID for the all the reserved ID in current timestamp format.
- `limit` - (String) The number of reserved IPs to list.
- `reserved_ips` - (List) The collection of all the reserved IPs in the subnet.

Nested scheme for `reserved_ips`:
- `address` - (String) The IP bound for the reserved IP.
- `auto_delete` - (String) If reserved IP shall be deleted automatically.
- `created_at` - (String) The date and time that the reserved IP was created.
- `href` - (String) The URL for this reserved IP.
- `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ]
- `lifecycle_state` - (String) The lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ]
- `reserved_ip` - (String) The unique identifier for this reserved IP.
- `name` - (String) The user defined or system provided name for this reserved IP.
- `owner` - (String) The owner of a reserved IP, defining whether it is managed by the user or the provider.
- `resource_type` - (String) The resource type.
- `sort` - (String) The keyword on which all the reserved IPs are sorted.
- `subnet` - (String) The ID for the subnet for the reserved IP.
- `total_count` - (String) The number of reserved IP in the subnet.

2 changes: 1 addition & 1 deletion website/docs/d/is_subnets.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ You can access the following attribute references after your data source is crea
- `name` - (String) The name of the subnet.
- `network_acl` - (String) The access control list (ACL) that is attached to the subnet.
- `public_gateway`- (Bool) If set to **true**, a public gateway is attached to the subnet. If set to **false**, no public gateway for this subnet exists.
- `resource_group` - (String) The resource group that the subnet belongs to.
- `resource_group` - (String) The resource group id, that the subnet belongs to.
- `total_ipv4_address_count`- (Integer) The total number of IPv4 addresses in the subnet.
- `status` - (String) The status of the subnet.
- `routing_table` - (List) The routing table for this subnet.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/d/is_volumes.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ In addition to all argument references listed, you can access the following attr
- Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`.
- `name` - (String) The globally unique name for this volume profile.
- Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`.
- `resource_group` - (List) The resource group for this volume.
Nested scheme for **resource_group**:
- `resource_group` - (List) The resource group object, for this volume.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`.
- `id` - (String) The unique identifier for this resource group.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/is_vpn_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ In addition to all argument references listed, you can access the following attr

- `name` - (String) The user-defined name for this VPN gateway.

- `resource_group` - (List) The resource group for this VPN gateway.
- `resource_group` - (List) The resource group object, for this VPN gateway.
Nested scheme for **resource_group**:
- `href` - (String) The URL for this resource group.
- `id` - (String) The unique identifier for this resource group.
Expand Down
Loading

0 comments on commit c3d43d1

Please sign in to comment.