Skip to content

Commit 22992ae

Browse files
committed
merge main
2 parents d7dc88a + 9d41307 commit 22992ae

File tree

18 files changed

+1461
-49
lines changed

18 files changed

+1461
-49
lines changed

doc/index.html

Lines changed: 282 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1968,6 +1968,41 @@ <h2>Table of Contents</h2>
19681968
</li>
19691969

19701970

1971+
<li>
1972+
<a href="#metalstack%2finfra%2fv2%2fevent.proto">metalstack/infra/v2/event.proto</a>
1973+
<ul>
1974+
1975+
<li>
1976+
<a href="#metalstack.infra.v2.EventServiceSendRequest"><span class="badge">M</span>EventServiceSendRequest</a>
1977+
</li>
1978+
1979+
<li>
1980+
<a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry"><span class="badge">M</span>EventServiceSendRequest.EventsEntry</a>
1981+
</li>
1982+
1983+
<li>
1984+
<a href="#metalstack.infra.v2.EventServiceSendResponse"><span class="badge">M</span>EventServiceSendResponse</a>
1985+
</li>
1986+
1987+
<li>
1988+
<a href="#metalstack.infra.v2.MachineProvisioningEvent"><span class="badge">M</span>MachineProvisioningEvent</a>
1989+
</li>
1990+
1991+
1992+
<li>
1993+
<a href="#metalstack.infra.v2.ProvisioningEventType"><span class="badge">E</span>ProvisioningEventType</a>
1994+
</li>
1995+
1996+
1997+
1998+
<li>
1999+
<a href="#metalstack.infra.v2.EventService"><span class="badge">S</span>EventService</a>
2000+
</li>
2001+
2002+
</ul>
2003+
</li>
2004+
2005+
19712006
<li>
19722007
<a href="#metalstack%2finfra%2fv2%2fswitch.proto">metalstack/infra/v2/switch.proto</a>
19732008
<ul>
@@ -7853,6 +7888,13 @@ <h3 id="metalstack.api.v2.MachineNic">MachineNic</h3>
78537888
<td><p>Neighbors the neighbors visible to this network interface </p></td>
78547889
</tr>
78557890

7891+
<tr>
7892+
<td>hostname</td>
7893+
<td><a href="#string">string</a></td>
7894+
<td></td>
7895+
<td><p>Hostname the nic belongs to </p></td>
7896+
</tr>
7897+
78567898
</tbody>
78577899
</table>
78587900

@@ -15448,6 +15490,246 @@ <h3 id="metalstack.infra.v2.BMCService">BMCService</h3>
1544815490

1544915491

1545015492

15493+
<div class="file-heading">
15494+
<h2 id="metalstack/infra/v2/event.proto">metalstack/infra/v2/event.proto</h2><a href="#title">Top</a>
15495+
</div>
15496+
<p></p>
15497+
15498+
15499+
<h3 id="metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</h3>
15500+
<p>EventServiceSendRequest.</p>
15501+
15502+
15503+
<table class="field-table">
15504+
<thead>
15505+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15506+
</thead>
15507+
<tbody>
15508+
15509+
<tr>
15510+
<td>events</td>
15511+
<td><a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</a></td>
15512+
<td>repeated</td>
15513+
<td><p>Events grouped by machine IDs. </p></td>
15514+
</tr>
15515+
15516+
</tbody>
15517+
</table>
15518+
15519+
15520+
15521+
15522+
15523+
<h3 id="metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</h3>
15524+
<p></p>
15525+
15526+
15527+
<table class="field-table">
15528+
<thead>
15529+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15530+
</thead>
15531+
<tbody>
15532+
15533+
<tr>
15534+
<td>key</td>
15535+
<td><a href="#string">string</a></td>
15536+
<td></td>
15537+
<td><p> </p></td>
15538+
</tr>
15539+
15540+
<tr>
15541+
<td>value</td>
15542+
<td><a href="#metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</a></td>
15543+
<td></td>
15544+
<td><p> </p></td>
15545+
</tr>
15546+
15547+
</tbody>
15548+
</table>
15549+
15550+
15551+
15552+
15553+
15554+
<h3 id="metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</h3>
15555+
<p>EventServiceSendResponse.</p>
15556+
15557+
15558+
<table class="field-table">
15559+
<thead>
15560+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15561+
</thead>
15562+
<tbody>
15563+
15564+
<tr>
15565+
<td>events</td>
15566+
<td><a href="#uint64">uint64</a></td>
15567+
<td></td>
15568+
<td><p>Events counts the number of events successfully stored in the database. </p></td>
15569+
</tr>
15570+
15571+
<tr>
15572+
<td>failed</td>
15573+
<td><a href="#string">string</a></td>
15574+
<td>repeated</td>
15575+
<td><p>Failed contains IDs of all machines whose events could not be stored in the database. </p></td>
15576+
</tr>
15577+
15578+
</tbody>
15579+
</table>
15580+
15581+
15582+
15583+
15584+
15585+
<h3 id="metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</h3>
15586+
<p>MachineProvisioningEvent contains details about an event.</p>
15587+
15588+
15589+
<table class="field-table">
15590+
<thead>
15591+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15592+
</thead>
15593+
<tbody>
15594+
15595+
<tr>
15596+
<td>time</td>
15597+
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
15598+
<td></td>
15599+
<td><p>Time the event occurred at. </p></td>
15600+
</tr>
15601+
15602+
<tr>
15603+
<td>event</td>
15604+
<td><a href="#metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</a></td>
15605+
<td></td>
15606+
<td><p>Event that occurred. </p></td>
15607+
</tr>
15608+
15609+
<tr>
15610+
<td>message</td>
15611+
<td><a href="#string">string</a></td>
15612+
<td></td>
15613+
<td><p>Message describing the event in more detail. </p></td>
15614+
</tr>
15615+
15616+
</tbody>
15617+
</table>
15618+
15619+
15620+
15621+
15622+
15623+
15624+
15625+
<h3 id="metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</h3>
15626+
<p>ProvisioningEventType is a short description of a machine event.</p>
15627+
<table class="enum-table">
15628+
<thead>
15629+
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
15630+
</thead>
15631+
<tbody>
15632+
15633+
<tr>
15634+
<td>PROVISIONING_EVENT_TYPE_UNSPECIFIED</td>
15635+
<td>0</td>
15636+
<td><p>PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.</p></td>
15637+
</tr>
15638+
15639+
<tr>
15640+
<td>PROVISIONING_EVENT_TYPE_ALIVE</td>
15641+
<td>1</td>
15642+
<td><p>PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.</p></td>
15643+
</tr>
15644+
15645+
<tr>
15646+
<td>PROVISIONING_EVENT_TYPE_CRASHED</td>
15647+
<td>2</td>
15648+
<td><p>PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine&#39;s lifecycle.</p></td>
15649+
</tr>
15650+
15651+
<tr>
15652+
<td>PROVISIONING_EVENT_TYPE_PXE_BOOTING</td>
15653+
<td>3</td>
15654+
<td><p>PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.</p></td>
15655+
</tr>
15656+
15657+
<tr>
15658+
<td>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT</td>
15659+
<td>4</td>
15660+
<td><p>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.</p></td>
15661+
</tr>
15662+
15663+
<tr>
15664+
<td>PROVISIONING_EVENT_TYPE_PREPARING</td>
15665+
<td>5</td>
15666+
<td><p>PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.</p></td>
15667+
</tr>
15668+
15669+
<tr>
15670+
<td>PROVISIONING_EVENT_TYPE_REGISTERING</td>
15671+
<td>6</td>
15672+
<td><p>PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.</p></td>
15673+
</tr>
15674+
15675+
<tr>
15676+
<td>PROVISIONING_EVENT_TYPE_WAITING</td>
15677+
<td>7</td>
15678+
<td><p>PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.</p></td>
15679+
</tr>
15680+
15681+
<tr>
15682+
<td>PROVISIONING_EVENT_TYPE_INSTALLING</td>
15683+
<td>8</td>
15684+
<td><p>PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.</p></td>
15685+
</tr>
15686+
15687+
<tr>
15688+
<td>PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL</td>
15689+
<td>9</td>
15690+
<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>
15691+
</tr>
15692+
15693+
<tr>
15694+
<td>PROVISIONING_EVENT_TYPE_PHONED_HOME</td>
15695+
<td>10</td>
15696+
<td><p>PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.</p></td>
15697+
</tr>
15698+
15699+
<tr>
15700+
<td>PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM</td>
15701+
<td>11</td>
15702+
<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>
15703+
</tr>
15704+
15705+
</tbody>
15706+
</table>
15707+
15708+
15709+
15710+
15711+
15712+
<h3 id="metalstack.infra.v2.EventService">EventService</h3>
15713+
<p>EventService serves event related functions.</p>
15714+
<table class="enum-table">
15715+
<thead>
15716+
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
15717+
</thead>
15718+
<tbody>
15719+
15720+
<tr>
15721+
<td>Send</td>
15722+
<td><a href="#metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</a></td>
15723+
<td><a href="#metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</a></td>
15724+
<td><p>Send a series of machine provisioning events.</p></td>
15725+
</tr>
15726+
15727+
</tbody>
15728+
</table>
15729+
15730+
15731+
15732+
1545115733
<div class="file-heading">
1545215734
<h2 id="metalstack/infra/v2/switch.proto">metalstack/infra/v2/switch.proto</h2><a href="#title">Top</a>
1545315735
</div>

go/client/client.go

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go/metalstack/api/v2/machine.pb.go

Lines changed: 13 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)