Skip to content

Commit 5e5a4fc

Browse files
ostempelostempel
committed
Merge branch 'main' of github.com:metal-stack/api into add-js-client
2 parents c6704fe + 2f183a3 commit 5e5a4fc

File tree

22 files changed

+1532
-97
lines changed

22 files changed

+1532
-97
lines changed

‎doc/index.html‎

Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1945,6 +1945,41 @@ <h2>Table of Contents</h2>
19451945
</li>
19461946

19471947

1948+
<li>
1949+
<a href="#metalstack%2finfra%2fv2%2fevent.proto">metalstack/infra/v2/event.proto</a>
1950+
<ul>
1951+
1952+
<li>
1953+
<a href="#metalstack.infra.v2.EventServiceSendRequest"><span class="badge">M</span>EventServiceSendRequest</a>
1954+
</li>
1955+
1956+
<li>
1957+
<a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry"><span class="badge">M</span>EventServiceSendRequest.EventsEntry</a>
1958+
</li>
1959+
1960+
<li>
1961+
<a href="#metalstack.infra.v2.EventServiceSendResponse"><span class="badge">M</span>EventServiceSendResponse</a>
1962+
</li>
1963+
1964+
<li>
1965+
<a href="#metalstack.infra.v2.MachineProvisioningEvent"><span class="badge">M</span>MachineProvisioningEvent</a>
1966+
</li>
1967+
1968+
1969+
<li>
1970+
<a href="#metalstack.infra.v2.ProvisioningEventType"><span class="badge">E</span>ProvisioningEventType</a>
1971+
</li>
1972+
1973+
1974+
1975+
<li>
1976+
<a href="#metalstack.infra.v2.EventService"><span class="badge">S</span>EventService</a>
1977+
</li>
1978+
1979+
</ul>
1980+
</li>
1981+
1982+
19481983
<li>
19491984
<a href="#metalstack%2finfra%2fv2%2fswitch.proto">metalstack/infra/v2/switch.proto</a>
19501985
<ul>
@@ -7823,6 +7858,13 @@ <h3 id="metalstack.api.v2.MachineNic">MachineNic</h3>
78237858
<td><p>Neighbors the neighbors visible to this network interface </p></td>
78247859
</tr>
78257860

7861+
<tr>
7862+
<td>hostname</td>
7863+
<td><a href="#string">string</a></td>
7864+
<td></td>
7865+
<td><p>Hostname the nic belongs to </p></td>
7866+
</tr>
7867+
78267868
</tbody>
78277869
</table>
78287870

@@ -12282,6 +12324,13 @@ <h3 id="metalstack.admin.v2.SwitchServiceUpdateRequest">SwitchServiceUpdateReque
1228212324
<td><p>SwitchOs is the OS running on the switch. </p></td>
1228312325
</tr>
1228412326

12327+
<tr>
12328+
<td>machine_connections</td>
12329+
<td><a href="#metalstack.api.v2.MachineConnection">metalstack.api.v2.MachineConnection</a></td>
12330+
<td>repeated</td>
12331+
<td><p>MachineConnections map machines to the nics they are connected to. </p></td>
12332+
</tr>
12333+
1228512334
</tbody>
1228612335
</table>
1228712336

@@ -15310,6 +15359,246 @@ <h3 id="metalstack.infra.v2.BMCService">BMCService</h3>
1531015359

1531115360

1531215361

15362+
<div class="file-heading">
15363+
<h2 id="metalstack/infra/v2/event.proto">metalstack/infra/v2/event.proto</h2><a href="#title">Top</a>
15364+
</div>
15365+
<p></p>
15366+
15367+
15368+
<h3 id="metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</h3>
15369+
<p>EventServiceSendRequest.</p>
15370+
15371+
15372+
<table class="field-table">
15373+
<thead>
15374+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15375+
</thead>
15376+
<tbody>
15377+
15378+
<tr>
15379+
<td>events</td>
15380+
<td><a href="#metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</a></td>
15381+
<td>repeated</td>
15382+
<td><p>Events grouped by machine IDs. </p></td>
15383+
</tr>
15384+
15385+
</tbody>
15386+
</table>
15387+
15388+
15389+
15390+
15391+
15392+
<h3 id="metalstack.infra.v2.EventServiceSendRequest.EventsEntry">EventServiceSendRequest.EventsEntry</h3>
15393+
<p></p>
15394+
15395+
15396+
<table class="field-table">
15397+
<thead>
15398+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15399+
</thead>
15400+
<tbody>
15401+
15402+
<tr>
15403+
<td>key</td>
15404+
<td><a href="#string">string</a></td>
15405+
<td></td>
15406+
<td><p> </p></td>
15407+
</tr>
15408+
15409+
<tr>
15410+
<td>value</td>
15411+
<td><a href="#metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</a></td>
15412+
<td></td>
15413+
<td><p> </p></td>
15414+
</tr>
15415+
15416+
</tbody>
15417+
</table>
15418+
15419+
15420+
15421+
15422+
15423+
<h3 id="metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</h3>
15424+
<p>EventServiceSendResponse.</p>
15425+
15426+
15427+
<table class="field-table">
15428+
<thead>
15429+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15430+
</thead>
15431+
<tbody>
15432+
15433+
<tr>
15434+
<td>events</td>
15435+
<td><a href="#uint64">uint64</a></td>
15436+
<td></td>
15437+
<td><p>Events counts the number of events successfully stored in the database. </p></td>
15438+
</tr>
15439+
15440+
<tr>
15441+
<td>failed</td>
15442+
<td><a href="#string">string</a></td>
15443+
<td>repeated</td>
15444+
<td><p>Failed contains IDs of all machines whose events could not be stored in the database. </p></td>
15445+
</tr>
15446+
15447+
</tbody>
15448+
</table>
15449+
15450+
15451+
15452+
15453+
15454+
<h3 id="metalstack.infra.v2.MachineProvisioningEvent">MachineProvisioningEvent</h3>
15455+
<p>MachineProvisioningEvent contains details about an event.</p>
15456+
15457+
15458+
<table class="field-table">
15459+
<thead>
15460+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15461+
</thead>
15462+
<tbody>
15463+
15464+
<tr>
15465+
<td>time</td>
15466+
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
15467+
<td></td>
15468+
<td><p>Time the event occurred at. </p></td>
15469+
</tr>
15470+
15471+
<tr>
15472+
<td>event</td>
15473+
<td><a href="#metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</a></td>
15474+
<td></td>
15475+
<td><p>Event that occurred. </p></td>
15476+
</tr>
15477+
15478+
<tr>
15479+
<td>message</td>
15480+
<td><a href="#string">string</a></td>
15481+
<td></td>
15482+
<td><p>Message describing the event in more detail. </p></td>
15483+
</tr>
15484+
15485+
</tbody>
15486+
</table>
15487+
15488+
15489+
15490+
15491+
15492+
15493+
15494+
<h3 id="metalstack.infra.v2.ProvisioningEventType">ProvisioningEventType</h3>
15495+
<p>ProvisioningEventType is a short description of a machine event.</p>
15496+
<table class="enum-table">
15497+
<thead>
15498+
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
15499+
</thead>
15500+
<tbody>
15501+
15502+
<tr>
15503+
<td>PROVISIONING_EVENT_TYPE_UNSPECIFIED</td>
15504+
<td>0</td>
15505+
<td><p>PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.</p></td>
15506+
</tr>
15507+
15508+
<tr>
15509+
<td>PROVISIONING_EVENT_TYPE_ALIVE</td>
15510+
<td>1</td>
15511+
<td><p>PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.</p></td>
15512+
</tr>
15513+
15514+
<tr>
15515+
<td>PROVISIONING_EVENT_TYPE_CRASHED</td>
15516+
<td>2</td>
15517+
<td><p>PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine&#39;s lifecycle.</p></td>
15518+
</tr>
15519+
15520+
<tr>
15521+
<td>PROVISIONING_EVENT_TYPE_PXE_BOOTING</td>
15522+
<td>3</td>
15523+
<td><p>PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.</p></td>
15524+
</tr>
15525+
15526+
<tr>
15527+
<td>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT</td>
15528+
<td>4</td>
15529+
<td><p>PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.</p></td>
15530+
</tr>
15531+
15532+
<tr>
15533+
<td>PROVISIONING_EVENT_TYPE_PREPARING</td>
15534+
<td>5</td>
15535+
<td><p>PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.</p></td>
15536+
</tr>
15537+
15538+
<tr>
15539+
<td>PROVISIONING_EVENT_TYPE_REGISTERING</td>
15540+
<td>6</td>
15541+
<td><p>PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.</p></td>
15542+
</tr>
15543+
15544+
<tr>
15545+
<td>PROVISIONING_EVENT_TYPE_WAITING</td>
15546+
<td>7</td>
15547+
<td><p>PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.</p></td>
15548+
</tr>
15549+
15550+
<tr>
15551+
<td>PROVISIONING_EVENT_TYPE_INSTALLING</td>
15552+
<td>8</td>
15553+
<td><p>PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.</p></td>
15554+
</tr>
15555+
15556+
<tr>
15557+
<td>PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL</td>
15558+
<td>9</td>
15559+
<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>
15560+
</tr>
15561+
15562+
<tr>
15563+
<td>PROVISIONING_EVENT_TYPE_PHONED_HOME</td>
15564+
<td>10</td>
15565+
<td><p>PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.</p></td>
15566+
</tr>
15567+
15568+
<tr>
15569+
<td>PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM</td>
15570+
<td>11</td>
15571+
<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>
15572+
</tr>
15573+
15574+
</tbody>
15575+
</table>
15576+
15577+
15578+
15579+
15580+
15581+
<h3 id="metalstack.infra.v2.EventService">EventService</h3>
15582+
<p>EventService serves event related functions.</p>
15583+
<table class="enum-table">
15584+
<thead>
15585+
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
15586+
</thead>
15587+
<tbody>
15588+
15589+
<tr>
15590+
<td>Send</td>
15591+
<td><a href="#metalstack.infra.v2.EventServiceSendRequest">EventServiceSendRequest</a></td>
15592+
<td><a href="#metalstack.infra.v2.EventServiceSendResponse">EventServiceSendResponse</a></td>
15593+
<td><p>Send a series of machine provisioning events.</p></td>
15594+
</tr>
15595+
15596+
</tbody>
15597+
</table>
15598+
15599+
15600+
15601+
1531315602
<div class="file-heading">
1531415603
<h2 id="metalstack/infra/v2/switch.proto">metalstack/infra/v2/switch.proto</h2><a href="#title">Top</a>
1531515604
</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.

0 commit comments

Comments
 (0)