Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander-Kita committed Nov 6, 2024
1 parent df5a735 commit ff8f396
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 41 deletions.
56 changes: 28 additions & 28 deletions website/docs/r/pi_host.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,49 +45,49 @@ resource "ibm_pi_host" "host" {

The ibm_pi_host provides the following [timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:

* **create** - (Default 10 minutes) The creating of the host is considered failed if no response is received for 10 minutes.
* **delete** - (Default 10 minutes) The deletion of the host is considered failed if no response is received for 10 minutes.
- **create** - (Default 10 minutes) The creating of the host is considered failed if no response is received for 10 minutes.
- **delete** - (Default 10 minutes) The deletion of the host is considered failed if no response is received for 10 minutes.

## Argument Reference

You can specify the following arguments for this resource.

* `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
* `pi_host` - (Required, List) Host to add to a host group.
- `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
- `pi_host` - (Required, List) Host to add to a host group.

Nested schema for `pi_host`:
* `display_name` - (Required, String) Name of the host chosen by the user.
* `sys_type` - (Required, String) System type.
* `user_tags` - (Optional, List) The user tags attached to this resource.
* `pi_host_group_id` - (Required, String) ID of the host group to which the host should be added.
- `display_name` - (Required, String) Name of the host chosen by the user.
- `sys_type` - (Required, String) System type.
- `user_tags` - (Optional, List) The user tags attached to this resource.
- `pi_host_group_id` - (Required, String) ID of the host group to which the host should be added.


## Attribute Reference

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

* `capacity` - (List) Capacities of the host.
- `capacity` - (List) Capacities of the host.

Nested schema for `capacity`:
* `available_core` - (Float) Number of cores currently available.
* `available_memory` - (Float) Amount of memory currently available (in GB).
* `reserved_core` - (Float) Number of cores reserved for system use.
* `reserved_memory` - (Float) Amount of memory reserved for system use (in GB).
* `total_core` - (Float) Total number of cores of the host.
* `total_memory` - (Float) Total amount of memory of the host (in GB).
* `used_core` - (Float) Number of cores in use on the host.
* `used_memory` - (Float) Amount of memory used on the host (in GB).

* `crn` - (String) The CRN of this resource.
* `host_group` - (Map) Information about the owning host group.
- `available_core` - (Float) Number of cores currently available.
- `available_memory` - (Float) Amount of memory currently available (in GB).
- `reserved_core` - (Float) Number of cores reserved for system use.
- `reserved_memory` - (Float) Amount of memory reserved for system use (in GB).
- `total_core` - (Float) Total number of cores of the host.
- `total_memory` - (Float) Total amount of memory of the host (in GB).
- `used_core` - (Float) Number of cores in use on the host.
- `used_memory` - (Float) Amount of memory used on the host (in GB).

- `crn` - (String) The CRN of this resource.
- `host_group` - (Map) Information about the owning host group.

Nested schema for `host_group`:
* `access` - (String) Whether the host group is a primary or secondary host group.
* `href` - (String) Link to the host group resource.
* `name` - (String) Name of the host group.
- `access` - (String) Whether the host group is a primary or secondary host group.
- `href` - (String) Link to the host group resource.
- `name` - (String) Name of the host group.

* `host_id` - (String) ID of the host.
* `id` - The unique identifier of the host. The ID is composed of `<pi_cloud_instance_id>/<host_id>`.
* `state` - (String) State of the host `up` or `down`.
* `status` - (String) Status of the host `enabled` or `disabled`.
* `sys_type` - (String) System type.
- `host_id` - (String) ID of the host.
- `id` - The unique identifier of the host. The ID is composed of `<pi_cloud_instance_id>/<host_id>`.
- `state` - (String) State of the host `up` or `down`.
- `status` - (String) Status of the host `enabled` or `disabled`.
- `sys_type` - (String) System type.
26 changes: 13 additions & 13 deletions website/docs/r/pi_host_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,36 +49,36 @@ resource "ibm_pi_host_group" "hostGroup" {

The `ibm_pi_host_group` provides the following [timeouts](https://www.terraform.io/docs/language/resources/syntax.html) configuration options:

* **delete** - (Default 10 minutes) Used for deleting a host group.
- **delete** - (Default 10 minutes) Used for deleting a host group.

## Argument Reference

You can specify the following arguments for this resource.

* `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
- `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.

* `pi_hosts` - (Required, List) List of hosts to add to the group.
- `pi_hosts` - (Required, List) List of hosts to add to the group.

Nested schema for `pi_hosts`:
- `display_name` - (Required, String) Name of the host chosen by the user.
- `sys_type` - (Required, String) System type.
- `user_tags` - (Optional, List) The user tags attached to this resource.

* `pi_name` - (Required, String) Name of the host group to create.
* `pi_remove` - (Optional, String) A workspace ID to stop sharing the host group with.
* `pi_secondaries` - (Optional, List) List of workspaces to share the host group with.
- `pi_name` - (Required, String) Name of the host group to create.
- `pi_remove` - (Optional, String) A workspace ID to stop sharing the host group with.
- `pi_secondaries` - (Optional, List) List of workspaces to share the host group with.

Nested schema for `pi_secondaries`:
Nested schema for `pi_secondaries`:
- `name` - (Optional, String) Name of the host group to create in the secondary workspace.
- `workspace` - (Required, String) ID of the workspace to share the host group with.

## Attribute Reference

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

* `creation_date` - (String) Date/Time of host group creation.
* `host_group_id` - (String) The id of the created host group.
* `hosts` - (List) List of hosts.
* `id` - (String) The unique identifier of the host group. The ID is composed of `<pi_cloud_instance_id>/<host_group_id>`.
* `primary` - (String) The ID of the workspace owning the host group.
* `secondaries` - (List) IDs of workspaces the host group has been shared with.
- `creation_date` - (String) Date/Time of host group creation.
- `host_group_id` - (String) The id of the created host group.
- `hosts` - (List) List of hosts.
- `id` - (String) The unique identifier of the host group. The ID is composed of `<pi_cloud_instance_id>/<host_group_id>`.
- `primary` - (String) The ID of the workspace owning the host group.
- `secondaries` - (List) IDs of workspaces the host group has been shared with.

0 comments on commit ff8f396

Please sign in to comment.