https://flux9s.ca/Recent content on flux9sHugoenhttps://flux9s.ca/getting-started/installation/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/getting-started/installation/<h2 id="quick-install">Quick Install<a class="td-heading-self-link" href="#quick-install" aria-label="Heading self-link"></a></h2> <div><a id="td-block-0" class="td-anchor-no-extra-offset"></a></div> <section class="row td-box td-box--white td-box--height-auto"> <div class="col"> <div class="container"> <div class="col-lg-4 mb-5 mb-lg-0 text-center"> <div class="mb-4 h1"> <i class="fas fa-beer"></i> </div> <h4 class="h3">Homebrew</h4> <div class="mb-0"> <p>The easiest way to install on macOS and Linux:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>brew install dgunzy/tap/flux9s </span></span></code></pre></div><p>Or tap the repository first:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>brew tap dgunzy/tap </span></span><span style="display:flex;"><span>brew install flux9s </span></span></code></pre></div> </div> </div> <div class="col-lg-4 mb-5 mb-lg-0 text-center"> <div class="mb-4 h1"> <i class="fas fa-download"></i> </div> <h4 class="h3">cargo-binstall</h4> <div class="mb-0"> <p>If you have <a href="https://github.com/cargo-bins/cargo-binstall">cargo-binstall</a> installed:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>cargo binstall flux9s </span></span></code></pre></div><p>Downloads and installs pre-built binaries without compiling from source.</p> </div> </div> <div class="col-lg-4 mb-5 mb-lg-0 text-center"> <div class="mb-4 h1"> <i class="fas fa-box"></i> </div> <h4 class="h3">Crates.io</h4> <div class="mb-0"> <p>Install directly from crates.io:</p>https://flux9s.ca/user-guide/navigation/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/user-guide/navigation/<p>Every view lists the keys it supports in the footer, and <code>?</code> opens the full help (scroll it with <code>j</code>/<code>k</code>). The tables below are the reference.</p> <h2 id="keys">Keys<a class="td-heading-self-link" href="#keys" aria-label="Heading self-link"></a></h2> <h3 id="moving-around">Moving around<a class="td-heading-self-link" href="#moving-around" aria-label="Heading self-link"></a></h3> <table> <thead> <tr> <th>Key</th> <th>Action</th> </tr> </thead> <tbody> <tr> <td><code>j</code> / <code>k</code>, <code>↓</code> / <code>↑</code></td> <td>Move the selection, or scroll a text view</td> </tr> <tr> <td><code>Ctrl+f</code> / <code>Ctrl+b</code>, <code>PgDn</code> / <code>PgUp</code></td> <td>Page down / up</td> </tr> <tr> <td><code>Enter</code></td> <td>Open the selected item (detail, workload, graph node, event&rsquo;s object)</td> </tr> <tr> <td><code>Esc</code> / <code>q</code></td> <td>Go back to where you came from; at the top, asks before quitting</td> </tr> <tr> <td><code>Backspace</code></td> <td>Go back, without the quit prompt</td> </tr> <tr> <td><code>:</code></td> <td>Command mode (<code>Tab</code> autocompletes)</td> </tr> <tr> <td><code>/</code></td> <td>Filter a list, or search a text view</td> </tr> <tr> <td><code>0</code>–<code>9</code></td> <td>Switch to a <a href="https://flux9s.ca/configuration/#namespace-hotkeys">namespace hotkey</a></td> </tr> <tr> <td><code>?</code></td> <td>Show / hide help</td> </tr> <tr> <td><code>Q</code>, <code>Ctrl+C</code>, <code>:q</code></td> <td>Quit immediately</td> </tr> </tbody> </table> <p>A thin bar on a view&rsquo;s right border shows that it scrolls and where you are.</p>https://flux9s.ca/user-guide/flux-resources/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/user-guide/flux-resources/<h2 id="operations">Operations<a class="td-heading-self-link" href="#operations" aria-label="Heading self-link"></a></h2> <p>Select a resource in the list (or open its detail, YAML, or graph) and press:</p> <table> <thead> <tr> <th>Key</th> <th>Operation</th> <th>Applies to</th> </tr> </thead> <tbody> <tr> <td><code>s</code></td> <td>Suspend reconciliation</td> <td>Every kind with <code>spec.suspend</code> (sources, Kustomization, HelmRelease, image kinds, Alert, Provider, Receiver); Flux Operator kinds and ArtifactGenerator use their reconcile annotation, as <code>flux suspend</code> does. Not ExternalArtifact or FluxReport</td> </tr> <tr> <td><code>r</code></td> <td>Resume reconciliation</td> <td>Same as suspend</td> </tr> <tr> <td><code>R</code></td> <td>Reconcile now</td> <td>All Flux resources (not while suspended)</td> </tr> <tr> <td><code>W</code></td> <td>Reconcile with its source</td> <td>Kustomization, HelmRelease</td> </tr> <tr> <td><code>Ctrl+d</code></td> <td>Delete (asks first)</td> <td>All Flux resources</td> </tr> </tbody> </table> <p>Read-only mode (<code>readOnly: true</code>, or <code>:readonly</code> for the session) blocks every write.</p>https://flux9s.ca/user-guide/views/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/user-guide/views/<p>Every view here updates live while it&rsquo;s open, and stops watching when you leave it.</p> <h2 id="graph-g">Graph (<code>g</code>)<a class="td-heading-self-link" href="#graph-g" aria-label="Heading self-link"></a></h2> <p>For Kustomizations, HelmReleases, ResourceSets, FluxInstances, and ArtifactGenerators: the sources upstream and everything the resource manages downstream. Managed objects are grouped: Flux resources a ResourceSet produces appear as their own nodes, workloads gather in a <strong>workload group</strong>, and everything else in a <strong>resource group</strong> counted by kind.</p> <ul> <li><code>j</code> / <code>k</code> move the focus between nodes; the view follows it.</li> <li><code>Enter</code> opens the focused node; <code>y</code> / <code>d</code> show its YAML / describe output.</li> <li><code>Esc</code> returns to the graph from anything you opened there.</li> </ul> <p><img src="https://flux9s.ca/images/graph-screenshot.png" alt="Graph view"></p>https://flux9s.ca/user-guide/native-resources/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/user-guide/native-resources/<div class="alert alert-info" role="alert"><div class="h4 alert-heading" role="heading">Preview — off by default</div> <p>Browsing native resources and CRDs is a <strong>preview</strong> while it matures, so flux9s stays Flux-only unless you opt in:</p> <ul> <li><strong>For one session:</strong> <code>:native</code> (again to turn it off)</li> <li><strong>Permanently:</strong> <code>flux9s config set nativeResources true</code> (flux9s 1.2.0+)</li> </ul> <p>While it&rsquo;s off, flux9s makes no discovery calls and no extra watches, and <code>:deploy</code> and friends explain how to turn it on. Feedback is welcome — it becomes the default once it has had some mileage.</p>https://flux9s.ca/user-guide/command-line/Mon, 01 Jan 0001 00:00:00 +0000https://flux9s.ca/user-guide/command-line/<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#75715e"># Start the UI (current kubeconfig context)</span> </span></span><span style="display:flex;"><span>flux9s </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#75715e"># Use a specific kubeconfig file</span> </span></span><span style="display:flex;"><span>flux9s --kubeconfig /path/to/kubeconfig </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#75715e"># Check the connection and exit (0 = healthy) without starting the UI</span> </span></span><span style="display:flex;"><span>flux9s --check </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#75715e"># Debug logging (the log file path is printed at startup)</span> </span></span><span style="display:flex;"><span>flux9s --debug </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span><span style="color:#75715e"># Show the version</span> </span></span><span style="display:flex;"><span>flux9s --version </span></span></code></pre></div> <h2 id="start-command">Start on a view: <code>-c</code><a class="td-heading-self-link" href="#start-command" aria-label="Heading self-link"></a></h2> <p><code>-c</code> (<code>--command</code>) runs a <code>:</code> command once flux9s has connected, the way <code>k9s -c</code> does — anything you&rsquo;d type after <code>:</code>:</p>