Skip to content

Machine create refinements #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
majst01 wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Machine create refinements #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7d0a002
Refinements for machine create
majst01 Mar 24, 2026
503e9c3
Additional ips are part of the allocationnetwork
majst01 Mar 27, 2026
3639989
Merge main
majst01 Mar 27, 2026
fa7eb35
Partition and Size must be optional when uuid is given
majst01 Mar 31, 2026
e8c4aaa
Better documentation
majst01 Apr 1, 2026
faf0e22
Review Findings
majst01 Apr 2, 2026
fb11549
Merge main
majst01 Apr 2, 2026
d05dcd3
Merge branch 'main' of https://github.com/metal-stack/api into machin…
majst01 Apr 2, 2026
ed0b27a
Better docu
majst01 Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 20 additions & 55 deletions doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1165,10 +1165,6 @@ <h2>Table of Contents</h2>
<a href="#metalstack.api.v2.MachineAllocation"><span class="badge">M</span>MachineAllocation</a>
</li>

<li>
<a href="#metalstack.api.v2.MachineAllocationIp"><span class="badge">M</span>MachineAllocationIp</a>
</li>

<li>
<a href="#metalstack.api.v2.MachineAllocationNetwork"><span class="badge">M</span>MachineAllocationNetwork</a>
</li>
Expand Down Expand Up @@ -9807,37 +9803,6 @@ <h3 id="metalstack.api.v2.MachineAllocation">MachineAllocation</h3>



<h3 id="metalstack.api.v2.MachineAllocationIp">MachineAllocationIp</h3>
<p>MachineAllocationIp defines a ip and a optional namespace which should be attached to this machine during create</p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>ip</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>IP to to attach to this machine additionally </p></td>
</tr>

<tr>
<td>namespace</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>Namespace where this ip was created, usually the project of the namespaced tenant network. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.api.v2.MachineAllocationNetwork">MachineAllocationNetwork</h3>
<p>MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired</p>

Expand All @@ -9856,11 +9821,11 @@ <h3 id="metalstack.api.v2.MachineAllocationNetwork">MachineAllocationNetwork</h3
</tr>

<tr>
<td>no_auto_acquire_ip</td>
<td><a href="#bool">bool</a></td>
<td>optional</td>
<td><p>NoAutoAcquireIp will prevent automatic ip acquirement per network if set to true.
By default one ip address is acquired per network for the machine </p></td>
<td>ips</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
<td><p>IPs to to attach to this machine additionally
If none given, one ip address is acquired per network for the machine </p></td>
</tr>

</tbody>
Expand Down Expand Up @@ -11156,7 +11121,8 @@ <h3 id="metalstack.api.v2.MachineServiceCreateRequest">MachineServiceCreateReque
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated.
this field overrules size and partition </p></td>
this field overrules size and partition.
Can only be used with ADMIN_ROLE_EDITOR </p></td>
</tr>

<tr>
Expand All @@ -11183,22 +11149,28 @@ <h3 id="metalstack.api.v2.MachineServiceCreateRequest">MachineServiceCreateReque
<tr>
<td>partition</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Partition the partition id to assign this machine to </p></td>
<td>optional</td>
<td><p>Partition the partition id to assign this machine to, must be omitted if uuid is given </p></td>
</tr>

<tr>
<td>size</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Size of the machine to create </p></td>
<td>optional</td>
<td><p>Size of the machine to create, must be omitted if uuid is given </p></td>
</tr>

<tr>
<td>image</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Image which should be installed on this machine </p></td>
<td><p>Image which should be installed on this machine
The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch
- debian-13.0.20260402
or in a simplified form which omits the patch version
- debian-13.0
If the fully qualified form is specified, exactly this image is taken regardless of the image classification
if the short form is given, only the most recent images which has image classification supported is used. </p></td>
</tr>

<tr>
Expand Down Expand Up @@ -11239,13 +11211,6 @@ <h3 id="metalstack.api.v2.MachineServiceCreateRequest">MachineServiceCreateReque
<td><p>Networks the networks that this machine will be placed in. </p></td>
</tr>

<tr>
<td>ips</td>
<td><a href="#metalstack.api.v2.MachineAllocationIp">MachineAllocationIp</a></td>
<td>repeated</td>
<td><p>IPs to to attach to this machine additionally </p></td>
</tr>

<tr>
<td>placement_tags</td>
<td><a href="#string">string</a></td>
Expand Down Expand Up @@ -12096,13 +12061,13 @@ <h3 id="metalstack.api.v2.MachineState">MachineState</h3>
<tr>
<td>MACHINE_STATE_RESERVED</td>
<td>1</td>
<td><p>MACHINE_STATE_RESERVED this machine is reserved</p></td>
<td><p>MACHINE_STATE_RESERVED this machine is reserved, e.g. this machine is not considered during random machine allocation, but still by specifying the uuid</p></td>
</tr>

<tr>
<td>MACHINE_STATE_LOCKED</td>
<td>2</td>
<td><p>MACHINE_STATE_LOCKED this machine is locked</p></td>
<td><p>MACHINE_STATE_LOCKED this machine is locked, e.g. this machine cannot be allocated or deleted</p></td>
</tr>

<tr>
Expand Down
Loading
Loading