Skip to content

Commit

Permalink
Deployed a40c434 to dev 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 Dec 2, 2024
1 parent c53b7fa commit 9855ff0
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 31 deletions.
31 changes: 16 additions & 15 deletions dev/reference/cli/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1271,26 +1271,27 @@ <h1 id="fabric-cli">Fabric CLI</h1>
be done using <code>kubectl</code>.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>core@control-1<span class="w"> </span>~<span class="w"> </span>$<span class="w"> </span>kubectl<span class="w"> </span>fabric
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>NAME:
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span>hhfctl<span class="w"> </span>-<span class="w"> </span>Hedgehog<span class="w"> </span>Fabric<span class="w"> </span>user<span class="w"> </span>client
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span>kubectl<span class="w"> </span>fabric<span class="w"> </span>-<span class="w"> </span>Hedgehog<span class="w"> </span>Fabric<span class="w"> </span>API<span class="w"> </span>kubectl<span class="w"> </span>plugin
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>USAGE:
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span>hhfctl<span class="w"> </span><span class="o">[</span>global<span class="w"> </span>options<span class="o">]</span><span class="w"> </span><span class="nb">command</span><span class="w"> </span><span class="o">[</span><span class="nb">command</span><span class="w"> </span>options<span class="o">]</span><span class="w"> </span><span class="o">[</span>arguments...<span class="o">]</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span>kubectl<span class="w"> </span>fabric<span class="w"> </span><span class="o">[</span>global<span class="w"> </span>options<span class="o">]</span><span class="w"> </span><span class="nb">command</span><span class="w"> </span><span class="o">[</span><span class="nb">command</span><span class="w"> </span>options<span class="o">]</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>VERSION:
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span>v0.23.0
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span>v0.53.1
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>COMMANDS:
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span>vpc<span class="w"> </span>VPC<span class="w"> </span>commands
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span>switch,<span class="w"> </span>sw,<span class="w"> </span>agent<span class="w"> </span>Switch/Agent<span class="w"> </span>commands
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w"> </span>connection,<span class="w"> </span>conn<span class="w"> </span>Connection<span class="w"> </span>commands
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w"> </span>switchgroup,<span class="w"> </span>sg<span class="w"> </span>SwitchGroup<span class="w"> </span>commands
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w"> </span>external<span class="w"> </span>External<span class="w"> </span>commands
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span>help,<span class="w"> </span>h<span class="w"> </span>Shows<span class="w"> </span>a<span class="w"> </span>list<span class="w"> </span>of<span class="w"> </span>commands<span class="w"> </span>or<span class="w"> </span><span class="nb">help</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>one<span class="w"> </span><span class="nb">command</span>
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>GLOBAL<span class="w"> </span>OPTIONS:
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="w"> </span>--verbose,<span class="w"> </span>-v<span class="w"> </span>verbose<span class="w"> </span>output<span class="w"> </span><span class="o">(</span>includes<span class="w"> </span>debug<span class="o">)</span><span class="w"> </span><span class="o">(</span>default:<span class="w"> </span><span class="nb">true</span><span class="o">)</span>
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="w"> </span>--help,<span class="w"> </span>-h<span class="w"> </span>show<span class="w"> </span><span class="nb">help</span>
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="w"> </span>--version,<span class="w"> </span>-V<span class="w"> </span>print<span class="w"> </span>the<span class="w"> </span>version
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span>vpc<span class="w"> </span>VPC<span class="w"> </span>commands
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span>switch,<span class="w"> </span>sw<span class="w"> </span>Switch<span class="w"> </span>commands
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="w"> </span>connection,<span class="w"> </span>conn<span class="w"> </span>Connection<span class="w"> </span>commands
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w"> </span>switchgroup,<span class="w"> </span>sg<span class="w"> </span>SwitchGroup<span class="w"> </span>commands
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w"> </span>external,<span class="w"> </span>ext<span class="w"> </span>External<span class="w"> </span>commands
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span>inspect,<span class="w"> </span>i<span class="w"> </span>Inspect<span class="w"> </span>Fabric<span class="w"> </span>API<span class="w"> </span>Objects<span class="w"> </span>and<span class="w"> </span>Primitives
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w"> </span>help,<span class="w"> </span>h<span class="w"> </span>Shows<span class="w"> </span>a<span class="w"> </span>list<span class="w"> </span>of<span class="w"> </span>commands<span class="w"> </span>or<span class="w"> </span><span class="nb">help</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>one<span class="w"> </span><span class="nb">command</span>
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>GLOBAL<span class="w"> </span>OPTIONS:
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="w"> </span>--verbose,<span class="w"> </span>-v<span class="w"> </span>verbose<span class="w"> </span>output<span class="w"> </span><span class="o">(</span>includes<span class="w"> </span>debug<span class="o">)</span><span class="w"> </span><span class="o">(</span>default:<span class="w"> </span><span class="nb">true</span><span class="o">)</span>
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="w"> </span>--help,<span class="w"> </span>-h<span class="w"> </span>show<span class="w"> </span><span class="nb">help</span>
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="w"> </span>--version,<span class="w"> </span>-V<span class="w"> </span>print<span class="w"> </span>the<span class="w"> </span>version
</span></code></pre></div>
<h2 id="vpc"><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></h2>
<p>Create <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> with subnet <code>10.0.1.0/24</code> and VLAN <code>1001</code> with DHCP enabled and DHCP range starting from
Expand All @@ -1310,7 +1311,7 @@ <h2 id="vpc"><abbr title="Virtual Private Cloud, similar to the public cloud VPC
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 8, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 2, 2024</span>

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

Large diffs are not rendered by default.

Binary file modified dev/sitemap.xml.gz
View file
Binary file not shown.
28 changes: 17 additions & 11 deletions dev/user-guide/external/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1659,17 +1659,23 @@ <h2 id="examples">Examples</h2>
<code>vpc-1</code> is required to receive any prefixes advertised from the <code>External</code>.</p>
<h3 id="fabric-api-configuration">Fabric API configuration</h3>
<h4 id="external_1"><abbr title="Definition of the &quot;external system&quot; to peer with (could be one or multiple devices such as edge/provider routers)">External</abbr></h4>
<div class="language-console highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="gp"># </span>hhfctl<span class="w"> </span>external<span class="w"> </span>create<span class="w"> </span>--name<span class="w"> </span>HedgeEdge<span class="w"> </span>--ipns<span class="w"> </span>default<span class="w"> </span>--in<span class="w"> </span><span class="m">65102</span>:5000<span class="w"> </span>--out<span class="w"> </span><span class="m">5000</span>:65102
<div class="language-console highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="gp"># </span>kubectl<span class="w"> </span>fabric<span class="w"> </span>external<span class="w"> </span>create<span class="w"> </span>--name<span class="w"> </span>hedgeedge<span class="w"> </span>--ipns<span class="w"> </span>default<span class="w"> </span>--in<span class="w"> </span><span class="m">65102</span>:5000<span class="w"> </span>--out<span class="w"> </span><span class="m">5000</span>:65102
</span></code></pre></div>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vpc.githedgehog.com/v1beta1</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">External</span>
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="nt">metadata</span><span class="p">:</span>
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">HedgeEdge</span>
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="nt">spec</span><span class="p">:</span>
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span><span class="nt">inboundCommunity</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">65102:5000</span>
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span><span class="nt">ipv4Namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span><span class="nt">outboundCommunity</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5000:65102</span>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vpc.githedgehog.com/v1beta1</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">External</span>
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">creationTimestamp</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2024-11-26T21:24:32Z&quot;</span>
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">generation</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="w"> </span><span class="nt">fabric.githedgehog.com/ipv4ns</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">hedgeedge</span>
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span><span class="nt">resourceVersion</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;57628&quot;</span>
</span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="w"> </span><span class="nt">uid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a0662988-73d0-45b3-afc0-0d009cd91ebd</span>
</span><span id="__span-7-12"><a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a><span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
</span><span id="__span-7-13"><a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a><span class="w"> </span><span class="nt">inboundCommunity</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">65102:5000</span>
</span><span id="__span-7-14"><a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a><span class="w"> </span><span class="nt">ipv4Namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
</span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a><span class="w"> </span><span class="nt">outboundCommunity</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5000:6510</span>
</span></code></pre></div>
<h4 id="connection_1">Connection</h4>
<p>Connection should be specified in the <code>wiring</code> diagram.</p>
Expand Down Expand Up @@ -1769,7 +1775,7 @@ <h3 id="example-edge-side-bgp-configuration-based-on-sonic-os">Example Edge side
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 23, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 2, 2024</span>

<br>
Created:
Expand Down
4 changes: 2 additions & 2 deletions dev/user-guide/shrink-expand/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1282,7 +1282,7 @@ <h1 id="fabric-shrinkexpand">Fabric Shrink/Expand</h1>
Guide</a> documentation, and the <a href="../../reference/api/">Fabric API</a> reference.</p>
<h3 id="add-a-switch-to-the-existing-fabric">Add a switch to the existing fabric</h3>
<p>In order to be added to the Hedgehog Fabric, a switch should have a corresponding <code>Switch</code> object. An example on how to define
this object is available in the <a href="../devices/">User Guild</a>.</p>
this object is available in the <a href="../devices/">User Guide</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the<code>Switch</code> will be used in <code>ESLAG</code> or <code>MCLAG</code> groups, appropriate groups should exist. Redundancy groups should
Expand Down Expand Up @@ -1318,7 +1318,7 @@ <h3 id="remove-a-switch-from-the-existing-fabric">Remove a switch from the exist
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 23, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 2, 2024</span>

<br>
Created:
Expand Down
Loading

1 comment on commit 9855ff0

@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://674e114c96a2c02ee9ddfe12--hedgehog-docs.netlify.app

Please sign in to comment.