peter/infix
1
0
Fork 0
mirror of https://github.com/kernelkit/infix.git synced 2026-08-06 07:33:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Deployed f91aa0b7 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-10-10 14:26:03 +00:00
parent 71f0384bfa
commit 6234cb10e6
54 changed files with 6088 additions and 2183 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/developers-guide/index.html
+93 -58
View File
@@ -1,7 +1,4 @@
<!doctype html>
<html lang="en" class="no-js">
<head>
<!DOCTYPE html><html lang="en" class="no-js"><head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
@@ -45,7 +42,7 @@
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
@@ -59,7 +56,18 @@
</head>
<link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"><script src="../assets/javascripts/glightbox.min.js"></script><style id="glightbox-style">
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: black; }
.glightbox-clean .gslide-media { -webkit-box-shadow: none; box-shadow: none; }
.gscrollbar-fixer { padding-right: 15px; }
.gdesc-inner { font-size: 0.75rem; }
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color); }
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color); }
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color); }
</style></head>
@@ -98,14 +106,14 @@
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="https://kernelkit.org/" title="User&#39;s Guide" class="md-header__button md-logo" aria-label="User's Guide" data-md-component="logo">
<a href="https://kernelkit.org/" title="User's Guide" class="md-header__button md-logo" aria-label="User's Guide" data-md-component="logo">
<img src="../logo-plain.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
@@ -130,20 +138,20 @@
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="orange" data-md-color-accent="orange" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="orange" data-md-color-accent="orange" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"></path></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"></path></svg>
</label>
@@ -159,7 +167,7 @@
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
@@ -168,20 +176,20 @@
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"></path></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg>
</button>
</nav>
@@ -205,7 +213,7 @@
<a href="https://github.com/kernelkit/infix/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"></path></svg>
</div>
<div class="md-source__repository">
kernelkit/infix
@@ -229,7 +237,7 @@
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
@@ -238,7 +246,7 @@
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://kernelkit.org/" title="User&#39;s Guide" class="md-nav__button md-logo" aria-label="User's Guide" data-md-component="logo">
<a href="https://kernelkit.org/" title="User's Guide" class="md-nav__button md-logo" aria-label="User's Guide" data-md-component="logo">
<img src="../logo-plain.png" alt="logo">
@@ -250,7 +258,7 @@
<a href="https://github.com/kernelkit/infix/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"></path></svg>
</div>
<div class="md-source__repository">
kernelkit/infix
@@ -315,7 +323,7 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
@@ -567,6 +575,8 @@
@@ -578,7 +588,7 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
@@ -630,6 +640,29 @@
<li class="md-nav__item">
<a href="../firewall/" class="md-nav__link">
<span class="md-ellipsis">
Firewall Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../qos/" class="md-nav__link">
@@ -744,7 +777,7 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
@@ -849,7 +882,7 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
@@ -930,7 +963,7 @@
<span class="md-ellipsis">
Hardware Info & Status
Hardware Info &amp; Status
</span>
@@ -1044,7 +1077,7 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
@@ -1259,7 +1292,7 @@
<span class="md-ellipsis">
Branding & Releases
Branding &amp; Releases
</span>
@@ -1717,7 +1750,7 @@
<span class="md-ellipsis">
Origin & Licensing
Origin &amp; Licensing
</span>
@@ -1735,7 +1768,7 @@
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
@@ -1997,7 +2030,7 @@
<h1 id="developers-guide">Developer's Guide<a class="headerlink" href="#developers-guide" title="Permanent link">&para;</a></h1>
<h1 id="developers-guide">Developer's Guide<a class="headerlink" href="#developers-guide" title="Permanent link"></a></h1>
<p>Please note, by default the <code>root</code> account is disabled in Infix NETCONF
builds. Meaning, the only way to access the system is with the <code>admin</code>
account, which is created based on credentials found in the VPD area --
@@ -2014,7 +2047,7 @@ the Buildroot <code>make menuconfig</code> system.</p>
<p>Please see the <a href="#contributing">Contributing</a> section, below, for
details on how to fork and clone when contributing to Infix.</p>
</div>
<h2 id="cloning">Cloning<a class="headerlink" href="#cloning" title="Permanent link">&para;</a></h2>
<h2 id="cloning">Cloning<a class="headerlink" href="#cloning" title="Permanent link"></a></h2>
<p>When <a href="https://github.com/kernelkit/infix/releases">pre-built releases</a> are not enough, for instance when you want
to add or modify some Open Source components, you can clone the Infix
tree to your PC:</p>
@@ -2025,7 +2058,7 @@ tree to your PC:</p>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>$<span class="w"> </span>git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>..
</code></pre></div>
<h3 id="customer-builds">Customer Builds<a class="headerlink" href="#customer-builds" title="Permanent link">&para;</a></h3>
<h3 id="customer-builds">Customer Builds<a class="headerlink" href="#customer-builds" title="Permanent link"></a></h3>
<p>Customer builds add product specific device trees, more OSS packages,
e.g., Frr and podman, and sometimes integrates proprietary software.
What's <em>important to remember</em>, however, is that they are all made by
@@ -2039,7 +2072,7 @@ up with a broken build.</p>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span>~~~~~~~~~~~
</code></pre></div>
<p>Other caveats should be documented in the customer specific trees.</p>
<h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link">&para;</a></h2>
<h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link"></a></h2>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>For more details, see the Getting Started and System Requirements
@@ -2066,7 +2099,7 @@ make
<p>To see available defconfigs for supported targets, use:</p>
<div class="highlight"><pre><span></span><code>make list-defconfigs
</code></pre></div>
<h3 id="test">Test<a class="headerlink" href="#test" title="Permanent link">&para;</a></h3>
<h3 id="test">Test<a class="headerlink" href="#test" title="Permanent link"></a></h3>
<p>Working with the regression test framework, <em>Infamy</em>, a few more tools
and services are required on your system:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>jq<span class="w"> </span>graphviz<span class="w"> </span>qemu-system-x86<span class="w"> </span>qemu-system-arm<span class="w"> </span><span class="se">\</span>
@@ -2077,7 +2110,7 @@ and services are required on your system:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>$<span class="w"> </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-graphviz<span class="w"> </span>ruby-asciidoctor-pdf
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>..
</code></pre></div>
<h3 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h3>
<h3 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link"></a></h3>
<p>The documentation is written in Markdown, with GitHub extensions, and
published using <a href="https://squidfunk.github.io/mkdocs-material/">MkDocs, material theme</a>. This means some features
require MkDocs <em>hinting</em> which may not render fully when previewing on
@@ -2097,7 +2130,7 @@ have to install all the tooling.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>$ cd ~/src/infix/
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>$ mkdocs serve
</code></pre></div>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h2>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link"></a></h2>
<p>Developing with Infix is the same as <a href="https://buildroot.org/downloads/manual/manual.html#_developer_guide">developing with Buildroot</a>.
When working with a package, be it locally kept sources, or when using
<a href="../override-package/"><code>local.mk</code></a>, you only want to rebuild the parts
@@ -2117,14 +2150,14 @@ go, like this:</p>
<p>This rebuilds (and installs) <code>foo</code> and <code>bar</code>, the <code>all</code> target calls
on Buildroot to finalize the target filesystem and generate the images.
The final <code>run</code> argument is explained below.</p>
<h3 id="yang-model">YANG Model<a class="headerlink" href="#yang-model" title="Permanent link">&para;</a></h3>
<h3 id="yang-model">YANG Model<a class="headerlink" href="#yang-model" title="Permanent link"></a></h3>
<p>When making changes to the <code>confd</code> and <code>statd</code> services, you will often
need to update the YANG models. If you are adding a new YANG module,
it's best to follow the structure of an existing one. However, before
making any changes, <strong>always discuss them with the Infix core team</strong>.
This helps avoid issues later in development and makes pull request
reviews smoother.</p>
<h3 id="confd"><code>confd</code><a class="headerlink" href="#confd" title="Permanent link">&para;</a></h3>
<h3 id="confd"><code>confd</code><a class="headerlink" href="#confd" title="Permanent link"></a></h3>
<p>The Infix <code>src/confd/</code> is the engine of the system. Currently it is a
plugin for <code>systemd-plugind</code> and contains XPath subscriptions to all the
supported YANG models.</p>
@@ -2151,7 +2184,7 @@ this is how you do it:</p>
<p>Now you can rebuild <code>confd</code>, just as described above, and restart Infix:</p>
<div class="highlight"><pre><span></span><code>make confd-rebuild all run
</code></pre></div>
<h3 id="statd"><code>statd</code><a class="headerlink" href="#statd" title="Permanent link">&para;</a></h3>
<h3 id="statd"><code>statd</code><a class="headerlink" href="#statd" title="Permanent link"></a></h3>
<p>The Infix status daemon, <code>src/statd</code>, is responsible for populating the
sysrepo <code>operational</code> datastore. Like <code>confd</code>, it uses XPath subscriptions,
but unlike <code>confd</code>, it relies entirely on <code>yanger</code>, a Python script that
@@ -2163,7 +2196,7 @@ gathers data from local linux services and feeds it into sysrepo.</p>
development process can be tedious. Instead, <code>yanger</code> allows remote
execution, running the script directly on the host system (test
container):</p>
<div class="highlight"><pre><span></span><code>infamy0:test # ../src/statd/python/yanger/yanger -x &quot;../utils/ixll -A ssh d3a&quot; ieee802-dot1ab-lldp
<div class="highlight"><pre><span></span><code>infamy0:test # ../src/statd/python/yanger/yanger -x "../utils/ixll -A ssh d3a" ieee802-dot1ab-lldp
</code></pre></div>
<p><code>ixll</code> is a utility script that lets you run network commands using an
<strong>interface name</strong> instead of a hostname. It makes operations like
@@ -2186,8 +2219,8 @@ replay it later without needing a live system.</p>
</code></pre></div>
<p>This is especially useful when working in isolated environments or debugging
issues without direct access to the DUT.</p>
<h2 id="upgrading-packages">Upgrading Packages<a class="headerlink" href="#upgrading-packages" title="Permanent link">&para;</a></h2>
<h3 id="buildroot">Buildroot<a class="headerlink" href="#buildroot" title="Permanent link">&para;</a></h3>
<h2 id="upgrading-packages">Upgrading Packages<a class="headerlink" href="#upgrading-packages" title="Permanent link"></a></h2>
<h3 id="buildroot">Buildroot<a class="headerlink" href="#buildroot" title="Permanent link"></a></h3>
<p>The Kernelkit team maintains an internal <a href="https://github.com/kernelkit/buildroot">fork of Buildroot</a>, with
branches following the naming scheme <code>YYYY.MM.patch-kkit</code>
e.g. <code>2025.02.1-kkit</code>, which means a new branch should be created
@@ -2201,7 +2234,7 @@ Buildroot LTS available.</p>
<blockquote>
<p><strong>Depending on your setup, follow the appropriate steps below.</strong></p>
</blockquote>
<h4 id="repo-locally-cloned-already">Repo locally cloned already<a class="headerlink" href="#repo-locally-cloned-already" title="Permanent link">&para;</a></h4>
<h4 id="repo-locally-cloned-already">Repo locally cloned already<a class="headerlink" href="#repo-locally-cloned-already" title="Permanent link"></a></h4>
<ol>
<li>
<p>Navigate to the Buildroot directory</p>
@@ -2219,7 +2252,7 @@ Buildroot LTS available.</p>
</code></pre></div>
</li>
</ol>
<h4 id="no-local-repo-yet">No local repo yet<a class="headerlink" href="#no-local-repo-yet" title="Permanent link">&para;</a></h4>
<h4 id="no-local-repo-yet">No local repo yet<a class="headerlink" href="#no-local-repo-yet" title="Permanent link"></a></h4>
<ol>
<li>
<p>Clone the Kernelkit Buildroot repository</p>
@@ -2241,7 +2274,7 @@ Buildroot LTS available.</p>
<p class="admonition-title">Note</p>
<p>Below, it is <strong>not</strong> allowed to rebase the branch when bumped in Infix.</p>
</div>
<h4 id="continue-here">Continue Here<a class="headerlink" href="#continue-here" title="Permanent link">&para;</a></h4>
<h4 id="continue-here">Continue Here<a class="headerlink" href="#continue-here" title="Permanent link"></a></h4>
<ol>
<li>
<p>Create a new branch based on the <strong>previous</strong> KernelKit Buildroot
@@ -2279,7 +2312,7 @@ git checkout 2025.02.2-kkit
<p>Remember to set the pull request label to <code>ci:main</code> to ensure full CI
coverage.</p>
</div>
<h3 id="linux-kernel">Linux kernel<a class="headerlink" href="#linux-kernel" title="Permanent link">&para;</a></h3>
<h3 id="linux-kernel">Linux kernel<a class="headerlink" href="#linux-kernel" title="Permanent link"></a></h3>
<p>The KernelKit team maintains an internal <a href="https://github.com/kernelkit/linux">fork of Linux kernel</a>,
with branches following the naming scheme <code>kkit-linux-[version].y</code>,
e.g. <code>kkit-6.12.y</code>, which means a new branch should be created whenever
@@ -2289,7 +2322,7 @@ kernel patches used by Infix.</p>
and updates. The upgrade of LTS minor releases is expected to have low
impact and should be done as soon as a patch release of the LTS Linux
kernel is available.</p>
<h4 id="repo-locally-cloned-already_1">Repo locally cloned already<a class="headerlink" href="#repo-locally-cloned-already_1" title="Permanent link">&para;</a></h4>
<h4 id="repo-locally-cloned-already_1">Repo locally cloned already<a class="headerlink" href="#repo-locally-cloned-already_1" title="Permanent link"></a></h4>
<ol>
<li>
<p>Navigate to the Linux kernel directory</p>
@@ -2307,7 +2340,7 @@ kernel is available.</p>
</code></pre></div>
</li>
</ol>
<h4 id="no-local-repo-yet_1">No local repo yet<a class="headerlink" href="#no-local-repo-yet_1" title="Permanent link">&para;</a></h4>
<h4 id="no-local-repo-yet_1">No local repo yet<a class="headerlink" href="#no-local-repo-yet_1" title="Permanent link"></a></h4>
<ol>
<li>
<p>Clone the KernelKit Linux kernel repository</p>
@@ -2325,7 +2358,7 @@ kernel is available.</p>
</code></pre></div>
</li>
</ol>
<h4 id="continue-here_1">Continue Here<a class="headerlink" href="#continue-here_1" title="Permanent link">&para;</a></h4>
<h4 id="continue-here_1">Continue Here<a class="headerlink" href="#continue-here_1" title="Permanent link"></a></h4>
<ol>
<li>
<p>Rebase on the upstream release</p>
@@ -2361,7 +2394,7 @@ cd output
<p>Remember to set the pull request label to <code>ci:main</code> to ensure full CI
coverage.</p>
</div>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent link">&para;</a></h2>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent link"></a></h2>
<p>Manual testing can be done using Qemu by calling <kbd>make run</kbd>,
see also <a href="../virtual/">Infix in Virtual Environments</a>, or on a physical
device by upgrading to the latest build or "<a href="../netboot/">netbooting</a>"
@@ -2375,7 +2408,7 @@ work is done -- <strong>much quicker</strong> change-load-test cycles.</p>
<p>With any new feature added to Infix, it is essential to include relevant
test case(s). See the <a href="../testing/#test-development">Test Development</a>
section for guidance on adding test cases.</p>
<h2 id="reviewing">Reviewing<a class="headerlink" href="#reviewing" title="Permanent link">&para;</a></h2>
<h2 id="reviewing">Reviewing<a class="headerlink" href="#reviewing" title="Permanent link"></a></h2>
<p>While reviewing a pull request, you might find yourself wanting to play
around with a VM running that <em>exact</em> version. For such occasions,
<a href="https://github.com/kernelkit/infix/blob/main/utils/gh-dl-artifact.sh">gh-dl-artifact.sh</a> is your friend in need! It employs the <a href="https://cli.github.com">GitHub
@@ -2398,7 +2431,7 @@ make run
branches. Therefore, the version in the Infix banner will not match
the SHA of the commit you have checked out.</p>
</div>
<h2 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h2>
<h2 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link"></a></h2>
<p>Infix is built from many components, when contributing you need to set
up your own fork, create a local branch for your change, push to your
fork, and then use GitHub to create a <em>Pull Reqeuest</em>.</p>
@@ -2426,14 +2459,14 @@ in the GUI for your fork for this purpose. A cronjob on your server
of choice can do this for you with the <a href="https://cli.github.com/">GitHub CLI tool</a>.</p>
</div>
<div class="footnote">
<hr />
<hr>
<ol>
<li id="fn:1">
<p>Organizations should make sure to lock the <code>main</code> (or <code>master</code>)
branch of their clones to ensure members do not accidentally merge
changes there. Keeping these branches in sync with upstream Infix
is highly recommended as a baseline and reference. For integration
of local changes another company-specific branch can be used instead.&#160;<a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">&#8617;</a></p>
of local changes another company-specific branch can be used instead.&nbsp;<a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">↩</a></p>
</li>
</ol>
</div>
@@ -2466,7 +2499,7 @@ of local changes another company-specific branch can be used instead.&#160;<a cl
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2022-2025 The KernelKit Team
Copyright © 2022-2025 The KernelKit Team
</div>
@@ -2492,5 +2525,7 @@ of local changes another company-specific branch can be used instead.&#160;<a cl
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>
<script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
document$.subscribe(()=>{ lightbox.reload(); });
</script></body></html>