Browse Source
Change-Id: I803689985c0010b452f52bfe9a57bc5e910d051f Signed-off-by: Sean Eagan <seaneagan1@gmail.com>changes/77/771877/5
Sean Eagan
2 years ago
10 changed files with 1099 additions and 6 deletions
@ -0,0 +1,870 @@
|
||||
<h1>Vino API reference</h1> |
||||
<p>Packages:</p> |
||||
<ul class="simple"> |
||||
<li> |
||||
<a href="#airship.airshipit.org%2fv1">airship.airshipit.org/v1</a> |
||||
</li> |
||||
</ul> |
||||
<h2 id="airship.airshipit.org/v1">airship.airshipit.org/v1</h2> |
||||
<p>Package v1 contains API Schema definitions for the airship v1 API group</p> |
||||
Resource Types: |
||||
<ul class="simple"></ul> |
||||
<h3 id="airship.airshipit.org/v1.CPUConfiguration">CPUConfiguration |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec">VinoSpec</a>) |
||||
</p> |
||||
<p>CPUConfiguration CPU node configuration</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>cpuExclude</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Exclude CPU example 0-4,54-60</p> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.DaemonSetOptions">DaemonSetOptions |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec">VinoSpec</a>) |
||||
</p> |
||||
<p>DaemonSetOptions be used to spawn vino-builder, libvirt, sushy an</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>namespacedName</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NamespacedName"> |
||||
NamespacedName |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>libvirtImage</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>sushyImage</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>vinoBuilderImage</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>nodeAnnotatorImage</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.DiskDrivesTemplate">DiskDrivesTemplate |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.NodeSet">NodeSet</a>) |
||||
</p> |
||||
<p>DiskDrivesTemplate defines disks on the VM</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>name</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>type</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>path</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>options</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.DiskOptions"> |
||||
DiskOptions |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.DiskOptions">DiskOptions |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.DiskDrivesTemplate">DiskDrivesTemplate</a>) |
||||
</p> |
||||
<p>DiskOptions disk options</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>sizeGb</code><br> |
||||
<em> |
||||
int |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>sparse</code><br> |
||||
<em> |
||||
bool |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.NamespacedName">NamespacedName |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.DaemonSetOptions">DaemonSetOptions</a>, |
||||
<a href="#airship.airshipit.org/v1.NodeSet">NodeSet</a>) |
||||
</p> |
||||
<p>NamespacedName to be used to spawn VMs</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>name</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>namespace</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.Network">Network |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec">VinoSpec</a>) |
||||
</p> |
||||
<p>Network defines libvirt networks</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>name</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Network Parameter defined</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>subnet</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>allocationStart</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>allocationStop</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>dns_servers</code><br> |
||||
<em> |
||||
[]string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>routes</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.VMRoutes"> |
||||
VMRoutes |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.NetworkInterface">NetworkInterface |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.NodeSet">NodeSet</a>) |
||||
</p> |
||||
<p>NetworkInterface define interface on the VM</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>name</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define parameter for network interfaces</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>type</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>network</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>mtu</code><br> |
||||
<em> |
||||
int |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>options</code><br> |
||||
<em> |
||||
map[string]string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.NodeSelector">NodeSelector |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec">VinoSpec</a>) |
||||
</p> |
||||
<p>NodeSelector identifies nodes to create VMs on</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>matchLabels</code><br> |
||||
<em> |
||||
map[string]string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Node type needs to specified</p> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.NodeSet">NodeSet |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec">VinoSpec</a>) |
||||
</p> |
||||
<p>NodeSet node definitions</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>name</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Parameter for Node master or worker-standard</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>count</code><br> |
||||
<em> |
||||
int |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>labels</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.VMNodeFlavor"> |
||||
VMNodeFlavor |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>libvirtTemplate</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NamespacedName"> |
||||
NamespacedName |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>networkInterfaces</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NetworkInterface"> |
||||
NetworkInterface |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>diskDrives</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.DiskDrivesTemplate"> |
||||
DiskDrivesTemplate |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.VMNodeFlavor">VMNodeFlavor |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.NodeSet">NodeSet</a>) |
||||
</p> |
||||
<p>VMNodeFlavor labels for node to be annotated</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>vmFlavor</code><br> |
||||
<em> |
||||
map[string]string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.VMRoutes">VMRoutes |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.Network">Network</a>) |
||||
</p> |
||||
<p>VMRoutes defined</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>to</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>via</code><br> |
||||
<em> |
||||
string |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.Vino">Vino |
||||
</h3> |
||||
<p>Vino is the Schema for the vinoes API</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>metadata</code><br> |
||||
<em> |
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta"> |
||||
Kubernetes meta/v1.ObjectMeta |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
Refer to the Kubernetes API documentation for the fields of the |
||||
<code>metadata</code> field. |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>spec</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.VinoSpec"> |
||||
VinoSpec |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<br/> |
||||
<br/> |
||||
<table> |
||||
<tr> |
||||
<td> |
||||
<code>nodeSelector</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NodeSelector"> |
||||
NodeSelector |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define nodelabel parameters</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>configuration</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.CPUConfiguration"> |
||||
CPUConfiguration |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define CPU configuration</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>networks</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.Network"> |
||||
Network |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define network parameters</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>nodes</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NodeSet"> |
||||
[]NodeSet |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define node details</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>daemonSetOptions</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.DaemonSetOptions"> |
||||
DaemonSetOptions |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>DaemonSetOptions defines how vino will spawn daemonset on nodes</p> |
||||
</td> |
||||
</tr> |
||||
</table> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>status</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.VinoStatus"> |
||||
VinoStatus |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.VinoSpec">VinoSpec |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.Vino">Vino</a>) |
||||
</p> |
||||
<p>VinoSpec defines the desired state of Vino</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>nodeSelector</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NodeSelector"> |
||||
NodeSelector |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define nodelabel parameters</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>configuration</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.CPUConfiguration"> |
||||
CPUConfiguration |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define CPU configuration</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>networks</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.Network"> |
||||
Network |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define network parameters</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>nodes</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.NodeSet"> |
||||
[]NodeSet |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>Define node details</p> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>daemonSetOptions</code><br> |
||||
<em> |
||||
<a href="#airship.airshipit.org/v1.DaemonSetOptions"> |
||||
DaemonSetOptions |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
<p>DaemonSetOptions defines how vino will spawn daemonset on nodes</p> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<h3 id="airship.airshipit.org/v1.VinoStatus">VinoStatus |
||||
</h3> |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
<a href="#airship.airshipit.org/v1.Vino">Vino</a>) |
||||
</p> |
||||
<p>VinoStatus defines the observed state of Vino</p> |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
<tr> |
||||
<td> |
||||
<code>configMapRef</code><br> |
||||
<em> |
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectreference-v1-core"> |
||||
Kubernetes core/v1.ObjectReference |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>conditions</code><br> |
||||
<em> |
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#condition-v1-meta"> |
||||
[]Kubernetes meta/v1.Condition |
||||
</a> |
||||
</em> |
||||
</td> |
||||
<td> |
||||
</td> |
||||
</tr> |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
<div class="admonition note"> |
||||
<p class="last">This page was automatically generated with <code>gen-crd-api-reference-docs</code></p> |
||||
</div> |
||||
@ -0,0 +1,33 @@
|
||||
{ |
||||
"hideMemberFields": [ |
||||
"TypeMeta" |
||||
], |
||||
"hideTypePatterns": [ |
||||
"ParseError$", |
||||
"List$" |
||||
], |
||||
"externalPackages": [ |
||||
{ |
||||
"typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", |
||||
"docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" |
||||
}, |
||||
{ |
||||
"typeMatchPrefix": "^k8s\\.io/apiextensions-apiserver/pkg/apis/apiextensions/v1\\.JSON$", |
||||
"docsURLTemplate": "https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1?tab=doc#JSON" |
||||
}, |
||||
{ |
||||
"typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", |
||||
"docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" |
||||
}, |
||||
{ |
||||
"typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Condition$", |
||||
"docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Condition" |
||||
} |
||||
], |
||||
"typeDisplayNamePrefixOverrides": { |
||||
"k8s.io/api/": "Kubernetes ", |
||||
"k8s.io/apimachinery/pkg/apis/": "Kubernetes ", |
||||
"k8s.io/apiextensions-apiserver/": "Kubernetes " |
||||
}, |
||||
"markdownDisabled": false |
||||
} |
||||
@ -0,0 +1,46 @@
|
||||
{{ define "members" }} |
||||
{{ range .Members }} |
||||
{{ if not (hiddenMember .)}} |
||||
<tr> |
||||
<td> |
||||
<code>{{ fieldName . }}</code><br> |
||||
<em> |
||||
{{ if linkForType .Type }} |
||||
<a href="{{ linkForType .Type }}"> |
||||
{{ typeDisplayName .Type }} |
||||
</a> |
||||
{{ else }} |
||||
{{ typeDisplayName .Type }} |
||||
{{ end }} |
||||
</em> |
||||
</td> |
||||
<td> |
||||
{{ if fieldEmbedded . }} |
||||
<p> |
||||
(Members of <code>{{ fieldName . }}</code> are embedded into this type.) |
||||
</p> |
||||
{{ end}} |
||||
|
||||
{{ if isOptionalMember .}} |
||||
<em>(Optional)</em> |
||||
{{ end }} |
||||
|
||||
{{ safe (renderComments .CommentLines) }} |
||||
|
||||
{{ if and (eq (.Type.Name.Name) "ObjectMeta") }} |
||||
Refer to the Kubernetes API documentation for the fields of the |
||||
<code>metadata</code> field. |
||||
{{ end }} |
||||
|
||||
{{ if or (eq (fieldName .) "spec") }} |
||||
<br/> |
||||
<br/> |
||||
<table> |
||||
{{ template "members" .Type }} |
||||
</table> |
||||
{{ end }} |
||||
</td> |
||||
</tr> |
||||
{{ end }} |
||||
{{ end }} |
||||
{{ end }} |
||||
@ -0,0 +1,46 @@
|
||||
{{ define "packages" }} |
||||
<h1>Vino API reference</h1> |
||||
|
||||
{{ with .packages}} |
||||
<p>Packages:</p> |
||||
<ul class="simple"> |
||||
{{ range . }} |
||||
<li> |
||||
<a href="#{{- packageAnchorID . -}}">{{ packageDisplayName . }}</a> |
||||
</li> |
||||
{{ end }} |
||||
</ul> |
||||
{{ end}} |
||||
|
||||
{{ range .packages }} |
||||
<h2 id="{{- packageAnchorID . -}}"> |
||||
{{- packageDisplayName . -}} |
||||
</h2> |
||||
|
||||
{{ with (index .GoPackages 0 )}} |
||||
{{ with .DocComments }} |
||||
{{ safe (renderComments .) }} |
||||
{{ end }} |
||||
{{ end }} |
||||
|
||||
Resource Types: |
||||
|
||||
<ul class="simple"> |
||||
{{- range (visibleTypes (sortedTypes .Types)) -}} |
||||
{{ if isExportedType . -}} |
||||
<li> |
||||
<a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> |
||||
</li> |
||||
{{- end }} |
||||
{{- end -}} |
||||
</ul> |
||||
|
||||
{{ range (visibleTypes (sortedTypes .Types))}} |
||||
{{ template "type" . }} |
||||
{{ end }} |
||||
{{ end }} |
||||
|
||||
<div class="admonition note"> |
||||
<p class="last">This page was automatically generated with <code>gen-crd-api-reference-docs</code></p> |
||||
</div> |
||||
{{ end }} |
||||
@ -0,0 +1,60 @@
|
||||
{{ define "type" }} |
||||
<h3 id="{{ anchorIDForType . }}"> |
||||
{{- .Name.Name }} |
||||
{{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias){{ end -}} |
||||
</h3> |
||||
|
||||
{{ with (typeReferences .) }} |
||||
<p> |
||||
(<em>Appears on:</em> |
||||
{{- $prev := "" -}} |
||||
{{- range . -}} |
||||
{{- if $prev -}}, {{ end -}} |
||||
{{ $prev = . }} |
||||
<a href="{{ linkForType . }}">{{ typeDisplayName . }}</a> |
||||
{{- end -}} |
||||
) |
||||
</p> |
||||
{{ end }} |
||||
|
||||
{{ with .CommentLines }} |
||||
{{ safe (renderComments .) }} |
||||
{{ end }} |
||||
|
||||
{{ if .Members }} |
||||
<div class="md-typeset__scrollwrap"> |
||||
<div class="md-typeset__table"> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Field</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
</thead> |
||||
<tbody> |
||||
{{ if isExportedType . }} |
||||
<tr> |
||||
<td> |
||||
<code>apiVersion</code><br> |
||||
string</td> |
||||
<td> |
||||
<code>{{ apiGroup . }}</code> |
||||
</td> |
||||
</tr> |
||||
<tr> |
||||
<td> |
||||
<code>kind</code><br> |
||||
string |
||||
</td> |
||||
<td> |
||||
<code>{{ .Name.Name }}</code> |
||||
</td> |
||||
</tr> |
||||
{{ end }} |
||||
{{ template "members" . }} |
||||
</tbody> |
||||
</table> |
||||
</div> |
||||
</div> |
||||
{{ end }} |
||||
{{ end }} |
||||
@ -0,0 +1,20 @@
|
||||
/* |
||||
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
*/ |
||||
|
||||
// Package v1 contains API Schema definitions for the airship v1 API group
|
||||
// +kubebuilder:object:generate=true
|
||||
// +groupName=airship.airshipit.org
|
||||
package v1 |
||||
Loading…
Reference in new issue