Skip to content

Commit 4d5bcd0

Browse files
kubevirt-botkubevirt-bot
committed
API Reference update by KubeVirt Prow build 1982836101810753536
1 parent bff14b0 commit 4d5bcd0

File tree

2 files changed

+185
-6
lines changed

2 files changed

+185
-6
lines changed

‎main/definitions.html‎

Lines changed: 182 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -750,15 +750,20 @@
750750
<li><a href="#_v1alpha1_migrationpolicyspec">v1alpha1.MigrationPolicySpec</a></li>
751751
<li><a href="#_v1alpha1_migrationpolicystatus">v1alpha1.MigrationPolicyStatus</a></li>
752752
<li><a href="#_v1alpha1_selectors">v1alpha1.Selectors</a></li>
753+
<li><a href="#_v1alpha1_virtualmachineopportunisticupdatestrategy">v1alpha1.VirtualMachineOpportunisticUpdateStrategy</a></li>
753754
<li><a href="#_v1alpha1_virtualmachinepool">v1alpha1.VirtualMachinePool</a></li>
754755
<li><a href="#_v1alpha1_virtualmachinepoolcondition">v1alpha1.VirtualMachinePoolCondition</a></li>
755756
<li><a href="#_v1alpha1_virtualmachinepoollist">v1alpha1.VirtualMachinePoolList</a></li>
756757
<li><a href="#_v1alpha1_virtualmachinepoolnamegeneration">v1alpha1.VirtualMachinePoolNameGeneration</a></li>
757758
<li><a href="#_v1alpha1_virtualmachinepoolproactivescaleinstrategy">v1alpha1.VirtualMachinePoolProactiveScaleInStrategy</a></li>
759+
<li><a href="#_v1alpha1_virtualmachinepoolproactiveupdatestrategy">v1alpha1.VirtualMachinePoolProactiveUpdateStrategy</a></li>
758760
<li><a href="#_v1alpha1_virtualmachinepoolscaleinstrategy">v1alpha1.VirtualMachinePoolScaleInStrategy</a></li>
759761
<li><a href="#_v1alpha1_virtualmachinepoolselectionpolicy">v1alpha1.VirtualMachinePoolSelectionPolicy</a></li>
762+
<li><a href="#_v1alpha1_virtualmachinepoolselectors">v1alpha1.VirtualMachinePoolSelectors</a></li>
760763
<li><a href="#_v1alpha1_virtualmachinepoolspec">v1alpha1.VirtualMachinePoolSpec</a></li>
761764
<li><a href="#_v1alpha1_virtualmachinepoolstatus">v1alpha1.VirtualMachinePoolStatus</a></li>
765+
<li><a href="#_v1alpha1_virtualmachinepoolunmanagedstrategy">v1alpha1.VirtualMachinePoolUnmanagedStrategy</a></li>
766+
<li><a href="#_v1alpha1_virtualmachinepoolupdatestrategy">v1alpha1.VirtualMachinePoolUpdateStrategy</a></li>
762767
<li><a href="#_v1alpha1_virtualmachinetemplatespec">v1alpha1.VirtualMachineTemplateSpec</a></li>
763768
<li><a href="#_v1beta1_cpuinstancetype">v1beta1.CPUInstancetype</a></li>
764769
<li><a href="#_v1beta1_cpupreferencerequirement">v1beta1.CPUPreferenceRequirement</a></li>
@@ -20573,6 +20578,12 @@ <h3 id="_v1alpha1_selectors">v1alpha1.Selectors</h3>
2057320578
</table>
2057420579
</div>
2057520580
<div class="sect2">
20581+
<h3 id="_v1alpha1_virtualmachineopportunisticupdatestrategy">v1alpha1.VirtualMachineOpportunisticUpdateStrategy</h3>
20582+
<div class="paragraph">
20583+
<p><em>Type</em> : object</p>
20584+
</div>
20585+
</div>
20586+
<div class="sect2">
2057620587
<h3 id="_v1alpha1_virtualmachinepool">v1alpha1.VirtualMachinePool</h3>
2057720588
<div class="paragraph">
2057820589
<p>VirtualMachinePool resource contains a VirtualMachine configuration that can be used to replicate multiple VirtualMachine resources.</p>
@@ -20847,6 +20858,40 @@ <h3 id="_v1alpha1_virtualmachinepoolproactivescaleinstrategy">v1alpha1.VirtualMa
2084720858
</table>
2084820859
</div>
2084920860
<div class="sect2">
20861+
<h3 id="_v1alpha1_virtualmachinepoolproactiveupdatestrategy">v1alpha1.VirtualMachinePoolProactiveUpdateStrategy</h3>
20862+
<div class="paragraph">
20863+
<p>VirtualMachinePoolProactiveUpdateStrategy represents proactive update strategy</p>
20864+
</div>
20865+
<table class="tableblock frame-all grid-all stretch">
20866+
<colgroup>
20867+
<col style="width: 16.6666%;">
20868+
<col style="width: 61.1111%;">
20869+
<col style="width: 22.2223%;">
20870+
</colgroup>
20871+
<thead>
20872+
<tr>
20873+
<th class="tableblock halign-left valign-middle">Name</th>
20874+
<th class="tableblock halign-left valign-middle">Description</th>
20875+
<th class="tableblock halign-left valign-middle">Schema</th>
20876+
</tr>
20877+
</thead>
20878+
<tbody>
20879+
<tr>
20880+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20881+
<p><strong>selectionPolicy</strong><br>
20882+
<em>optional</em></p>
20883+
</div></div></td>
20884+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20885+
<p>SelectionPolicy defines the priority in which VM instances are selected for proactive update Defaults to "Random" base policy when no SelectionPolicy is configured</p>
20886+
</div></div></td>
20887+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20888+
<p><a href="#_v1alpha1_virtualmachinepoolselectionpolicy">v1alpha1.VirtualMachinePoolSelectionPolicy</a></p>
20889+
</div></div></td>
20890+
</tr>
20891+
</tbody>
20892+
</table>
20893+
</div>
20894+
<div class="sect2">
2085020895
<h3 id="_v1alpha1_virtualmachinepoolscaleinstrategy">v1alpha1.VirtualMachinePoolScaleInStrategy</h3>
2085120896
<div class="paragraph">
2085220897
<p>VirtualMachinePoolScaleInStrategy specifies how the VMPool controller manages scaling in VMs within a VMPool</p>
@@ -20883,7 +20928,7 @@ <h3 id="_v1alpha1_virtualmachinepoolscaleinstrategy">v1alpha1.VirtualMachinePool
2088320928
<div class="sect2">
2088420929
<h3 id="_v1alpha1_virtualmachinepoolselectionpolicy">v1alpha1.VirtualMachinePoolSelectionPolicy</h3>
2088520930
<div class="paragraph">
20886-
<p>VirtualMachinePoolSelectionPolicy defines the priority in which VM instances are selected for scale-in</p>
20931+
<p>VirtualMachinePoolSelectionPolicy defines the priority in which VM instances are selected for proactive scale-in or update</p>
2088720932
</div>
2088820933
<table class="tableblock frame-all grid-all stretch">
2088920934
<colgroup>
@@ -20901,11 +20946,23 @@ <h3 id="_v1alpha1_virtualmachinepoolselectionpolicy">v1alpha1.VirtualMachinePool
2090120946
<tbody>
2090220947
<tr>
2090320948
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20904-
<p><strong>basePolicy</strong><br>
20949+
<p><strong>selectors</strong><br>
2090520950
<em>optional</em></p>
2090620951
</div></div></td>
2090720952
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20908-
<p>BasePolicy is a catch-all policy [Random|DescendingOrder]</p>
20953+
<p>Selectors is a list of selection policies.</p>
20954+
</div></div></td>
20955+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20956+
<p><a href="#_v1alpha1_virtualmachinepoolselectors">v1alpha1.VirtualMachinePoolSelectors</a></p>
20957+
</div></div></td>
20958+
</tr>
20959+
<tr>
20960+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20961+
<p><strong>sortPolicy</strong><br>
20962+
<em>optional</em></p>
20963+
</div></div></td>
20964+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20965+
<p>SortPolicy is a catch-all policy [AscendingOrder|DescendingOrder|Newest|Oldest|Random]</p>
2090920966
</div></div></td>
2091020967
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2091120968
<p>string</p>
@@ -20915,6 +20972,52 @@ <h3 id="_v1alpha1_virtualmachinepoolselectionpolicy">v1alpha1.VirtualMachinePool
2091520972
</table>
2091620973
</div>
2091720974
<div class="sect2">
20975+
<h3 id="_v1alpha1_virtualmachinepoolselectors">v1alpha1.VirtualMachinePoolSelectors</h3>
20976+
<div class="paragraph">
20977+
<p>VirtualMachinePoolSelectors specifies filtering criteria for VM selection. If both are specified, both must match for a VM to be selected. If only one is specified, only that one must match for a VM to be selected.</p>
20978+
</div>
20979+
<table class="tableblock frame-all grid-all stretch">
20980+
<colgroup>
20981+
<col style="width: 16.6666%;">
20982+
<col style="width: 61.1111%;">
20983+
<col style="width: 22.2223%;">
20984+
</colgroup>
20985+
<thead>
20986+
<tr>
20987+
<th class="tableblock halign-left valign-middle">Name</th>
20988+
<th class="tableblock halign-left valign-middle">Description</th>
20989+
<th class="tableblock halign-left valign-middle">Schema</th>
20990+
</tr>
20991+
</thead>
20992+
<tbody>
20993+
<tr>
20994+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20995+
<p><strong>labelSelector</strong><br>
20996+
<em>optional</em></p>
20997+
</div></div></td>
20998+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
20999+
<p>LabelSelector is a list of label selector for VMs.</p>
21000+
</div></div></td>
21001+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21002+
<p><a href="#_k8s_io_apimachinery_pkg_apis_meta_v1_labelselector">k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector</a></p>
21003+
</div></div></td>
21004+
</tr>
21005+
<tr>
21006+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21007+
<p><strong>nodeSelectorRequirementMatcher</strong><br>
21008+
<em>optional</em></p>
21009+
</div></div></td>
21010+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21011+
<p>NodeSelectorRequirementMatcher is a list of node selector requirement for VMs.</p>
21012+
</div></div></td>
21013+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21014+
<p>&lt; <a href="#_k8s_io_api_core_v1_nodeselectorrequirement">k8s.io.api.core.v1.NodeSelectorRequirement</a> &gt; array</p>
21015+
</div></div></td>
21016+
</tr>
21017+
</tbody>
21018+
</table>
21019+
</div>
21020+
<div class="sect2">
2091821021
<h3 id="_v1alpha1_virtualmachinepoolspec">v1alpha1.VirtualMachinePoolSpec</h3>
2091921022
<table class="tableblock frame-all grid-all stretch">
2092021023
<colgroup>
@@ -21004,6 +21107,18 @@ <h3 id="_v1alpha1_virtualmachinepoolspec">v1alpha1.VirtualMachinePoolSpec</h3>
2100421107
</tr>
2100521108
<tr>
2100621109
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21110+
<p><strong>updateStrategy</strong><br>
21111+
<em>optional</em></p>
21112+
</div></div></td>
21113+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21114+
<p>UpdateStrategy specifies how the VMPool controller manages updating VMs within a VMPool</p>
21115+
</div></div></td>
21116+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21117+
<p><a href="#_v1alpha1_virtualmachinepoolupdatestrategy">v1alpha1.VirtualMachinePoolUpdateStrategy</a></p>
21118+
</div></div></td>
21119+
</tr>
21120+
<tr>
21121+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2100721122
<p><strong>virtualMachineTemplate</strong><br>
2100821123
<em>required</em></p>
2100921124
</div></div></td>
@@ -21079,6 +21194,70 @@ <h3 id="_v1alpha1_virtualmachinepoolstatus">v1alpha1.VirtualMachinePoolStatus</h
2107921194
</table>
2108021195
</div>
2108121196
<div class="sect2">
21197+
<h3 id="_v1alpha1_virtualmachinepoolunmanagedstrategy">v1alpha1.VirtualMachinePoolUnmanagedStrategy</h3>
21198+
<div class="paragraph">
21199+
<p><em>Type</em> : object</p>
21200+
</div>
21201+
</div>
21202+
<div class="sect2">
21203+
<h3 id="_v1alpha1_virtualmachinepoolupdatestrategy">v1alpha1.VirtualMachinePoolUpdateStrategy</h3>
21204+
<div class="paragraph">
21205+
<p>VirtualMachinePoolUpdateStrategy specifies how the VMPool controller manages updating VMs within a VMPool, by default it is proactive update.</p>
21206+
</div>
21207+
<table class="tableblock frame-all grid-all stretch">
21208+
<colgroup>
21209+
<col style="width: 16.6666%;">
21210+
<col style="width: 61.1111%;">
21211+
<col style="width: 22.2223%;">
21212+
</colgroup>
21213+
<thead>
21214+
<tr>
21215+
<th class="tableblock halign-left valign-middle">Name</th>
21216+
<th class="tableblock halign-left valign-middle">Description</th>
21217+
<th class="tableblock halign-left valign-middle">Schema</th>
21218+
</tr>
21219+
</thead>
21220+
<tbody>
21221+
<tr>
21222+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21223+
<p><strong>opportunistic</strong><br>
21224+
<em>optional</em></p>
21225+
</div></div></td>
21226+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21227+
<p>Opportunistic update only gets applied to the VM, VMI is updated naturally upon the restart. Whereas proactive it applies both the VM and VMI right away.</p>
21228+
</div></div></td>
21229+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21230+
<p><a href="#_v1alpha1_virtualmachineopportunisticupdatestrategy">v1alpha1.VirtualMachineOpportunisticUpdateStrategy</a></p>
21231+
</div></div></td>
21232+
</tr>
21233+
<tr>
21234+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21235+
<p><strong>proactive</strong><br>
21236+
<em>optional</em></p>
21237+
</div></div></td>
21238+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21239+
<p>Proactive update by forcing the VMs to restart during update</p>
21240+
</div></div></td>
21241+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21242+
<p><a href="#_v1alpha1_virtualmachinepoolproactiveupdatestrategy">v1alpha1.VirtualMachinePoolProactiveUpdateStrategy</a></p>
21243+
</div></div></td>
21244+
</tr>
21245+
<tr>
21246+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21247+
<p><strong>unmanaged</strong><br>
21248+
<em>optional</em></p>
21249+
</div></div></td>
21250+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21251+
<p>Unmanaged indicates that no automatic update of VMs within a VMPool is performed. When this is set, the VMPool controller will not update the VMs within the pool.</p>
21252+
</div></div></td>
21253+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21254+
<p><a href="#_v1alpha1_virtualmachinepoolunmanagedstrategy">v1alpha1.VirtualMachinePoolUnmanagedStrategy</a></p>
21255+
</div></div></td>
21256+
</tr>
21257+
</tbody>
21258+
</table>
21259+
</div>
21260+
<div class="sect2">
2108221261
<h3 id="_v1alpha1_virtualmachinetemplatespec">v1alpha1.VirtualMachineTemplateSpec</h3>
2108321262
<table class="tableblock frame-all grid-all stretch">
2108421263
<colgroup>

‎main/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@
438438
<div id="header">
439439
<h1>KubeVirt API</h1>
440440
<div class="details">
441-
<span id="revnumber">version e34f483964ea8229491cf478893a07f6c5955fd7</span>
441+
<span id="revnumber">version bf4149cb87a7ba0b649b8e37fe396567f0dc83fe</span>
442442
</div>
443443
<div id="toc" class="toc2">
444444
<div id="toctitle">Table of Contents</div>
@@ -473,7 +473,7 @@ <h3 id="_license_information">License information</h3>
473473
<p><em>License</em> : Apache 2.0<br>
474474
<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>
475475
<em>Terms of service</em> : null<br>
476-
<em>Version</em> : <a href="https://github.com/kubevirt/kubevirt/commit/e34f483964ea8229491cf478893a07f6c5955fd7">e34f483964ea8229491cf478893a07f6c5955fd7</a></p>
476+
<em>Version</em> : <a href="https://github.com/kubevirt/kubevirt/commit/bf4149cb87a7ba0b649b8e37fe396567f0dc83fe">bf4149cb87a7ba0b649b8e37fe396567f0dc83fe</a></p>
477477
</div>
478478
</div>
479479
</div>
@@ -496,7 +496,7 @@ <h2 id="_kubevirt_api_reference">KubeVirt API Reference</h2>
496496
</div>
497497
<div id="footer">
498498
<div id="footer-text">
499-
Version e34f483964ea8229491cf478893a07f6c5955fd7<br>
499+
Version bf4149cb87a7ba0b649b8e37fe396567f0dc83fe<br>
500500
</div>
501501
</div>
502502
</body>

0 commit comments

Comments
 (0)