Skip to content

Commit 35d0deb

Browse files
committed
Add vpn-service
1 parent 6a87eda commit 35d0deb

File tree

20 files changed

+1087
-43
lines changed

20 files changed

+1087
-43
lines changed

doc/index.html

Lines changed: 134 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1922,6 +1922,29 @@ <h2>Table of Contents</h2>
19221922
</li>
19231923

19241924

1925+
<li>
1926+
<a href="#metalstack%2fapi%2fv2%2fvpn.proto">metalstack/api/v2/vpn.proto</a>
1927+
<ul>
1928+
1929+
<li>
1930+
<a href="#metalstack.api.v2.VPNServiceAuthkeyRequest"><span class="badge">M</span>VPNServiceAuthkeyRequest</a>
1931+
</li>
1932+
1933+
<li>
1934+
<a href="#metalstack.api.v2.VPNServiceAuthkeyResponse"><span class="badge">M</span>VPNServiceAuthkeyResponse</a>
1935+
</li>
1936+
1937+
1938+
1939+
1940+
<li>
1941+
<a href="#metalstack.api.v2.VPNService"><span class="badge">S</span>VPNService</a>
1942+
</li>
1943+
1944+
</ul>
1945+
</li>
1946+
1947+
19251948
<li>
19261949
<a href="#metalstack%2finfra%2fv2%2fbmc.proto">metalstack/infra/v2/bmc.proto</a>
19271950
<ul>
@@ -8573,9 +8596,14 @@ <h3 id="metalstack.api.v2.MachineVPN">MachineVPN</h3>
85738596
<td>connected</td>
85748597
<td><a href="#bool">bool</a></td>
85758598
<td></td>
8576-
<td><p>Connected indicate if this machine is connected to the VPN
8577-
8578-
TODO add machine ips </p></td>
8599+
<td><p>Connected indicate if this machine is connected to the VPN </p></td>
8600+
</tr>
8601+
8602+
<tr>
8603+
<td>ips</td>
8604+
<td><a href="#string">string</a></td>
8605+
<td>repeated</td>
8606+
<td><p>IPs of the machine connected to the vpn </p></td>
85798607
</tr>
85808608

85818609
</tbody>
@@ -15263,6 +15291,109 @@ <h3 id="metalstack.api.v2.VersionService">VersionService</h3>
1526315291

1526415292

1526515293

15294+
<div class="file-heading">
15295+
<h2 id="metalstack/api/v2/vpn.proto">metalstack/api/v2/vpn.proto</h2><a href="#title">Top</a>
15296+
</div>
15297+
<p></p>
15298+
15299+
15300+
<h3 id="metalstack.api.v2.VPNServiceAuthkeyRequest">VPNServiceAuthkeyRequest</h3>
15301+
<p>VPNServiceAuthkeyRequest is the request payload for a vpn authkey request.</p>
15302+
15303+
15304+
<table class="field-table">
15305+
<thead>
15306+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15307+
</thead>
15308+
<tbody>
15309+
15310+
<tr>
15311+
<td>project</td>
15312+
<td><a href="#string">string</a></td>
15313+
<td></td>
15314+
<td><p>Project for which a vpn authkey should be generated. </p></td>
15315+
</tr>
15316+
15317+
<tr>
15318+
<td>ephemeral</td>
15319+
<td><a href="#bool">bool</a></td>
15320+
<td></td>
15321+
<td><p>Ephemeral defines if the authkey should be ephemeral. </p></td>
15322+
</tr>
15323+
15324+
<tr>
15325+
<td>expires</td>
15326+
<td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
15327+
<td></td>
15328+
<td><p>Expires defines the duration after which the authkey expires. </p></td>
15329+
</tr>
15330+
15331+
</tbody>
15332+
</table>
15333+
15334+
15335+
15336+
15337+
15338+
<h3 id="metalstack.api.v2.VPNServiceAuthkeyResponse">VPNServiceAuthkeyResponse</h3>
15339+
<p>VPNServiceAuthkeyResponse is the request payload for a authkey response</p>
15340+
15341+
15342+
<table class="field-table">
15343+
<thead>
15344+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
15345+
</thead>
15346+
<tbody>
15347+
15348+
<tr>
15349+
<td>address</td>
15350+
<td><a href="#string">string</a></td>
15351+
<td></td>
15352+
<td><p>Address is the address of the vpn control plane. </p></td>
15353+
</tr>
15354+
15355+
<tr>
15356+
<td>authkey</td>
15357+
<td><a href="#string">string</a></td>
15358+
<td></td>
15359+
<td><p>Authkey is the key to connect to the vpn at the given address.
15360+
This key can only be seen once. </p></td>
15361+
</tr>
15362+
15363+
</tbody>
15364+
</table>
15365+
15366+
15367+
15368+
15369+
15370+
15371+
15372+
15373+
15374+
15375+
15376+
<h3 id="metalstack.api.v2.VPNService">VPNService</h3>
15377+
<p>VPNService serves vpn related functions</p>
15378+
<table class="enum-table">
15379+
<thead>
15380+
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
15381+
</thead>
15382+
<tbody>
15383+
15384+
<tr>
15385+
<td>Authkey</td>
15386+
<td><a href="#metalstack.api.v2.VPNServiceAuthkeyRequest">VPNServiceAuthkeyRequest</a></td>
15387+
<td><a href="#metalstack.api.v2.VPNServiceAuthkeyResponse">VPNServiceAuthkeyResponse</a></td>
15388+
<td><p>AuthKey generates a authkey for a project to join a machine to the project vpn</p></td>
15389+
</tr>
15390+
15391+
</tbody>
15392+
</table>
15393+
15394+
15395+
15396+
1526615397
<div class="file-heading">
1526715398
<h2 id="metalstack/infra/v2/bmc.proto">metalstack/infra/v2/bmc.proto</h2><a href="#title">Top</a>
1526815399
</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/apiv2connect/vpn.connect.go

Lines changed: 114 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)