Skip to content

Commit

Permalink
Deployed 20658cf to develop with MkDocs 1.4.2 and mike 1.2.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 13, 2025
1 parent daaf7cd commit 2a77cb7
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 10 deletions.
40 changes: 31 additions & 9 deletions develop/reference/configuration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ <h2 id="config">Config</h2>
<span class="w"> </span><span class="nt">schematicEndpoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/schematics</span>
<span class="w"> </span><span class="nt">protocol</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https</span>
<span class="w"> </span><span class="nt">installerURLTmpl</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{{</span><span class="nv">.RegistryURL</span><span class="p p-Indicator">}}</span><span class="l l-Scalar l-Scalar-Plain">/installer/{{.ID}}:{{.Version}}</span>
<span class="w"> </span><span class="nt">ISOURLTmpl</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{{</span><span class="nv">.Protocol</span><span class="p p-Indicator">}}</span><span class="l l-Scalar l-Scalar-Plain">://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}/{{.Arch}}.iso</span>
<span class="w"> </span><span class="nt">ImageURLTmpl</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{{</span><span class="nv">.Protocol</span><span class="p p-Indicator">}}</span><span class="l l-Scalar l-Scalar-Plain">://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}/{{.Arch}}.iso</span>
</code></pre></div>
</details></td>
<td align="center"><code>nil</code></td>
Expand Down Expand Up @@ -497,10 +497,12 @@ <h2 id="nodeconfigs">NodeConfigs</h2>
<tr>
<td><code>machineSpec</code></td>
<td><a href="#machinespec">MachineSpec</a></td>
<td><details><summary>Machine hardware specification for the node.</summary>Only used for <code>genurl iso</code> subcommand.</details><details><summary><em>Show example</em></summary>
<td><details><summary>Machine hardware specification for the node.</summary>Only used for <code>genurl image</code> subcommand.</details><details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">machineSpec</span><span class="p">:</span>
<span class="w"> </span><span class="nt">mode</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">metal</span>
<span class="w"> </span><span class="nt">arch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arm64</span>
<span class="w"> </span><span class="nt">bootMethod</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">disk-image</span>
<span class="w"> </span><span class="nt">imageSuffix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">raw.xz</span>
</code></pre></div>
</summary></td>
<td align="center"><code>nil</code></td>
Expand Down Expand Up @@ -662,10 +664,10 @@ <h2 id="nodeconfigs">NodeConfigs</h2>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
<tr>
<td><code>isoSchematic</code></td>
<td><code>imageSchematic</code></td>
<td><a href="#schematic">Schematic</a></td>
<td>Configure Talos image customization to be used for ISO image<details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">isoSchematic</span><span class="p">:</span>
<td>Configure Talos image customization to be used for ISO or boot image<details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">imageSchematic</span><span class="p">:</span>
<span class="w"> </span><span class="nt">customization</span><span class="p">:</span>
<span class="w"> </span><span class="nt">extraKernelArgs</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">net.ifnames=0</span>
Expand Down Expand Up @@ -801,13 +803,13 @@ <h2 id="imagefactory">ImageFactory</h2>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
<tr>
<td><code>ISOURLTmpl</code></td>
<td><code>ImageURLTmpl</code></td>
<td>string</td>
<td><details><summary>Go template to parse the full ISO image URL.</summary>Available placeholders: <code>Protocol</code>,<code>RegistryURL</code>,<code>ID</code>,<code>Version</code>,<code>Mode</code>,<code>Arch</code>, <code>Secureboot</code>, <code>UseUKI</code></details><details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">ISOURLTmpl</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso&quot;</span>
<td><details><summary>Go template to parse the full ISO or boot image URL.</summary>Available placeholders: <code>Protocol</code>,<code>RegistryURL</code>,<code>ID</code>,<code>Version</code>,<code>Mode</code>,<code>Arch</code>, <code>Secureboot</code>, <code>UseUKI</code>, <code>BootMethod</code>, <code>Suffix</code></details><details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">ImageURLTmpl</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}.iso&quot;</span>
</code></pre></div>
</summary></td>
<td align="center"><code>{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}.iso{{end}}</code></td>
<td align="center"><code>{{.Protocol}}://{{.RegistryURL}}/image/{{.ID}}/{{.Version}}/{{.Mode}}-{{.Arch}}{{if .Secureboot}}-secureboot{{end}}{{if and .Secureboot .UseUKI}}-uki.efi{{else}}{{.Suffix}}{{end}}</code></td>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
</table>
Expand Down Expand Up @@ -858,6 +860,26 @@ <h2 id="machinespec">MachineSpec</h2>
<td align="center"><code>false</code></td>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
<tr>
<td><code>bootMethod</code></td>
<td>string</td>
<td><details><summary>Boot method for the node.</summary>Can be "disk-image", "iso" or "pxe".</details><details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">bootMethod</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">disk-image</span>
</code></pre></div>
</summary></td>
<td align="center"><code>iso</code></td>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
<tr>
<td><code>imageSuffix</code></td>
<td>string</td>
<td><details><summary>The image file extension.</summary>Will be automatically defined by specified <code>bootMethod</code>, e.g: <code>raw.xz</code>, <code>raw.tar.gz</code>, <code>qcow2</code>.</details><details><summary><em>Show example</em></summary>
<div class="highlight"><pre><span></span><code><span class="nt">imageSuffix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">raw.xz</span>
</code></pre></div>
</summary></td>
<td align="center"><code>""</code></td>
<td align="center"><img align="center" alt="❎" class="emojione" height="20px" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/274e.png" title=":negative_squared_cross_mark:" width="20px" /></td>
</tr>
</table>
<h2 id="ingressfirewall">IngressFirewall</h2>
<p><code>IngressFirewall</code> defines machine firewall configuration for a node.</p>
Expand Down
2 changes: 1 addition & 1 deletion develop/search/search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit 2a77cb7

Please sign in to comment.