Skip to content

Commit a37f41b

Browse files
committed
Review
1 parent e90e900 commit a37f41b

File tree

1 file changed

+65
-3
lines changed

1 file changed

+65
-3
lines changed

docs/api-reference/compute.md

Lines changed: 65 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ string
134134
</td>
135135
<td>
136136
<em>(Optional)</em>
137-
<p>Image is the optional URL providing the operating system image of the machine.</p>
137+
<p>Deprecated: Use LocalDisk to provide a bootable disk
138+
Image is the optional URL providing the operating system image of the machine.</p>
138139
</td>
139140
</tr>
140141
<tr>
@@ -572,6 +573,52 @@ github.com/ironcore-dev/ironcore/api/storage/v1alpha1.VolumeTemplateSpec
572573
</tr>
573574
</tbody>
574575
</table>
576+
<h3 id="compute.ironcore.dev/v1alpha1.LocalDiskVolumeSource">LocalDiskVolumeSource
577+
</h3>
578+
<p>
579+
(<em>Appears on:</em><a href="#compute.ironcore.dev/v1alpha1.VolumeSource">VolumeSource</a>)
580+
</p>
581+
<div>
582+
<p>LocalDiskVolumeSource is a volume that&rsquo;s offered by the machine pool provider.
583+
Usually ephemeral (i.e. deleted when the surrounding entity is deleted), with
584+
varying performance characteristics. Potentially not recoverable.</p>
585+
</div>
586+
<table>
587+
<thead>
588+
<tr>
589+
<th>Field</th>
590+
<th>Description</th>
591+
</tr>
592+
</thead>
593+
<tbody>
594+
<tr>
595+
<td>
596+
<code>sizeLimit</code><br/>
597+
<em>
598+
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity">
599+
k8s.io/apimachinery/pkg/api/resource.Quantity
600+
</a>
601+
</em>
602+
</td>
603+
<td>
604+
<p>SizeLimit is the total amount of local storage required for this LocalDisk volume.
605+
The default is nil which means that the limit is undefined.</p>
606+
</td>
607+
</tr>
608+
<tr>
609+
<td>
610+
<code>image</code><br/>
611+
<em>
612+
string
613+
</em>
614+
</td>
615+
<td>
616+
<em>(Optional)</em>
617+
<p>Image is the optional URL providing the operating system image of the machine.</p>
618+
</td>
619+
</tr>
620+
</tbody>
621+
</table>
575622
<h3 id="compute.ironcore.dev/v1alpha1.MachineExecOptions">MachineExecOptions
576623
</h3>
577624
<div>
@@ -1061,7 +1108,8 @@ string
10611108
</td>
10621109
<td>
10631110
<em>(Optional)</em>
1064-
<p>Image is the optional URL providing the operating system image of the machine.</p>
1111+
<p>Deprecated: Use LocalDisk to provide a bootable disk
1112+
Image is the optional URL providing the operating system image of the machine.</p>
10651113
</td>
10661114
</tr>
10671115
<tr>
@@ -1573,7 +1621,21 @@ EmptyDiskVolumeSource
15731621
</em>
15741622
</td>
15751623
<td>
1576-
<p>EmptyDisk instructs to use a Volume offered by the machine pool provider.</p>
1624+
<p>Deprecated: Use LocalDisk instead
1625+
EmptyDisk instructs to use a Volume offered by the machine pool provider.</p>
1626+
</td>
1627+
</tr>
1628+
<tr>
1629+
<td>
1630+
<code>localDisk</code><br/>
1631+
<em>
1632+
<a href="#compute.ironcore.dev/v1alpha1.LocalDiskVolumeSource">
1633+
LocalDiskVolumeSource
1634+
</a>
1635+
</em>
1636+
</td>
1637+
<td>
1638+
<p>LocalDisk instructs to use a Volume offered by the machine pool provider.</p>
15771639
</td>
15781640
</tr>
15791641
<tr>

0 commit comments

Comments
 (0)