Skip to content

Commit

Permalink
Store entrypoint in JSON dump
Browse files Browse the repository at this point in the history
Use it during cleanup
Release beta version
  • Loading branch information
dormant-user committed Sep 26, 2023
1 parent 695e05b commit 137f61f
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 49 deletions.
10 changes: 4 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,11 @@ <h1>Welcome to VPN Server’s documentation!<a class="headerlink" href="#welcome

<dl class="py method">
<dt class="sig sig-object py" id="vpn.main.VPNServer._configure_vpn">
<span class="sig-name descname"><span class="pre">_configure_vpn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_dns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#vpn.main.VPNServer._configure_vpn" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">_configure_vpn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_dns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#vpn.main.VPNServer._configure_vpn" title="Permalink to this definition"></a></dt>
<dd><p>Configures the ec2 instance to take traffic from localhost and initiates tunneling.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>public_dns</strong> – Public DNS name of the ec2 that was created.</p></li>
<li><p><strong>public_ip</strong> – IP address of the ec2 instance.</p></li>
</ul>
<dd class="field-odd"><p><strong>public_dns</strong> – Public DNS name of the ec2 that was created.</p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -315,13 +312,14 @@ <h1>Welcome to VPN Server’s documentation!<a class="headerlink" href="#welcome

<dl class="py method">
<dt class="sig sig-object py" id="vpn.main.VPNServer.delete_vpn_server">
<span class="sig-name descname"><span class="pre">delete_vpn_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">security_group_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#vpn.main.VPNServer.delete_vpn_server" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">delete_vpn_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">security_group_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entrypoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#vpn.main.VPNServer.delete_vpn_server" title="Permalink to this definition"></a></dt>
<dd><p>Disables tunnelling by removing all AWS resources acquired.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>instance_id</strong> – Instance that has to be terminated.</p></li>
<li><p><strong>security_group_id</strong> – Security group that has to be removed.</p></li>
<li><p><strong>entrypoint</strong> – A record that has to be deleted from route53.</p></li>
<li><p><strong>public_ip</strong> – Public IP address to delete the A record from route53.</p></li>
</ul>
</dd>
Expand Down
Loading

0 comments on commit 137f61f

Please sign in to comment.