Skip to content

Add infra endpoint to issue machine tokens for metal-hammer. #194

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
Gerrit91 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add infra endpoint to issue machine tokens for metal-hammer. #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
91 changes: 91 additions & 0 deletions doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2754,6 +2754,14 @@ <h2>Table of Contents</h2>
<a href="#metalstack.infra.v2.BootServiceInstallationSucceededResponse"><span class="badge">M</span>BootServiceInstallationSucceededResponse</a>
</li>

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

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

<li>
<a href="#metalstack.infra.v2.BootServiceRegisterRequest"><span class="badge">M</span>BootServiceRegisterRequest</a>
</li>
Expand Down Expand Up @@ -22182,6 +22190,82 @@ <h3 id="metalstack.infra.v2.BootServiceInstallationSucceededResponse">BootServic



<h3 id="metalstack.infra.v2.BootServiceMachineTokenRequest">BootServiceMachineTokenRequest</h3>
<p>TokenServiceCreateRequest is the request payload for creating a machine token.</p>


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

<tr>
<td>uuid</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>UUID of the machine that will get the machine token. </p></td>
</tr>

<tr>
<td>user</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>User this token should be created for, it must be labelled in the backend with &#34;tenant.metal-stack.io/machine-bootstrapper&#34; </p></td>
</tr>

<tr>
<td>expires</td>
<td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
<td></td>
<td><p>Expires gives the duration since now, after which this token can not be used anymore. </p></td>
</tr>

<tr>
<td>labels</td>
<td><a href="#metalstack.api.v2.Labels">metalstack.api.v2.Labels</a></td>
<td></td>
<td><p>Labels for this token. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.BootServiceMachineTokenResponse">BootServiceMachineTokenResponse</h3>
<p>TokenServiceCreateResponse is the response payload for the created machine token.</p>


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

<tr>
<td>token</td>
<td><a href="#metalstack.api.v2.Token">metalstack.api.v2.Token</a></td>
<td></td>
<td><p>Token contains the created token. </p></td>
</tr>

<tr>
<td>secret</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Secret is the body if the JWT token, should be used in API requests as bearer token. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.BootServiceRegisterRequest">BootServiceRegisterRequest</h3>
<p>BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible.</p>

Expand Down Expand Up @@ -22424,6 +22508,13 @@ <h3 id="metalstack.infra.v2.BootService">BootService</h3>
<td><p>Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd.</p></td>
</tr>

<tr>
<td>MachineToken</td>
<td><a href="#metalstack.infra.v2.BootServiceMachineTokenRequest">BootServiceMachineTokenRequest</a></td>
<td><a href="#metalstack.infra.v2.BootServiceMachineTokenResponse">BootServiceMachineTokenResponse</a></td>
<td><p>MachineToken is called from pixie to create machine role token for the metal-hammer. This way it does not need to have an admin token for token creation.</p></td>
</tr>

<tr>
<td>SuperUserPassword</td>
<td><a href="#metalstack.infra.v2.BootServiceSuperUserPasswordRequest">BootServiceSuperUserPasswordRequest</a></td>
Expand Down
Loading
Loading