From 97d029e3ec33ca7253143834b384ca33720c1555 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Graber?= Date: Thu, 22 Feb 2024 08:53:16 -0500 Subject: [PATCH] doc: Update configs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stéphane Graber Sponsored-by: ActivePort (https://www.activeport.com.au) --- doc/config_options.txt | 60 ++++++++++++++++++ internal/server/metadata/configuration.json | 70 +++++++++++++++++++++ 2 files changed, 130 insertions(+) diff --git a/doc/config_options.txt b/doc/config_options.txt index 720ddfd908a..5018f9e73b7 100644 --- a/doc/config_options.txt +++ b/doc/config_options.txt @@ -816,6 +816,36 @@ Comma-separated list of the last used IP addresses of the network device. The original MTU that was used when moving a physical device into an instance. ``` +```{config:option} volatile..last_state.pci.driver instance-volatile +:shortdesc: "PCI original host driver" +:type: "string" +The original host driver for the PCI device. +``` + +```{config:option} volatile..last_state.pci.parent instance-volatile +:shortdesc: "PCI parent host device" +:type: "string" +The parent host device used when allocating a PCI device to an instance. +``` + +```{config:option} volatile..last_state.pci.slot.name instance-volatile +:shortdesc: "PCI parent slot name" +:type: "string" +The parent host device PCI slot name. +``` + +```{config:option} volatile..last_state.usb.bus instance-volatile +:shortdesc: "USB bus address" +:type: "string" +The original USB bus address. +``` + +```{config:option} volatile..last_state.usb.device instance-volatile +:shortdesc: "USB device identifier" +:type: "string" +The original USB device identifier. +``` + ```{config:option} volatile..last_state.vdpa.name instance-volatile :shortdesc: "VDPA device name" :type: "string" @@ -834,6 +864,12 @@ The original MAC used when moving a VF into an instance. The ID used when moving a VF into an instance. ``` +```{config:option} volatile..last_state.vf.parent instance-volatile +:shortdesc: "SR-IOV parent host device" +:type: "string" +The parent host device used when allocating a VF into an instance. +``` + ```{config:option} volatile..last_state.vf.spoofcheck instance-volatile :shortdesc: "SR-IOV virtual function original spoof check setting" :type: "string" @@ -846,6 +882,24 @@ The original spoof check setting used when moving a VF into an instance. The original VLAN used when moving a VF into an instance. ``` +```{config:option} volatile..mig.uuid instance-volatile +:shortdesc: "MIG instance UUID" +:type: "string" +The NVIDIA MIG instance UUID. +``` + +```{config:option} volatile..name instance-volatile +:shortdesc: "Network interface name inside of the instance" +:type: "string" +The network interface name inside of the instance when no `name` property is set on the device itself. +``` + +```{config:option} volatile..vgpu.uuid instance-volatile +:shortdesc: "vGPU instance UUID" +:type: "string" +The NVIDIA vGPU instance UUID. +``` + ```{config:option} volatile.apply_nvram instance-volatile :shortdesc: "Whether to regenerate VM NVRAM the next time the instance starts" :type: "bool" @@ -906,6 +960,12 @@ The cluster member that the instance lived on before evacuation. ``` +```{config:option} volatile.last_state.ready instance-volatile +:shortdesc: "Instance marked itself as ready" +:type: "string" + +``` + ```{config:option} volatile.uuid instance-volatile :shortdesc: "Instance UUID" :type: "string" diff --git a/internal/server/metadata/configuration.json b/internal/server/metadata/configuration.json index 58e52c4779f..56fa5ffd32e 100644 --- a/internal/server/metadata/configuration.json +++ b/internal/server/metadata/configuration.json @@ -873,6 +873,41 @@ "type": "string" } }, + { + "volatile.\u003cname\u003e.last_state.pci.driver": { + "longdesc": "The original host driver for the PCI device.", + "shortdesc": "PCI original host driver", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.last_state.pci.parent": { + "longdesc": "The parent host device used when allocating a PCI device to an instance.", + "shortdesc": "PCI parent host device", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.last_state.pci.slot.name": { + "longdesc": "The parent host device PCI slot name.", + "shortdesc": "PCI parent slot name", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.last_state.usb.bus": { + "longdesc": "The original USB bus address.", + "shortdesc": "USB bus address", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.last_state.usb.device": { + "longdesc": "The original USB device identifier.", + "shortdesc": "USB device identifier", + "type": "string" + } + }, { "volatile.\u003cname\u003e.last_state.vdpa.name": { "longdesc": "The VDPA device name used when moving a VDPA device file descriptor into an instance.", @@ -894,6 +929,13 @@ "type": "string" } }, + { + "volatile.\u003cname\u003e.last_state.vf.parent": { + "longdesc": "The parent host device used when allocating a VF into an instance.", + "shortdesc": "SR-IOV parent host device", + "type": "string" + } + }, { "volatile.\u003cname\u003e.last_state.vf.spoofcheck": { "longdesc": "The original spoof check setting used when moving a VF into an instance.", @@ -908,6 +950,27 @@ "type": "string" } }, + { + "volatile.\u003cname\u003e.mig.uuid": { + "longdesc": "The NVIDIA MIG instance UUID.", + "shortdesc": "MIG instance UUID", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.name": { + "longdesc": "The network interface name inside of the instance when no `name` property is set on the device itself.", + "shortdesc": "Network interface name inside of the instance", + "type": "string" + } + }, + { + "volatile.\u003cname\u003e.vgpu.uuid": { + "longdesc": "The NVIDIA vGPU instance UUID.", + "shortdesc": "vGPU instance UUID", + "type": "string" + } + }, { "volatile.apply_nvram": { "longdesc": "", @@ -978,6 +1041,13 @@ "type": "string" } }, + { + "volatile.last_state.ready": { + "longdesc": "", + "shortdesc": "Instance marked itself as ready", + "type": "string" + } + }, { "volatile.uuid": { "longdesc": "The instance UUID is globally unique across all servers and projects.",