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

Merged
majst01 merged 15 commits into from
Apr 20, 2026
Merged

Machine create refinements #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 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
1366d8f
Move machine tags from metal-lib
majst01 Apr 5, 2026
435d2a4
Move machine tags from metal-lib
majst01 Apr 5, 2026
a3ddf52
Updates
majst01 Apr 7, 2026
460284f
Map validations
majst01 Apr 9, 2026
4b73180
Review comments
majst01 Apr 18, 2026
3061eea
Fix field numbering test
majst01 Apr 19, 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
79 changes: 22 additions & 57 deletions doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1173,10 +1173,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 @@ -3293,7 +3289,7 @@ <h3 id="metalstack.api.v2.Visibility">Visibility</h3>

<tr>
<td>VISIBILITY_SELF</td>
<td>3</td>
<td>2</td>
<td><p>VISIBILITY_SELF enable call this endpoint from the authenticated user only</p></td>
</tr>

Expand Down Expand Up @@ -9831,37 +9827,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 @@ -9880,11 +9845,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 @@ -11180,7 +11145,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 @@ -11207,22 +11173,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 @@ -11263,13 +11235,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 @@ -12118,15 +12083,15 @@ <h3 id="metalstack.api.v2.MachineState">MachineState</h3>
</tr>

<tr>
<td>MACHINE_STATE_RESERVED</td>
<td>MACHINE_STATE_TAINTED</td>
<td>1</td>
<td><p>MACHINE_STATE_RESERVED this machine is reserved</p></td>
<td><p>MACHINE_STATE_TAINTED this machine is tainted, i.e. 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, i.e. this machine cannot be allocated or deleted</p></td>
</tr>

<tr>
Expand Down
8 changes: 4 additions & 4 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/metal-stack/api
go 1.26

require (
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260209202127-80ab13bee0bf.1
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260415201107-50325440f8f2.1
buf.build/go/protovalidate v1.1.3
connectrpc.com/connect v1.19.1
github.com/bufbuild/protocompile v0.14.1
Expand All @@ -26,10 +26,10 @@ require (
github.com/minio/minlz v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/stretchr/objx v0.5.3 // indirect
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 // indirect
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f // indirect
golang.org/x/text v0.36.0 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20260406210006-6f92a3bedf2d // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260406210006-6f92a3bedf2d // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20260414002931-afd174a4e478 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478 // indirect
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
16 changes: 8 additions & 8 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260209202127-80ab13bee0bf.1 h1:PMmTMyvHScV9Mn8wc6ASge9uRcHy0jtqPd+fM35LmsQ=
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260209202127-80ab13bee0bf.1/go.mod h1:tvtbpgaVXZX4g6Pn+AnzFycuRK3MOz5HJfEGeEllXYM=
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260415201107-50325440f8f2.1 h1:s6hzCXtND/ICdGPTMGk7C+/BFlr2Jg5GyH0NKf4XGXg=
buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.36.11-20260415201107-50325440f8f2.1/go.mod h1:tvtbpgaVXZX4g6Pn+AnzFycuRK3MOz5HJfEGeEllXYM=
buf.build/go/protovalidate v1.1.3 h1:m2GVEgQWd7rk+vIoAZ+f0ygGjvQTuqPQapBBdcpWVPE=
buf.build/go/protovalidate v1.1.3/go.mod h1:9XIuohWz+kj+9JVn3WQneHA5LZP50mjvneZMnbLkiIE=
cel.dev/expr v0.25.1 h1:1KrZg61W6TWSxuNZ37Xy49ps13NUovb66QLprthtwi4=
Expand Down Expand Up @@ -51,14 +51,14 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 h1:jiDhWWeC7jfWqR9c/uplMOqJ0sbNlNWv0UkzE0vX1MA=
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90/go.mod h1:xE1HEv6b+1SCZ5/uscMRjUBKtIxworgEcEi+/n9NQDQ=
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f h1:W3F4c+6OLc6H2lb//N1q4WpJkhzJCK5J6kUi1NTVXfM=
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f/go.mod h1:J1xhfL/vlindoeF/aINzNzt2Bket5bjo9sdOYzOsU80=
golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
google.golang.org/genproto/googleapis/api v0.0.0-20260406210006-6f92a3bedf2d h1:/aDRtSZJjyLQzm75d+a1wOJaqyKBMvIAfeQmoa3ORiI=
google.golang.org/genproto/googleapis/api v0.0.0-20260406210006-6f92a3bedf2d/go.mod h1:etfGUgejTiadZAUaEP14NP97xi1RGeawqkjDARA/UOs=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260406210006-6f92a3bedf2d h1:wT2n40TBqFY6wiwazVK9/iTWbsQrgk5ZfCSVFLO9LQA=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260406210006-6f92a3bedf2d/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/genproto/googleapis/api v0.0.0-20260414002931-afd174a4e478 h1:yQugLulqltosq0B/f8l4w9VryjV+N/5gcW0jQ3N8Qec=
google.golang.org/genproto/googleapis/api v0.0.0-20260414002931-afd174a4e478/go.mod h1:C6ADNqOxbgdUUeRTU+LCHDPB9ttAMCTff6auwCVa4uc=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478 h1:RmoJA1ujG+/lRGNfUnOMfhCy5EipVMyvUE+KNbPbTlw=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
Expand Down
8 changes: 4 additions & 4 deletions go/metalstack/api/v2/common.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions go/metalstack/api/v2/filesystem.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions go/metalstack/api/v2/image.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading