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

Doc corrections for resource group to intimate id and subnet floating ip changes #4025

Merged
merged 4 commits into from
Sep 16, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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 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_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, for this IKE policy.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we have same consistent

`resource_group` - (List) The resource group object,....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected from
resource_group - (List) The resource group,
to
resource_group - (List) The resource group object,....
across multiple files.

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 @@ -165,7 +165,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
6 changes: 3 additions & 3 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`:
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
4 changes: 2 additions & 2 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 @@ -38,7 +38,7 @@ Nested scheme for **keys**:
- 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**:
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
2 changes: 1 addition & 1 deletion website/docs/d/is_volumes.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In addition to all argument references listed, you can access the following attr
- `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**:
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/r/is_backup_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Review the argument reference that you can specify for your resource.
- `match_resource_types` - (Optional, List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is `["volume"]`.
- `match_user_tags` - (Required, List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.
- `name` - (Required, String) The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in.
- `resource_group` - (Optional, List) The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.
- `resource_group` - (Optional, List) The resource group id, to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.

Nested scheme for `resource_group`:
- `id` - (Optional, String) The unique identifier for this resource group.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ In addition to all argument reference list, you can access the following attribu
- `source_port_min` - (String) The inclusive minimum bound of UDP source port range.
- `subnets` - (String) The subnets to which this network ACL is attached.
- `vpc` - (String) The VPC to which this network ACL is a part of.
- `resource_group` - (String) The resource group of this network ACL.
- `resource_group` - (String) The resource group (Id), of this network ACL.
- `rules` - (List) The ordered rules of this network ACL. If rules does not exist, all traffic will be denied. Nested rules blocks has the following structure.

Nested scheme for `rules`:
Expand Down
8 changes: 5 additions & 3 deletions website/docs/r/is_subnet_reserved_ip.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ resource "ibm_is_subnet" "example" {
total_ipv4_address_count = 256
}

// Create the resrved IP in the following ways
// Create the reserved IP in the following ways

// Only with Subnet ID
resource "ibm_is_subnet_reserved_ip" "example" {
Expand Down Expand Up @@ -92,7 +92,9 @@ Review the argument references that you can specify for your resource.

- `address` - (Optional, Forces new resource, String) The IP address.
- `auto_delete`- (Optional, Bool) If reserved IP is auto deleted.
- `name` - (Optional, String) The name of the reserved IP. ~> **NOTE:** raise error if name is given with a prefix `ibm- `.
- `name` - (Optional, String) The name of the reserved IP.

~> **NOTE:** raise error if name is given with a prefix `ibm- `.
- `subnet` - (Required, Forces new resource, String) The subnet ID for the reserved IP.
- `target` - (Optional, string) The ID for the target endpoint gateway for the reserved IP.

Expand All @@ -101,7 +103,7 @@ In addition to all argument reference list, you can access the following attribu

- `created_at` - (Timestamp) The date and time that the reserved IP was created.",
- `href` - (String) The URL for this reserved IP.
- `id` - (String) The combination of the subnet ID and reserved IP ID separated by **/**.
- `id` - (String) The combination of the subnet ID and reserved IP separated by **/**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it not reserved IP ID

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reverted.

- `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ]
- `owner` - (String) The owner of a reserved IP, defining whether it is managed by the user or the provider.
- `reserved_ip` - (String) The reserved IP.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/is_vpn_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Review the argument references that you can specify for your resource.

- `mode`- (Optional, String) Mode in VPN gateway. Supported values are `route` or `policy`. The default value is `route`.
- `name` - (Required, String) The name of the VPN gateway.
- `resource_group` - (Optional, Forces new resource, String) The resource group where the VPN gateway to be created.
- `resource_group` - (Optional, Forces new resource, String) The resource group (id), where the VPN gateway to be created.
- `subnet` - (Required, Forces new resource, String) The unique identifier for this subnet.
- `tags`- (Optional, Array of Strings) A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.

Expand Down
Loading