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

Documentation correction and ux update #4529

Merged
merged 4 commits into from
May 3, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
12 changes: 11 additions & 1 deletion website/docs/d/is_bare_metal_server.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,17 @@ In addition to all argument reference list, you can access the following attribu
- `profile` - (String) The name for this bare metal server profile
- `resource_group` - (String) resource group id of the bare metal server.
- `resource_type` - (String) The type of resource referenced
- `status` - (String) The status of the bare metal server [ **failed**, **pending**, **restarting**, **running**, **starting**, **stopped**, **stopping** ]
- `status` - (String) The status of the bare metal server.

-> **Supported Status**
• failed
</br>&#x2022; pending
</br>&#x2022; restarting
</br>&#x2022; running
</br>&#x2022; starting
</br>&#x2022; stopped
</br>&#x2022; stopping

- `status_reasons` - (List) Array of reasons for the current status (if any).
Nested scheme for `status_reasons`:
- `code` - (String) The status reason code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,14 @@ In addition to the argument reference list, you can access the following attribu
- `name` - (String) The user-defined or system-provided name for this reserved IP
- `resource_type` - (String)The resource type [ **subnet_reserved_ip** ]
- `security_groups` - (Array) Collection of security groups
- `status` - (String) The status of the network interface. Supported values are [ **available**, **deleting**, **failed**, **pending** ]
- `status` - (String) The status of the network interface.

->**Supported Statuses:**
</br>&#x2022; available
</br>&#x2022; deleting
</br>&#x2022; failed
</br>&#x2022; pending

- `subnet` - (List) The associated subnet
- `type` - (String) The type of this bare metal server network interface. Supported values are [ **primary**, **secondary** ]
- `vlan` - (Integer) Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,14 @@ In addition to the argument reference list, you can access the following attribu
- `resource_type` - (String)The resource type [ **subnet_reserved_ip** ]

- `security_groups` - (Array) Collection of security groups
- `status` - (String) The status of the network interface. Supported values are [ **available**, **deleting**, **failed**, **pending** ]
- `status` - (String) The status of the network interface.

->**Supported Status**
&#x2022; available
</br>&#x2022; deleting
</br>&#x2022; failed
</br>&#x2022; pending

- `subnet` - (List) The associated subnet
- `type` - (String) The type of this bare metal server network interface. Supported values are [ **primary**, **secondary** ]
- `vlan` - (Integer) Indicates the 802.1Q VLAN ID tag that must be used for all traffic on this interface
Expand Down
24 changes: 12 additions & 12 deletions website/docs/d/is_bare_metal_server_profiles.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,62 +37,62 @@ Review the attribute references that you can access after you retrieve your data
- `profiles` - List of all bare metal server profiles in the IBM Cloud Infrastructure.
- `bandwidth` - (List) The total bandwidth (in megabits per second) shared across the network interfaces of a bare metal server with this profile.

Nested scheme for `bandwidth`:
Nested scheme for `bandwidth`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.
- `cpu_architecture` - (List) The CPU architecture for a bare metal server with this profile.

Nested scheme for `cpu_architecture`:
Nested scheme for `cpu_architecture`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.
- `cpu_core_count` - (List) The CPU core count for a bare metal server with this profile.

Nested scheme for `cpu_core_count`:
Nested scheme for `cpu_core_count`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.
- `cpu_socket_count` - (List) The number of CPU sockets for a bare metal server with this profile.

Nested scheme for `cpu_socket_count`:
Nested scheme for `cpu_socket_count`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.
- `disks` - (List) A nested block describing the collection of the bare metal server profile's disks.

Nested scheme for `disk`:
Nested scheme for `disk`:
- `quantity` - (List) The number of disks of this configuration for a bare metal server with this profile.

Nested scheme for `quantity`:
Nested scheme for `quantity`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.

- `size` - (List) The size of the disk in GB (gigabytes).

Nested scheme for `size`:
Nested scheme for `size`:
- `type` - (String) The type for this profile field.
- `value` - (Integer) The value for this profile field.
- `supported_interface_types` - (List) The disk interface used for attaching the disk.

Nested scheme for `supported_interface_types`:

Nested scheme for `supported_interface_types`:
- `default` - (String) The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
- `type` - (String) The type for this profile field.
- `values` - (Array) The supported disk interfaces used for attaching the disk.
- `family` - (String) The product family this bare metal server profile belongs to.
- `href` - (String) The URL for this bare metal server profile.
- `id` - (String) The name of the profile.
- `memory` - (List) The memory (in gibibytes) for a bare metal server with this profile.
Nested scheme for `memory`:
Nested scheme for `memory`:
- `type` - (String) The type for this profile field.
- `value` - (String) The value for this profile field.
- `name` - (String) The name of the profile.
- `os_architecture` - (List) The supported OS architecture(s) for a bare metal server with this profile.
Nested scheme for `os_architecture`:

Nested scheme for `os_architecture`:
- `default` - (String) The default OS architecture for a bare metal server with this profile
- `type` - (String) The type for this profile field.
- `values` - (Array) The supported OS architecture(s) for a bare metal server with this profile.
- `resource_type` - (String) The resource type.
- `supported_image_flags` - (Array) An array of flags supported by this bare metal server profile.
- `supported_trusted_platform_module_modes` - (List) An array of supported trusted platform module (TPM) modes for this bare metal server profile.

Nested scheme for `supported_trusted_platform_module_modes`:
Nested scheme for `supported_trusted_platform_module_modes`:
- `type` - (String) The type for this profile field.
- `values` - (Array) The supported trusted platform module (TPM) modes.
24 changes: 19 additions & 5 deletions website/docs/d/is_bare_metal_servers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,15 @@ Review the attribute references that you can access after you retrieve your data
- `memory` - (Integer) The amount of memory, truncated to whole gibibytes
- `name` - (String) The name of the bare metal server.
- `network_interfaces` - (List) A nested block describing the additional network interface of this instance.
Nested scheme for `network_interfaces`:

Nested scheme for `network_interfaces`:
- `allow_ip_spoofing` - (Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
- `href` - (String) The href of the network interface.
- `id` - (String) The id of the network interface.
- `name` - (String) The name of the network interface.
- `primary_ip` - (List) The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.
Nested scheme for `primary_ip`:

Nested scheme for `primary_ip`:
- `address` - (String) title: IPv4 The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
- `href`- (String) The URL for this reserved IP
- `reserved_ip`- (String) The unique identifier for this reserved IP
Expand All @@ -88,13 +90,15 @@ Review the attribute references that you can access after you retrieve your data
- `security_groups` - (Array) List of security groups.
- `subnet` - (String) ID of the subnet.
- `primary_network_interface` - (List) A nested block describing the primary network interface of this bare metal server.
Nested scheme for `primary_network_interface`:

Nested scheme for `primary_network_interface`:
- `allow_ip_spoofing` - (Bool) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface.
- `href` - (String) The href of the network interface.
- `id` - (String) The id of the network interface.
- `name` - (String) The name of the network interface.
- `primary_ip` - (List) The primary IP address to bind to the network interface. This can be specified using an existing reserved IP, or a prototype object for a new reserved IP.
Nested scheme for `primary_ip`:

Nested scheme for `primary_ip`:
- `address` - (String) title: IPv4 The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
- `href`- (String) The URL for this reserved IP
- `reserved_ip`- (String) The unique identifier for this reserved IP
Expand All @@ -106,7 +110,17 @@ Review the attribute references that you can access after you retrieve your data
- `profile` - (String) The name for this bare metal server profile
- `resource_group` - (String) resource group id of the bare metal server.
- `resource_type` - (String) The type of resource referenced
- `status` - (String) The status of the bare metal server [ **failed**, **pending**, **restarting**, **running**, **starting**, **stopped**, **stopping** ]
- `status` - (String) The status of the bare metal server.

->**Supported Status:**
</br>&#x2022; failed
</br>&#x2022; pending
</br>&#x2022; restarting
</br>&#x2022; running
</br>&#x2022; starting
</br>&#x2022; stopped
</br>&#x2022; stopping

- `status_reasons` - (List) Array of reasons for the current status (if any).
Nested scheme for `status_reasons`:
- `code` - (String) The status reason code
Expand Down
18 changes: 9 additions & 9 deletions website/docs/d/is_dedicated_host_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,19 @@ In addition to all argument reference list, you can access the following attribu
- `value` - (String) The interface of the disk for a dedicated host with this profileThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
- `quantity` - (List) The number of disks of this type for a dedicated host with this profile. Nested `quantity` blocks have the following structure:

Nested scheme for `quantity`:
- `type` - (String) The type for this profile field.
- `value` - (String) The value for this profile field.
Nested scheme for `quantity`:
- `type` - (String) The type for this profile field.
- `value` - (String) The value for this profile field.
- `size` - (List) The size of the disk in GB (gigabytes). Nested `size` blocks have the following structure:

Nested scheme for `size`:
- `type` - (String) The type for this profile field.
- `value` - (String) The size of the disk in GB (gigabytes).
Nested scheme for `size`:
- `type` - (String) The type for this profile field.
- `value` - (String) The size of the disk in GB (gigabytes).
- `supported_instance_interface_types` - (List) Nested `supported_instance_interface_types` blocks have the following structure:

Nested scheme for `supported_instance_interface_types`:
- `type` - (String) The type for this profile field.
- `value` - (String) The instance disk interfaces supported for a dedicated host with this profile.
Nested scheme for `supported_instance_interface_types`:
- `type` - (String) The type for this profile field.
- `value` - (String) The instance disk interfaces supported for a dedicated host with this profile.
- `family`- (String) The product family this dedicated host profile belongs to.
- `href`- (String) The URL for this dedicated host.
- `id`- (String) The unique identifier of the dedicated host profile.
Expand Down
27 changes: 13 additions & 14 deletions website/docs/d/is_dedicated_host_profiles.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,23 @@ Review the argument references that you can specify for your data source.
Nested scheme for `disks`:
- `interface_type` (List) Nested `interface_type` blocks have the following structure:

Nested scheme for `interface_type`:
- `type` - (String) The type for this profile field.
- `value` - (String) The interface of the disk for a dedicated host with this profileThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
Nested scheme for `interface_type`:
- `type` - (String) The type for this profile field.
- `value` - (String) The interface of the disk for a dedicated host with this profileThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
- `quantity` - (List) The number of disks of this type for a dedicated host with this profile. Nested `quantity` blocks have the following structure:

Nested scheme for `quantity`:
- `type` - (String) The type for this profile field.
- `value` - (String) The value for this profile field.
- `size` - (List) The size of the disk in GB (gigabytes). Nested `size` blocks have the following structure:

Nested scheme for `size`:
- `type` - (String) The type for this profile field.
- `value` - (String) The size of the disk in GB (gigabytes).
Nested scheme for `quantity`:
- `type` - (String) The type for this profile field.
- `value` - (String) The value for this profile field.
- `size` - (List) The size of the disk in GB (gigabytes). Nested `size` blocks have the following structure:
Nested scheme for `size`:
- `type` - (String) The type for this profile field.
- `value` - (String) The size of the disk in GB (gigabytes).
- `supported_instance_interface_types` - (List) Nested `supported_instance_interface_types` blocks have the following structure:

Nested scheme for `supported_instance_interface_types`:
- `type` - (String) The type for this profile field.
- `value` - (String) The instance disk interfaces supported for a dedicated host with this profile.
Nested scheme for `supported_instance_interface_types`:
- `type` - (String) The type for this profile field.
- `value` - (String) The instance disk interfaces supported for a dedicated host with this profile.
- `family` - (String) The product family this dedicated host profile belongs toThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
- `href` - (String) The URL for this dedicated host.
- `memory` - (List) Nested `memory` blocks have the following structure:
Expand Down
Loading