Merge pull request #9682 from hashicorp/docs-7795-device-plugin-api

docs: added examples of device responses to api docs

Merge pull request #9682 from hashicorp/docs-7795-device-plugin-api
docs: added examples of device responses to api docs
d8e9012d · Chris Baker · GitHub · 19d5cd02 · 0f7b7e5c · d8e9012d
Unverified Commit d8e9012d authored 4 years ago by Chris Baker Committed by GitHub 4 years ago
Hide whitespace changes
Inline Side-by-side

Showing

with 104 additions and 1 deletion
+104 -1
--- a/website/pages/api-docs/client.mdx
+++ b/website/pages/api-docs/client.mdx
@@ -125,6 +125,58 @@ $ curl \
    }
  ],
  "CPUTicksConsumed": 1126.8044804480448,
+  "DeviceStats": [
+    {
+      "InstanceStats": {
+        "6a61929e-d572-092d-5921-156a913f8e56": {
+          "Stats": {
+            "Attributes": {
+              "Used Memory": {
+                "Desc": "Memory in use by the device",
+                "IntNumeratorVal": 128,
+                "Unit": "MiB"
+              }
+            },
+            "Nested": {}
+          },
+          "Summary": {
+            "Desc": "Memory in use by the device",
+            "IntNumeratorVal": 128,
+            "Unit": "MiB"
+          },
+          "Timestamp": "2020-12-18T17:15:08.949806Z"
+        }
+      },
+      "Name": "modelA",
+      "Type": "skeleton",
+      "Vendor": "hashicorp"
+    },
+    {
+      "InstanceStats": {
+        "73af5d3e-00f9-0786-9bc1-8f5ffa953f15": {
+          "Stats": {
+            "Attributes": {
+              "Used Memory": {
+                "Desc": "Memory in use by the device",
+                "IntNumeratorVal": 128,
+                "Unit": "MiB"
+              }
+            },
+            "Nested": {}
+          },
+          "Summary": {
+            "Desc": "Memory in use by the device",
+            "IntNumeratorVal": 128,
+            "Unit": "MiB"
+          },
+          "Timestamp": "2020-12-18T17:15:08.949806Z"
+        }
+      },
+      "Name": "modelB",
+      "Type": "skeleton",
+      "Vendor": "hashicorp"
+    }
+  ],
  "DiskStats": [
    {
      "Available": 142943150080,

--- a/website/pages/api-docs/nodes.mdx
+++ b/website/pages/api-docs/nodes.mdx
@@ -297,7 +297,58 @@ $ curl \
    "Cpu": {
      "CpuShares": 32000
    },
-    "Devices": null,
+    "Devices": [
+      {
+        "Attributes": {
+          "attrB": {
+            "Float": 10.5,
+            "Unit": "MW"
+          },
+          "attrA": {
+            "Int": 1024,
+            "Unit": "MB"
+          }
+        },
+        "Instances": [
+          {
+            "HealthDescription": "",
+            "Healthy": true,
+            "ID": "6a61929e-d572-092d-5921-156a913f8e56",
+            "Locality": {
+              "PciBusID": "77cda534-0660-2688-6c2e-ad6c62fc5ff3"
+            }
+          }
+        ],
+        "Name": "modelA",
+        "Type": "skeleton",
+        "Vendor": "hashicorp"
+      },
+      {
+        "Attributes": {
+          "attrB": {
+            "Float": 10.5,
+            "Unit": "MW"
+          },
+          "attrA": {
+            "Int": 1024,
+            "Unit": "MB"
+          }
+        },
+        "Instances": [
+          {
+            "HealthDescription": "",
+            "Healthy": true,
+            "ID": "73af5d3e-00f9-0786-9bc1-8f5ffa953f15",
+            "Locality": {
+              "PciBusID": "dbda64d1-ad25-6c7c-d3fb-798bae0581bf"
+            }
+          }
+        ],
+        "Name": "modelB",
+        "Type": "skeleton",
+        "Vendor": "hashicorp"
+      }
+    ],
    "Disk": {
      "DiskMB": 7890
    },