Merge pull request #687 from threefoldtech/gpu-doc

docs/resources/deployment.md

@@ -10,9 +10,8 @@ description: |-
 
 Resource for deploying multiple workloads like vms (ZMachines), ZDBs, disks, Qsfss, and/or zlogs. A user should specify node id for this deployment, the (already) deployed network that this deployment should be a part of, and the desired workloads configurations.
 
-
-
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required
@@ -25,7 +24,7 @@ Resource for deploying multiple workloads like vms (ZMachines), ZDBs, disks, Qsf
 - `name` (String) Solution name for created contract to be consistent across threefold tooling.
 - `network_name` (String) Network name of the deployed network resource to connect vms.
 - `qsfs` (Block List) List of Qsfs workloads configurations. Qsfs is a quantum storage file system.
-You can read more about it [here](https://github.com/threefoldtech/quantum-storage). (see [below for nested schema](#nestedblock--qsfs))
+  You can read more about it [here](https://github.com/threefoldtech/quantum-storage). (see [below for nested schema](#nestedblock--qsfs))
 - `solution_provider` (Number) Solution provider ID for the deployed solution which allows the creator of the solution to gain a percentage of the rewards.
 - `solution_type` (String) Solution type for created contract to be consistent across threefold tooling.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
@@ -38,6 +37,7 @@ You can read more about it [here](https://github.com/threefoldtech/quantum-stora
 - `ip_range` (String) IP range of the node for the wireguard network (e.g. 10.1.2.0/24). Has to have a subnet mask of 24.
 
 <a id="nestedblock--disks"></a>
+
 ### Nested Schema for `disks`
 
 Required:
@@ -49,8 +49,8 @@ Optional:
 
 - `description` (String) Description of disk workload.
 
-
 <a id="nestedblock--qsfs"></a>
+
 ### Nested Schema for `qsfs`
 
 Required:
@@ -77,13 +77,15 @@ Read-Only:
 - `metrics_endpoint` (String) QSFS exposed metrics endpoint.
 
 <a id="nestedblock--qsfs--groups"></a>
+
 ### Nested Schema for `qsfs.groups`
 
 Optional:
 
 - `backends` (Block List) List of ZDB backends configurations. (see [below for nested schema](#nestedblock--qsfs--groups--backends))
 
 <a id="nestedblock--qsfs--groups--backends"></a>
+
 ### Nested Schema for `qsfs.groups.backends`
 
 Required:
@@ -92,9 +94,8 @@ Required:
 - `namespace` (String) ZDB namespace.
 - `password` (String) Namespace password.
 
-
-
 <a id="nestedblock--qsfs--metadata"></a>
+
 ### Nested Schema for `qsfs.metadata`
 
 Required:
@@ -109,6 +110,7 @@ Optional:
 - `type` (String) configuration for the metadata store to use, currently only ZDB is supported.
 
 <a id="nestedblock--qsfs--metadata--backends"></a>
+
 ### Nested Schema for `qsfs.metadata.backends`
 
 Required:
@@ -117,18 +119,16 @@ Required:
 - `namespace` (String) ZDB namespace.
 - `password` (String) Namespace password.
 
-
-
-
 <a id="nestedblock--timeouts"></a>
+
 ### Nested Schema for `timeouts`
 
 Optional:
 
 - `create` (String)
 
-
 <a id="nestedblock--vms"></a>
+
 ### Nested Schema for `vms`
 
 Required:
@@ -151,7 +151,8 @@ Optional:
 - `publicip` (Boolean) Flag to enable public ipv4 reservation.
 - `publicip6` (Boolean) Flag to enable public ipv6 reservation.
 - `rootfs_size` (Number) Root file system size in MB.
-- `zlogs` (List of String) List of Zlogs workloads configurations (URLs). Zlogs is a utility workload that allows you to stream `ZMachine` logs to a remote location.
+- `zlogs` (List of Strings) List of Zlogs workloads configurations (URLs). Zlogs is a utility workload that allows you to stream `ZMachine` logs to a remote location.
+- `gpus` (List of Strings) List of gpus ids to be attached to the machine for example `0000:0e:00.0/1002/744c`, thoses ids can be retrieved from [dashboard](dashboard.grid.tf)
 
 Read-Only:
 
@@ -160,16 +161,16 @@ Read-Only:
 - `ygg_ip` (String) The allocated Yggdrasil IP.
 
 <a id="nestedblock--vms--mounts"></a>
+
 ### Nested Schema for `vms.mounts`
 
 Required:
 
 - `disk_name` (String) Name of QSFS or Disk to mount.
 - `mount_point` (String) Directory to mount the disk on inside the ZMachine.
 
-
-
 <a id="nestedblock--zdbs"></a>
+
 ### Nested Schema for `zdbs`
 
 Required:
@@ -189,5 +190,3 @@ Read-Only:
 - `ips` (List of String) Computed IPs of the ZDB. Two IPs are returned: a public IPv6, and a YggIP, in this order
 - `namespace` (String) Namespace of the ZDB.
 - `port` (Number) Port of the ZDB.
-
-