Skip to content

docs(imageless-kubernetes): fix self-managed install for K3s and add verification - #142

Merged
devusb merged 3 commits into
mainfrom
docs/imageless-k3s-self-managed
Nov 3, 2026
Merged

devusb merged 3 commits into
mainfrom
docs/imageless-k3s-self-managed

Conversation

@devusb

@devusb devusb commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Fixes the self-managed Imageless Kubernetes install page so it works as written on a fresh K3s node, and adds steps that confirm the install worked.

Changes

  • Manual installation
    • Shows how to check the containerd version, including sudo k3s ctr version on K3s.
    • Notes that flox install of the shim requires a FloxHub sign-in (flox auth login or FLOX_FLOXHUB_TOKEN).
    • Fixes the symlink glob: the environment directory ends in -run, not .run. The old glob silently created a dangling link.
    • Adds a readlink -e check for the symlink.
  • Register the shim with containerd: a new top-level tab set.
    • containerd: the existing config.toml blocks, then restart containerd.
    • K3s: write config-v3.toml.tmpl with the K3s base template (K3s regenerates config.toml on each start), restart k3s or k3s-agent, then grep the generated config.
  • Automatic installation
    • Generate /etc/containerd/config.toml if it's missing (Ubuntu's containerd package doesn't create it).
    • Lists the output lines that confirm success, because the command exits 0 even when the installer fails.
  • Kubernetes configuration: notes that kubectl needs sudo with the default K3s kubeconfig.
  • Conclusion: apply the sample Pod, wait for Ready, and check the logs for Listening on http://:8080.

Testing

Each new command was run on fresh Ubuntu 24.04 nodes, with Flox 1.19.2 and shim/installer 1.1.0:

  • K3s v1.36.5+k3s1 (bundled containerd 2.3.4): the manual path with the template, restart and grep. The sample Pod ran and served HTTP.
  • kubeadm v1.37.2 (Ubuntu containerd 2.2.1): the automatic installer, the missing-config error, the re-run no-op, and the verification steps.

mint broken-links reports the same 3 pre-existing broken links on other pages before and after.

@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
flox 🟢 Ready View Preview Nov 1, 2026, 4:49 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

The manual installation steps now work on a fresh node. They note that
installing the shim from the catalog requires a FloxHub sign-in, fix the
symlink path to match the environment's `-run` directory, and show how to
check the containerd version, including on K3s.

K3s gets its own configuration steps: the Flox runtime goes in a
containerd config template, since K3s regenerates config.toml on every
start, and K3s is restarted instead of a containerd service.
…ation steps

The automatic installer section now lists the output lines that confirm
the shim was installed, and shows how to generate
/etc/containerd/config.toml when the installer reports it missing, as
happens with containerd packages such as Ubuntu's.

The page now ends with steps to apply the sample Pod and check its logs,
and notes that kubectl needs sudo with the default K3s kubeconfig.
The steps that differ between distributions now sit in one set of
top-level tabs, "containerd" and "K3s", following the platform tabs used
on the Flox install pages. Creating the environment and linking the shim
stay as shared steps above the tabs.
@devusb
devusb force-pushed the docs/imageless-k3s-self-managed branch from f85d987 to f493714 Compare November 1, 2026 16:49
@devusb
devusb marked this pull request as ready for review November 1, 2026 16:50
@devusb
devusb added this pull request to the merge queue Nov 3, 2026
Merged via the queue into main with commit 73a1353 Nov 3, 2026
6 checks passed
@devusb
devusb deleted the docs/imageless-k3s-self-managed branch November 3, 2026 17:18

This branch was successfully deployed

1 active deployment
staging — f4937145 Deployed Nov 1, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants