Skip to content

Add event service #77

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
iljarotar merged 5 commits into from
Dec 11, 2025
Merged

Add event service #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c157322
Add event service
iljarotar Dec 8, 2025
fed3c2c
Update proto/metalstack/infra/v2/event.proto
iljarotar Dec 9, 2025
6489a65
add missing options
iljarotar Dec 9, 2025
7c027e0
Merge branch 'main' of github.com:metal-stack/api into event-service
iljarotar Dec 10, 2025
62ceee0
Merge branch 'main' of github.com:metal-stack/api into event-service
iljarotar Dec 11, 2025
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
275 changes: 275 additions & 0 deletions doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1945,6 +1945,41 @@ <h2>Table of Contents</h2>
</li>


<li>
<a href="#metalstack%2finfra%2fv2%2fevent.proto">metalstack/infra/v2/event.proto</a>
<ul>

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

<li>
<a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry"><span class="badge">M</span>EventServiceSendRequest.EventsEntry</a>
</li>

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

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


<li>
<a href="#metalstack.infra.v2.ProvisioningEventType"><span class="badge">E</span>ProvisioningEventType</a>
</li>



<li>
<a href="#metalstack.infra.v2.EventService"><span class="badge">S</span>EventService</a>
</li>

</ul>
</li>


<li>
<a href="#metalstack%2finfra%2fv2%2fswitch.proto">metalstack/infra/v2/switch.proto</a>
<ul>
Expand Down Expand Up @@ -15317,6 +15352,246 @@ <h3 id="metalstack.infra.v2.BMCService">BMCService</h3>



<div class="file-heading">
<h2 id="metalstack/infra/v2/event.proto">metalstack/infra/v2/event.proto</h2><a href="#title">Top</a>
</div>
<p></p>


<h3 id="metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</h3>
<p>EventServiceSendRequest.</p>


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

<tr>
<td>events</td>
<td><a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</a></td>
<td>repeated</td>
<td><p>Events grouped by machine IDs. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</h3>
<p></p>


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

<tr>
<td>key</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>

<tr>
<td>value</td>
<td><a href="#metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</a></td>
<td></td>
<td><p> </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</h3>
<p>EventServiceSendResponse.</p>


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

<tr>
<td>events</td>
<td><a href="#uint64">uint64</a></td>
<td></td>
<td><p>Events counts the number of events successfully stored in the database. </p></td>
</tr>

<tr>
<td>failed</td>
<td><a href="#string">string</a></td>
<td>repeated</td>
<td><p>Failed contains IDs of all machines whose events could not be stored in the database. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</h3>
<p>MachineProvisioningEvent contains details about an event.</p>


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

<tr>
<td>time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p>Time the event occurred at. </p></td>
</tr>

<tr>
<td>event</td>
<td><a href="#metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</a></td>
<td></td>
<td><p>Event that occurred. </p></td>
</tr>

<tr>
<td>message</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Message describing the event in more detail. </p></td>
</tr>

</tbody>
</table>







<h3 id="metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</h3>
<p>ProvisioningEventType is a short description of a machine event.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>PROVISIONING_EVENT_TYPE_UNSPECIFIED</td>
<td>0</td>
<td><p>PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_ALIVE</td>
<td>1</td>
<td><p>PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_CRASHED</td>
<td>2</td>
<td><p>PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine&#39;s lifecycle.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_PXE_BOOTING</td>
<td>3</td>
<td><p>PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT</td>
<td>4</td>
<td><p>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_PREPARING</td>
<td>5</td>
<td><p>PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_REGISTERING</td>
<td>6</td>
<td><p>PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_WAITING</td>
<td>7</td>
<td><p>PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_INSTALLING</td>
<td>8</td>
<td><p>PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL</td>
<td>9</td>
<td><p>PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_PHONED_HOME</td>
<td>10</td>
<td><p>PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.</p></td>
</tr>

<tr>
<td>PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM</td>
<td>11</td>
<td><p>PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines.</p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.EventService">EventService</h3>
<p>EventService serves event related functions.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>Send</td>
<td><a href="#metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</a></td>
<td><a href="#metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</a></td>
<td><p>Send a series of machine provisioning events.</p></td>
</tr>

</tbody>
</table>




<div class="file-heading">
<h2 id="metalstack/infra/v2/switch.proto">metalstack/infra/v2/switch.proto</h2><a href="#title">Top</a>
</div>
Expand Down
11 changes: 11 additions & 0 deletions go/client/client.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