Skip to content

Commit

Permalink
API Reference update by KubeVirt Prow build 1707752972789747712
Browse files Browse the repository at this point in the history
  • Loading branch information
@kubevirt-bot
kubevirt-bot committed Sep 29, 2023
1 parent 8fe13d0 commit 9c93d04
Show file tree
Hide file tree
Showing 2 changed files with 151 additions and 3 deletions.
148 changes: 148 additions & 0 deletions main/definitions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -594,13 +594,15 @@
<li><a href="#_v1_liveupdatecpu">v1.LiveUpdateCPU</a></li>
<li><a href="#_v1_liveupdateconfiguration">v1.LiveUpdateConfiguration</a></li>
<li><a href="#_v1_liveupdatefeatures">v1.LiveUpdateFeatures</a></li>
<li><a href="#_v1_liveupdatememory">v1.LiveUpdateMemory</a></li>
<li><a href="#_v1_logverbosity">v1.LogVerbosity</a></li>
<li><a href="#_v1_luntarget">v1.LunTarget</a></li>
<li><a href="#_v1_machine">v1.Machine</a></li>
<li><a href="#_v1_mediateddevicesconfiguration">v1.MediatedDevicesConfiguration</a></li>
<li><a href="#_v1_mediatedhostdevice">v1.MediatedHostDevice</a></li>
<li><a href="#_v1_memory">v1.Memory</a></li>
<li><a href="#_v1_memorydumpvolumesource">v1.MemoryDumpVolumeSource</a></li>
<li><a href="#_v1_memorystatus">v1.MemoryStatus</a></li>
<li><a href="#_v1_migrateoptions">v1.MigrateOptions</a></li>
<li><a href="#_v1_migrationconfiguration">v1.MigrationConfiguration</a></li>
<li><a href="#_v1_multusnetwork">v1.MultusNetwork</a></li>
Expand Down Expand Up @@ -10148,6 +10150,30 @@ <h3 id="_v1_liveupdateconfiguration">v1.LiveUpdateConfiguration</h3>
<p>integer (int64)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>maxGuest</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>MaxGuest defines the maximum amount memory that can be allocated to the guest using hotplug.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>maxHotplugRatio</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>MaxHotplugRatio is the ratio used to define the max amount of a hotplug resource that can be made available to a VM when the specific Max* setting is not defined (MaxCpuSockets, MaxGuest) Example: VM is configured with 512Mi of guest memory, if MaxGuest is not defined and MaxHotplugRatio is 2 then MaxGuest = 1Gi defaults to 4</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>integer (int64)</p>
</div></div></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -10191,6 +10217,49 @@ <h3 id="_v1_liveupdatefeatures">v1.LiveUpdateFeatures</h3>
<p><a href="#_v1_liveupdatecpu">v1.LiveUpdateCPU</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>memory</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>MemoryLiveUpdateConfiguration defines the live update memory features for the VirtualMachine</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_v1_liveupdatememory">v1.LiveUpdateMemory</a></p>
</div></div></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_v1_liveupdatememory">v1.LiveUpdateMemory</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 16.6666%;">
<col style="width: 61.1111%;">
<col style="width: 22.2223%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">Name</th>
<th class="tableblock halign-left valign-middle">Description</th>
<th class="tableblock halign-left valign-middle">Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>maxGuest</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>MaxGuest defines the maximum amount memory that can be allocated for the VM.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -10518,6 +10587,18 @@ <h3 id="_v1_memory">v1.Memory</h3>
<p><a href="#_v1_hugepages">v1.Hugepages</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>maxGuest</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>MaxGuest allows to specify the maximum amount of memory which is visible inside the Guest OS. The delta between MaxGuest and Guest is the amount of memory that can be hot(un)plugged.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -10578,6 +10659,61 @@ <h3 id="_v1_memorydumpvolumesource">v1.MemoryDumpVolumeSource</h3>
</table>
</div>
<div class="sect2">
<h3 id="_v1_memorystatus">v1.MemoryStatus</h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 16.6666%;">
<col style="width: 61.1111%;">
<col style="width: 22.2223%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">Name</th>
<th class="tableblock halign-left valign-middle">Description</th>
<th class="tableblock halign-left valign-middle">Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>guestAtBoot</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>GuestAtBoot specifies with how much memory the VirtualMachine intiallly booted with.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>guestCurrent</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>GuestCurrent specifies how much memory is currently available for the VirtualMachine.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>guestRequested</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>GuestRequested specifies how much memory was requested (hotplug) for the VirtualMachine.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_k8s_io_apimachinery_pkg_api_resource_quantity">k8s.io.apimachinery.pkg.api.resource.Quantity</a></p>
</div></div></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_v1_migrateoptions">v1.MigrateOptions</h3>
<div class="paragraph">
<p>MigrateOptions may be provided on migrate request.</p>
Expand Down Expand Up @@ -16341,6 +16477,18 @@ <h3 id="_v1_virtualmachineinstancestatus">v1.VirtualMachineInstanceStatus</h3>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>memory</strong><br>
<em>optional</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Memory shows various informations about the VirtualMachine memory.</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><a href="#_v1_memorystatus">v1.MemoryStatus</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p><strong>migrationMethod</strong><br>
<em>optional</em></p>
</div></div></td>
Expand Down
6 changes: 3 additions & 3 deletions main/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@
<div id="header">
<h1>KubeVirt API</h1>
<div class="details">
<span id="revnumber">version ec0a3edf17ab0370659b673878c8400e675c2896</span>
<span id="revnumber">version 02c74e74e773bf21aaaca38a21e960f0926cca16</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
Expand Down Expand Up @@ -472,7 +472,7 @@ <h3 id="_license_information">License information</h3>
<p><em>License</em> : Apache 2.0<br>
<em>License URL</em> : <a href="https://www.apache.org/licenses/LICENSE-2.0" class="bare">https://www.apache.org/licenses/LICENSE-2.0</a><br>
<em>Terms of service</em> : null<br>
<em>Version</em> : <a href="https://github.com/kubevirt/kubevirt/commit/ec0a3edf17ab0370659b673878c8400e675c2896">ec0a3edf17ab0370659b673878c8400e675c2896</a></p>
<em>Version</em> : <a href="https://github.com/kubevirt/kubevirt/commit/02c74e74e773bf21aaaca38a21e960f0926cca16">02c74e74e773bf21aaaca38a21e960f0926cca16</a></p>
</div>
</div>
</div>
Expand All @@ -495,7 +495,7 @@ <h2 id="_kubevirt_api_reference">KubeVirt API Reference</h2>
</div>
<div id="footer">
<div id="footer-text">
Version ec0a3edf17ab0370659b673878c8400e675c2896<br>
Version 02c74e74e773bf21aaaca38a21e960f0926cca16<br>
</div>
</div>
</body>
Expand Down

0 comments on commit 9c93d04

Please sign in to comment.