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.

Sign up for GitHub

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

Jump to bottom

Doc correction: Share mount target doc corrections #4889

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Doc correction: Share mount target doc corrections #4889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 34 additions & 14 deletions website/docs/d/is_share_mount_target.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,39 @@ The following arguments are supported:

The following attributes are exported:

- `created_at` - The date and time that the share target was created.
- `href` - The URL for this share target.
- `lifecycle_state` - The lifecycle state of the mount target.
- `mount_path` - The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.
- `access_control_mode` - (String) The access control mode for the share.
- `created_at` - (String) The date and time that the share target was created.
- `href` - (String) The URL for this share target.
- `lifecycle_state` - (String) The lifecycle state of the mount target.
- `mount_path` - (String) The mount path for the share. The server component of the mount path may be either an IP address or a fully qualified domain name.

This property will be absent if the lifecycle_state of the mount target is 'pending', failed, or deleting.

-> **If the share's access_control_mode is:**
&#x2022; security_group: The IP address used in the mount path is the primary_ip address of the virtual network interface for this share mount target. </br>
&#x2022; vpc: The fully-qualified domain name used in the mount path is an address that resolves to the share mount target. </br>
- `name` - The user-defined name for this share target.
- `resource_type` - The type of resource referenced.
- `resource_type` - (String) The type of resource referenced.
- `transit_encryption` - (String) The transit encryption mode for this share target.
- `vpc` - The VPC to which this share target is allowing to mount the file share. Nested `vpc` blocks have the following structure:
- `crn` - The CRN for this VPC.
- `deleted` - If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - Link to documentation about deleted resources.
- `href` - The URL for this VPC.
- `id` - The unique identifier for this VPC.
- `name` - The unique user-defined name for this VPC.
- `resource_type` - The resource type.

- `vpc` - (List) The VPC to which this share target is allowing to mount the file share. Nested `vpc` blocks have the following structure:
- `crn` - (String) The CRN for this VPC.
- `deleted` - (String) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this VPC.
- `id` - (String) The unique identifier for this VPC.
- `name` - (String) The unique user-defined name for this VPC.
- `resource_type` - (String) The resource type.
- `subnet` - (List) The subnet of the virtual network interface for the share mount target. Nested `subnet` blocks have the following structure:
- `crn` - (String) The CRN for this subnet.
- `deleted` - (String) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this subnet.
- `id` - (String) The unique identifier for this subnet.
- `name` - (String) The unique user-defined name for this subnet.
- `resource_type` - (String) The resource type.
- `virtual_network_interface` - (List) The virtual network interface for this file share mount target.. Nested `virtual_network_interface` blocks have the following structure:
- `crn` - (String) The CRN for this virtual network interface.
- `href` - (String) The URL for this virtual network interface.
- `id` - (String) The unique identifier for this virtual network interface.
- `name` - (String) The unique user-defined name for this virtual network interface.
- `resource_type` - (String) The resource type.
49 changes: 35 additions & 14 deletions website/docs/d/is_share_mount_targets.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,41 @@ The following attributes are exported:

- `id` - The unique identifier of the ShareTargetCollection.
- `mount_targets` - Collection of share targets. Nested `targets` blocks have the following structure:
- `created_at` - The date and time that the share target was created.
- `href` - The URL for this share target.
- `id` - The unique identifier for this share target.
- `lifecycle_state` - The lifecycle state of the mount target.
- `mount_path` - The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.
- `name` - The user-defined name for this share target.
- `resource_type` - The type of resource referenced.
- `access_control_mode` - (String) The access control mode for the share.
- `created_at` - (String) The date and time that the share target was created.
- `href` - (String) The URL for this share target.
- `id` - (String) The unique identifier for this share target.
- `lifecycle_state` - (String) The lifecycle state of the mount target.
- `mount_path` - (String) The mount path for the share. The server component of the mount path may be either an IP address or a fully qualified domain name.

This property will be absent if the lifecycle_state of the mount target is 'pending', failed, or deleting.

-> **If the share's access_control_mode is:**
&#x2022; security_group: The IP address used in the mount path is the primary_ip address of the virtual network interface for this share mount target. </br>
&#x2022; vpc: The fully-qualified domain name used in the mount path is an address that resolves to the share mount target. </br>
- `name` - (String) The user-defined name for this share target.
- `resource_type` - (String) The type of resource referenced.
- `transit_encryption` - (String) The transit encryption mode for this share target.
- `vpc` - The VPC to which this share target is allowing to mount the file share. Nested `vpc` blocks have the following structure:
- `crn` - The CRN for this VPC.
- `deleted` - If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - Link to documentation about deleted resources.
- `href` - The URL for this VPC.
- `id` - The unique identifier for this VPC.
- `name` - The unique user-defined name for this VPC.
- `resource_type` - The resource type.
- `crn` - (String) The CRN for this VPC.
- `deleted` - (String) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this VPC.
- `id` - (String) The unique identifier for this VPC.
- `name` - (String) The unique user-defined name for this VPC.
- `resource_type` - (String) The resource type.
- `subnet` - (List) The subnet of the virtual network interface for the share mount target. Nested `subnet` blocks have the following structure:
- `crn` - (String) The CRN for this subnet.
- `deleted` - (String) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested `deleted` blocks have the following structure:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this subnet.
- `id` - (String) The unique identifier for this subnet.
- `name` - (String) The unique user-defined name for this subnet.
- `resource_type` - (String) The resource type.
- `virtual_network_interface` - (List) The virtual network interface for this file share mount target.. Nested `virtual_network_interface` blocks have the following structure:
- `crn` - (String) The CRN for this virtual network interface.
- `href` - (String) The URL for this virtual network interface.
- `id` - (String) The unique identifier for this virtual network interface.
- `name` - (String) The unique user-defined name for this virtual network interface.
- `resource_type` - (String) The resource type.

22 changes: 14 additions & 8 deletions website/docs/r/is_share_mount_target.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,20 @@ The following arguments are supported:

The following attributes are exported:


- `mount_target` - The unique identifier of the share target
- `created_at` - The date and time that the share target was created.
- `href` - The URL for this share target.
- `id` - The unique identifier of the ShareTarget. The id is composed of \<ibm_is_share_id\>/\<ibm_is_share_mount_target_id\>
- `lifecycle_state` - The lifecycle state of the mount target.
- `mount_path` - The mount path for the share.The IP addresses used in the mount path are currently within the IBM services IP range, but are expected to change to be within one of the VPC's subnets in the future.
- `resource_type` - The type of resource referenced.
- `access_control_mode` - (String) The access control mode for the share.
- `mount_target` - (String) The unique identifier of the share target
- `created_at` - (String) The date and time that the share target was created.
- `href` - (String) The URL for this share target.
- `id` - (String) The unique identifier of the ShareTarget. The id is composed of \<ibm_is_share_id\>/\<ibm_is_share_mount_target_id\>
- `lifecycle_state` - (String) The lifecycle state of the mount target.
- `mount_path` - (String) The mount path for the share. The server component of the mount path may be either an IP address or a fully qualified domain name.

This property will be absent if the lifecycle_state of the mount target is 'pending', failed, or deleting.

-> **If the share's access_control_mode is:**
&#x2022; security_group: The IP address used in the mount path is the primary_ip address of the virtual network interface for this share mount target. </br>
&#x2022; vpc: The fully-qualified domain name used in the mount path is an address that resolves to the share mount target. </br>
- `resource_type` - (String) The type of resource referenced.
- `transit_encryption` - (String) The transit encryption mode for this share target.

## Import
Expand Down
Loading