Skip to content

Commit 5c06054

Browse files
kubevirt-botkubevirt-bot
committed
API Reference update by KubeVirt Prow build 2029836056332865536
1 parent 0b0b679 commit 5c06054

2 files changed

Lines changed: 218 additions & 6 deletions

File tree

‎main/definitions.html‎

Lines changed: 215 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,8 @@
815815
<li><a href="#_v1beta1_virtualmachineclusterpreference">v1beta1.VirtualMachineClusterPreference</a></li>
816816
<li><a href="#_v1beta1_virtualmachineclusterpreferencelist">v1beta1.VirtualMachineClusterPreferenceList</a></li>
817817
<li><a href="#_v1beta1_virtualmachineexport">v1beta1.VirtualMachineExport</a></li>
818+
<li><a href="#_v1beta1_virtualmachineexportbackup">v1beta1.VirtualMachineExportBackup</a></li>
819+
<li><a href="#_v1beta1_virtualmachineexportbackupendpoint">v1beta1.VirtualMachineExportBackupEndpoint</a></li>
818820
<li><a href="#_v1beta1_virtualmachineexportlink">v1beta1.VirtualMachineExportLink</a></li>
819821
<li><a href="#_v1beta1_virtualmachineexportlinks">v1beta1.VirtualMachineExportLinks</a></li>
820822
<li><a href="#_v1beta1_virtualmachineexportlist">v1beta1.VirtualMachineExportList</a></li>
@@ -21106,6 +21108,24 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2110621108
<tbody>
2110721109
<tr>
2110821110
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21111+
<p><strong>backupCert</strong><br>
21112+
<em>optional</em></p>
21113+
</div></div></td>
21114+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21115+
<p>string</p>
21116+
</div></div></td>
21117+
</tr>
21118+
<tr>
21119+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21120+
<p><strong>backupKey</strong><br>
21121+
<em>optional</em></p>
21122+
</div></div></td>
21123+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21124+
<p>string</p>
21125+
</div></div></td>
21126+
</tr>
21127+
<tr>
21128+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2110921129
<p><strong>backupName</strong><br>
2111021130
<em>optional</em></p>
2111121131
</div></div></td>
@@ -21124,6 +21144,15 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2112421144
</tr>
2112521145
<tr>
2112621146
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21147+
<p><strong>caCert</strong><br>
21148+
<em>optional</em></p>
21149+
</div></div></td>
21150+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21151+
<p>string</p>
21152+
</div></div></td>
21153+
</tr>
21154+
<tr>
21155+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2112721156
<p><strong>cmd</strong><br>
2112821157
<em>optional</em></p>
2112921158
</div></div></td>
@@ -21133,7 +21162,7 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2113321162
</tr>
2113421163
<tr>
2113521164
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21136-
<p><strong>incremental</strong><br>
21165+
<p><strong>exportServerAddr</strong><br>
2113721166
<em>optional</em></p>
2113821167
</div></div></td>
2113921168
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
@@ -21142,7 +21171,16 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2114221171
</tr>
2114321172
<tr>
2114421173
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21145-
<p><strong>mode</strong><br>
21174+
<p><strong>exportServerName</strong><br>
21175+
<em>optional</em></p>
21176+
</div></div></td>
21177+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21178+
<p>string</p>
21179+
</div></div></td>
21180+
</tr>
21181+
<tr>
21182+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21183+
<p><strong>incremental</strong><br>
2114621184
<em>optional</em></p>
2114721185
</div></div></td>
2114821186
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
@@ -21151,7 +21189,7 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2115121189
</tr>
2115221190
<tr>
2115321191
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21154-
<p><strong>pushPath</strong><br>
21192+
<p><strong>mode</strong><br>
2115521193
<em>optional</em></p>
2115621194
</div></div></td>
2115721195
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
@@ -21167,6 +21205,15 @@ <h3 id="_v1alpha1_backupoptions">v1alpha1.BackupOptions</h3>
2116721205
<p>boolean</p>
2116821206
</div></div></td>
2116921207
</tr>
21208+
<tr>
21209+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21210+
<p><strong>targetPath</strong><br>
21211+
<em>optional</em></p>
21212+
</div></div></td>
21213+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21214+
<p>string</p>
21215+
</div></div></td>
21216+
</tr>
2117021217
</tbody>
2117121218
</table>
2117221219
</div>
@@ -21191,6 +21238,18 @@ <h3 id="_v1alpha1_backupvolumeinfo">v1alpha1.BackupVolumeInfo</h3>
2119121238
<tbody>
2119221239
<tr>
2119321240
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21241+
<p><strong>dataEndpoint</strong><br>
21242+
<em>optional</em></p>
21243+
</div></div></td>
21244+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21245+
<p>DataEndpoint is the URL of the endpoint for read for pull mode</p>
21246+
</div></div></td>
21247+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21248+
<p>string</p>
21249+
</div></div></td>
21250+
</tr>
21251+
<tr>
21252+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2119421253
<p><strong>diskTarget</strong><br>
2119521254
<em>required</em></p>
2119621255
</div></div></td>
@@ -21204,6 +21263,18 @@ <h3 id="_v1alpha1_backupvolumeinfo">v1alpha1.BackupVolumeInfo</h3>
2120421263
</tr>
2120521264
<tr>
2120621265
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21266+
<p><strong>mapEndpoint</strong><br>
21267+
<em>optional</em></p>
21268+
</div></div></td>
21269+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21270+
<p>MapEndpoint is the URL of the endpoint for map for pull mode</p>
21271+
</div></div></td>
21272+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21273+
<p>string</p>
21274+
</div></div></td>
21275+
</tr>
21276+
<tr>
21277+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2120721278
<p><strong>volumeName</strong><br>
2120821279
<em>required</em></p>
2120921280
</div></div></td>
@@ -21759,6 +21830,30 @@ <h3 id="_v1alpha1_virtualmachinebackupspec">v1alpha1.VirtualMachineBackupSpec</h
2175921830
<p><a href="#_k8s_io_api_core_v1_typedlocalobjectreference">k8s.io.api.core.v1.TypedLocalObjectReference</a></p>
2176021831
</div></div></td>
2176121832
</tr>
21833+
<tr>
21834+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21835+
<p><strong>tokenSecretRef</strong><br>
21836+
<em>optional</em></p>
21837+
</div></div></td>
21838+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21839+
<p>TokenSecretRef is the name of the secret that will be used to pull the backup from an associated endpoint</p>
21840+
</div></div></td>
21841+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21842+
<p>string</p>
21843+
</div></div></td>
21844+
</tr>
21845+
<tr>
21846+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21847+
<p><strong>ttlDuration</strong><br>
21848+
<em>optional</em></p>
21849+
</div></div></td>
21850+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21851+
<p>TtlDuration limits the lifetime of a pull mode backup and its export If this field is set, after this duration has passed from counting from CreationTimestamp, the backup is eligible to be automatically considered as complete. If this field is omitted, a reasonable default is applied.</p>
21852+
</div></div></td>
21853+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21854+
<p><a href="#_k8s_io_apimachinery_pkg_apis_meta_v1_duration">k8s.io.apimachinery.pkg.apis.meta.v1.Duration</a></p>
21855+
</div></div></td>
21856+
</tr>
2176221857
</tbody>
2176321858
</table>
2176421859
</div>
@@ -21805,6 +21900,18 @@ <h3 id="_v1alpha1_virtualmachinebackupstatus">v1alpha1.VirtualMachineBackupStatu
2180521900
</tr>
2180621901
<tr>
2180721902
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21903+
<p><strong>endpointCert</strong><br>
21904+
<em>optional</em></p>
21905+
</div></div></td>
21906+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21907+
<p>EndpointCert is the raw CACert that is to be used when connecting to an exported backup endpoint in pull mode.</p>
21908+
</div></div></td>
21909+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
21910+
<p>string</p>
21911+
</div></div></td>
21912+
</tr>
21913+
<tr>
21914+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2180821915
<p><strong>includedVolumes</strong><br>
2180921916
<em>optional</em></p>
2181021917
</div></div></td>
@@ -24974,6 +25081,99 @@ <h3 id="_v1beta1_virtualmachineexport">v1beta1.VirtualMachineExport</h3>
2497425081
</table>
2497525082
</div>
2497625083
<div class="sect2">
25084+
<h3 id="_v1beta1_virtualmachineexportbackup">v1beta1.VirtualMachineExportBackup</h3>
25085+
<div class="paragraph">
25086+
<p>VirtualMachineExportBackup contains the URL and available formats for the exported backup</p>
25087+
</div>
25088+
<table class="tableblock frame-all grid-all stretch">
25089+
<colgroup>
25090+
<col style="width: 16.6666%;">
25091+
<col style="width: 61.1111%;">
25092+
<col style="width: 22.2223%;">
25093+
</colgroup>
25094+
<thead>
25095+
<tr>
25096+
<th class="tableblock halign-left valign-middle">Name</th>
25097+
<th class="tableblock halign-left valign-middle">Description</th>
25098+
<th class="tableblock halign-left valign-middle">Schema</th>
25099+
</tr>
25100+
</thead>
25101+
<tbody>
25102+
<tr>
25103+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25104+
<p><strong>endpoints</strong><br>
25105+
<em>optional</em></p>
25106+
</div></div></td>
25107+
<td class="tableblock halign-left valign-middle"><div class="content"></div></td>
25108+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25109+
<p>&lt; <a href="#_v1beta1_virtualmachineexportbackupendpoint">v1beta1.VirtualMachineExportBackupEndpoint</a> &gt; array</p>
25110+
</div></div></td>
25111+
</tr>
25112+
<tr>
25113+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25114+
<p><strong>name</strong><br>
25115+
<em>required</em></p>
25116+
</div></div></td>
25117+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25118+
<p>Name is the name of the exported volume<br>
25119+
<strong>Default</strong> : <code>""</code></p>
25120+
</div></div></td>
25121+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25122+
<p>string</p>
25123+
</div></div></td>
25124+
</tr>
25125+
</tbody>
25126+
</table>
25127+
</div>
25128+
<div class="sect2">
25129+
<h3 id="_v1beta1_virtualmachineexportbackupendpoint">v1beta1.VirtualMachineExportBackupEndpoint</h3>
25130+
<div class="paragraph">
25131+
<p>VirtualMachineExportBackupEndpoint contains the endpoint type and URL to interact with a backup export</p>
25132+
</div>
25133+
<table class="tableblock frame-all grid-all stretch">
25134+
<colgroup>
25135+
<col style="width: 16.6666%;">
25136+
<col style="width: 61.1111%;">
25137+
<col style="width: 22.2223%;">
25138+
</colgroup>
25139+
<thead>
25140+
<tr>
25141+
<th class="tableblock halign-left valign-middle">Name</th>
25142+
<th class="tableblock halign-left valign-middle">Description</th>
25143+
<th class="tableblock halign-left valign-middle">Schema</th>
25144+
</tr>
25145+
</thead>
25146+
<tbody>
25147+
<tr>
25148+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25149+
<p><strong>endpoint</strong><br>
25150+
<em>required</em></p>
25151+
</div></div></td>
25152+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25153+
<p>Endpoint is the endpoint of the backup export at the specified URL<br>
25154+
<strong>Default</strong> : <code>""</code></p>
25155+
</div></div></td>
25156+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25157+
<p>string</p>
25158+
</div></div></td>
25159+
</tr>
25160+
<tr>
25161+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25162+
<p><strong>url</strong><br>
25163+
<em>required</em></p>
25164+
</div></div></td>
25165+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25166+
<p>Url is the url that contains the volume in the format specified<br>
25167+
<strong>Default</strong> : <code>""</code></p>
25168+
</div></div></td>
25169+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25170+
<p>string</p>
25171+
</div></div></td>
25172+
</tr>
25173+
</tbody>
25174+
</table>
25175+
</div>
25176+
<div class="sect2">
2497725177
<h3 id="_v1beta1_virtualmachineexportlink">v1beta1.VirtualMachineExportLink</h3>
2497825178
<div class="paragraph">
2497925179
<p>VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes</p>
@@ -24994,6 +25194,18 @@ <h3 id="_v1beta1_virtualmachineexportlink">v1beta1.VirtualMachineExportLink</h3>
2499425194
<tbody>
2499525195
<tr>
2499625196
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25197+
<p><strong>backups</strong><br>
25198+
<em>optional</em></p>
25199+
</div></div></td>
25200+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25201+
<p>Backups is a list of available backups for the export</p>
25202+
</div></div></td>
25203+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
25204+
<p>&lt; <a href="#_v1beta1_virtualmachineexportbackup">v1beta1.VirtualMachineExportBackup</a> &gt; array</p>
25205+
</div></div></td>
25206+
</tr>
25207+
<tr>
25208+
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2499725209
<p><strong>cert</strong><br>
2499825210
<em>required</em></p>
2499925211
</div></div></td>

‎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 0c896253aee7cabaf5cdb2b0c2069bed9746598a</span>
441+
<span id="revnumber">version 6d1be652754517a23e1046c8ba53d636c30d31a0</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/0c896253aee7cabaf5cdb2b0c2069bed9746598a">0c896253aee7cabaf5cdb2b0c2069bed9746598a</a></p>
476+
<em>Version</em> : <a href="https://github.com/kubevirt/kubevirt/commit/6d1be652754517a23e1046c8ba53d636c30d31a0">6d1be652754517a23e1046c8ba53d636c30d31a0</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 0c896253aee7cabaf5cdb2b0c2069bed9746598a<br>
499+
Version 6d1be652754517a23e1046c8ba53d636c30d31a0<br>
500500
</div>
501501
</div>
502502
</body>

0 commit comments

Comments
 (0)