Skip to content

Commit

Permalink
Deployed 4e6be6c to alpha-3 with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
HHDocs committed Jan 24, 2024
1 parent beb01fd commit 47a8204
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 32 deletions.
12 changes: 8 additions & 4 deletions alpha-3/getting-started/download/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1226,14 +1226,18 @@ <h2 id="getting-access">Getting access</h2>
<h2 id="downloading-the-software">Downloading the software</h2>
<p>The main entry point for the software is the Hedgehog Fabricator CLI named <code>hhfab</code>. All software is published into the
OCI registry <a href="https://ghcr.io">GitHub Package</a> including binaries, container images, helm charts and etc.
The <code>hhfab</code> binary can be downloaded from the <a href="https://ghcr.io">GitHub Package</a> using the following command:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://i.hhdev.io/hhfab<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nv">VERSION</span><span class="o">=</span>alpha-2<span class="w"> </span>bash
The latest stable <code>hhfab</code> binary can be downloaded from the <a href="https://ghcr.io">GitHub Package</a> using the following
command:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://i.hhdev.io/hhfab<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
</span></code></pre></div>
<p>Or you can download a specific version using the following command:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://i.hhdev.io/hhfab<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nv">VERSION</span><span class="o">=</span>alpha-X<span class="w"> </span>bash
</span></code></pre></div>
<p>The <code>VERSION</code> environment variable can be used to specify the version of the software to download. If it's not specified
the latest release will be downloaded. You can pick specific release series (e.g. <code>alpha-2</code>) or specific release.</p>
<p>It requires <a href="https://oras.land/">ORAS</a> to be installed which is used to download the binary from the OCI registry and
could be installed using following command:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://i.hhdev.io/oras<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://i.hhdev.io/oras<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
</span></code></pre></div>
<p>Currently only Linux x86 is supported for running <code>hhfab</code>.</p>
<h2 id="next-steps">Next steps</h2>
Expand All @@ -1249,7 +1253,7 @@ <h2 id="next-steps">Next steps</h2>
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 22, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 24, 2024</span>

<br>
Created:
Expand Down
2 changes: 1 addition & 1 deletion alpha-3/search/search_index.json
View file

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions alpha-3/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,132 +2,132 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.githedgehog.com/alpha-3/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/architecture/fabric/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/architecture/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/concepts/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/contribute/docs/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/contribute/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/getting-started/download/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/build-wiring/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/config/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/onie-update/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/requirements/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/install-upgrade/supported-devices/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/reference/api/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/reference/cli/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/release-notes/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/troubleshooting/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/connections/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/devices/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/external/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/harvester/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/user-guide/vpcs/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/vlab/demo/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/vlab/overview/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.githedgehog.com/alpha-3/vlab/running/</loc>
<lastmod>2024-01-22</lastmod>
<lastmod>2024-01-24</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified alpha-3/sitemap.xml.gz
View file
Binary file not shown.
10 changes: 9 additions & 1 deletion alpha-3/user-guide/vpcs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1272,6 +1272,14 @@ <h2 id="vpc"><abbr title="Virtual Private Cloud, similar to the public cloud VPC
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="w"> </span><span class="nt">subnet</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.10.100.0/24</span>
</span><span id="__span-0-24"><a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a><span class="w"> </span><span class="nt">vlan</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;1100&quot;</span>
</span></code></pre></div>
<p>In case if you're using thirt-party DHCP server by configuring <code>spec.subnets.&lt;subnet&gt;.dhcp.relay</code> additional information
will be added to the DHCP packet it forwards to the DHCP server to make it possible to identify the <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> and subnet. The
information is added under the RelayAgentInfo option(82) on the DHCP packet. The relay sets two suboptions in the packet</p>
<ul>
<li>VirtualSubnetSelection -- (suboption 151) is populated with the VRF which uniquely idenitifies a <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> on the Hedgehog
Fabric and will be in <code>VrfV&lt;VPC-name&gt;</code> format, e.g. <code>VrfVvpc-1</code> for <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> named <code>vpc-1</code> in the Fabric API</li>
<li>CircuitID -- (suboption 1) identifies the VLAN which together with VRF (<abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr>) name maps to a specific <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> subnet</li>
</ul>
<h2 id="vpcattachment"><abbr title="Represents a specific VPC subnet assignemnt to the Connection object which means exact server port to a VPC binding">VPCAttachment</abbr></h2>
<p>Represents a specific <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> subnet assignemnt to the <code>Connection</code> object which means exact server port to a <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> binding.
It basically leads to the <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> being available on the specific server port(s) on a subnet VLAN.</p>
Expand Down Expand Up @@ -1345,7 +1353,7 @@ <h2 id="vlannamespace">VLANNamespace</h2>
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 22, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 24, 2024</span>

<br>
Created:
Expand Down

1 comment on commit 47a8204

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Published on https://docs.githedgehog.com as production
🚀 Deployed on https://65b1486b004c1c2378d9f07e--hedgehog-docs.netlify.app

Please sign in to comment.