@@ -1782,6 +1782,29 @@ <h2>Table of Contents</h2>
17821782 </li>
17831783
17841784
1785+ <li>
1786+ <a href="#metalstack%2fadmin%2fv2%2fvpn.proto">metalstack/admin/v2/vpn.proto</a>
1787+ <ul>
1788+
1789+ <li>
1790+ <a href="#metalstack.admin.v2.VPNServiceAuthkeyRequest"><span class="badge">M</span>VPNServiceAuthkeyRequest</a>
1791+ </li>
1792+
1793+ <li>
1794+ <a href="#metalstack.admin.v2.VPNServiceAuthkeyResponse"><span class="badge">M</span>VPNServiceAuthkeyResponse</a>
1795+ </li>
1796+
1797+
1798+
1799+
1800+ <li>
1801+ <a href="#metalstack.admin.v2.VPNService"><span class="badge">S</span>VPNService</a>
1802+ </li>
1803+
1804+ </ul>
1805+ </li>
1806+
1807+
17851808 <li>
17861809 <a href="#metalstack%2fapi%2fv2%2fhealth.proto">metalstack/api/v2/health.proto</a>
17871810 <ul>
@@ -1922,29 +1945,6 @@ <h2>Table of Contents</h2>
19221945 </li>
19231946
19241947
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-
19481948 <li>
19491949 <a href="#metalstack%2finfra%2fv2%2fbmc.proto">metalstack/infra/v2/bmc.proto</a>
19501950 <ul>
@@ -14577,6 +14577,109 @@ <h3 id="metalstack.admin.v2.TokenService">TokenService</h3>
1457714577
1457814578
1457914579
14580+ <div class="file-heading">
14581+ <h2 id="metalstack/admin/v2/vpn.proto">metalstack/admin/v2/vpn.proto</h2><a href="#title">Top</a>
14582+ </div>
14583+ <p></p>
14584+
14585+
14586+ <h3 id="metalstack.admin.v2.VPNServiceAuthkeyRequest">VPNServiceAuthkeyRequest</h3>
14587+ <p>VPNServiceAuthkeyRequest is the request payload for a vpn authkey request.</p>
14588+
14589+
14590+ <table class="field-table">
14591+ <thead>
14592+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
14593+ </thead>
14594+ <tbody>
14595+
14596+ <tr>
14597+ <td>project</td>
14598+ <td><a href="#string">string</a></td>
14599+ <td></td>
14600+ <td><p>Project for which a vpn authkey should be generated. </p></td>
14601+ </tr>
14602+
14603+ <tr>
14604+ <td>ephemeral</td>
14605+ <td><a href="#bool">bool</a></td>
14606+ <td></td>
14607+ <td><p>Ephemeral defines if the authkey should be ephemeral. </p></td>
14608+ </tr>
14609+
14610+ <tr>
14611+ <td>expires</td>
14612+ <td><a href="#google.protobuf.Duration">google.protobuf.Duration</a></td>
14613+ <td></td>
14614+ <td><p>Expires defines the duration after which the authkey expires. </p></td>
14615+ </tr>
14616+
14617+ </tbody>
14618+ </table>
14619+
14620+
14621+
14622+
14623+
14624+ <h3 id="metalstack.admin.v2.VPNServiceAuthkeyResponse">VPNServiceAuthkeyResponse</h3>
14625+ <p>VPNServiceAuthkeyResponse is the request payload for a authkey response</p>
14626+
14627+
14628+ <table class="field-table">
14629+ <thead>
14630+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
14631+ </thead>
14632+ <tbody>
14633+
14634+ <tr>
14635+ <td>address</td>
14636+ <td><a href="#string">string</a></td>
14637+ <td></td>
14638+ <td><p>Address is the address of the vpn control plane. </p></td>
14639+ </tr>
14640+
14641+ <tr>
14642+ <td>authkey</td>
14643+ <td><a href="#string">string</a></td>
14644+ <td></td>
14645+ <td><p>Authkey is the key to connect to the vpn at the given address.
14646+ This key can only be seen once. </p></td>
14647+ </tr>
14648+
14649+ </tbody>
14650+ </table>
14651+
14652+
14653+
14654+
14655+
14656+
14657+
14658+
14659+
14660+
14661+
14662+ <h3 id="metalstack.admin.v2.VPNService">VPNService</h3>
14663+ <p>VPNService serves vpn related functions</p>
14664+ <table class="enum-table">
14665+ <thead>
14666+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
14667+ </thead>
14668+ <tbody>
14669+
14670+ <tr>
14671+ <td>Authkey</td>
14672+ <td><a href="#metalstack.admin.v2.VPNServiceAuthkeyRequest">VPNServiceAuthkeyRequest</a></td>
14673+ <td><a href="#metalstack.admin.v2.VPNServiceAuthkeyResponse">VPNServiceAuthkeyResponse</a></td>
14674+ <td><p>AuthKey generates a authkey for a project to join a machine to the project vpn</p></td>
14675+ </tr>
14676+
14677+ </tbody>
14678+ </table>
14679+
14680+
14681+
14682+
1458014683 <div class="file-heading">
1458114684 <h2 id="metalstack/api/v2/health.proto">metalstack/api/v2/health.proto</h2><a href="#title">Top</a>
1458214685 </div>
@@ -15291,109 +15394,6 @@ <h3 id="metalstack.api.v2.VersionService">VersionService</h3>
1529115394
1529215395
1529315396
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-
1539715397 <div class="file-heading">
1539815398 <h2 id="metalstack/infra/v2/bmc.proto">metalstack/infra/v2/bmc.proto</h2><a href="#title">Top</a>
1539915399 </div>
0 commit comments