Merge pull request linode#176 from LBGarber/doc/instance-config-disk

doc: Add example for provisioning an instance with explicit configs and disks
jcallahan-akamai · Aug 19, 2022 · c86d0ed · c86d0ed
2 parents ad013e1 + b77e662
commit c86d0ed
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/docs/modules/instance.md b/docs/modules/instance.md
@@ -29,6 +29,33 @@ Manage Linode Instances, Configs, and Disks.
     state: present
 ```
 
+```yaml
+- name: Create a Linode Instance with explicit configs and disks.
+  linode.cloud.instance:
+    label: 'my-complex-instance'
+    region: us-southeast
+    type: g6-standard-1
+    booted: true
+    boot_config_label: boot-config
+    disks:
+      - label: boot
+        image: linode/ubuntu18.04
+        size: 3000
+        root_pass: ans1ble-test!
+      - label: swap
+        filesystem: swap
+        size: 512
+    configs:
+      - label: boot-config
+        root_device: /dev/sda
+        devices:
+          sda:
+            disk_label: boot
+          sdb:
+            disk_label: swap
+        state: present
+```
+
 ```yaml
 - name: Delete a Linode instance.
   linode.cloud.instance:

diff --git a/plugins/module_utils/doc_fragments/instance.py b/plugins/module_utils/doc_fragments/instance.py
@@ -18,6 +18,30 @@
     tags:
       - env=prod
     state: present''', '''
+- name: Create a Linode Instance with explicit configs and disks.
+  linode.cloud.instance:
+    label: 'my-complex-instance'
+    region: us-southeast
+    type: g6-standard-1
+    booted: true
+    boot_config_label: boot-config
+    disks:
+      - label: boot
+        image: linode/ubuntu18.04
+        size: 3000
+        root_pass: ans1ble-test!
+      - label: swap
+        filesystem: swap
+        size: 512
+    configs:
+      - label: boot-config
+        root_device: /dev/sda
+        devices:
+          sda:
+            disk_label: boot
+          sdb:
+            disk_label: swap
+        state: present''', '''
 - name: Delete a Linode instance.
   linode.cloud.instance:
     label: my-linode