Skip to content

docs(imageless-kubernetes): FloxHub login prereq + schema-aware runtime key - #139

Open
stephenyeargin wants to merge 1 commit into
mainfrom
dev-417-imageless-k8s-docs
Open

stephenyeargin wants to merge 1 commit into
mainfrom
dev-417-imageless-k8s-docs

Conversation

@stephenyeargin

Copy link
Copy Markdown
Member

What

Documentation updates from the containerd-shim-flox maintenance (DEV-351 / DEV-414), per DEV-417.

  • examples/kind-demo.mdx — add a Prerequisites section: Flox installed and flox auth login. The page previously jumped straight to flox activate -- just up, but the demo now requires a FloxHub login — just up copies your token into a Kubernetes secret and fails fast if you're not logged in. Links to Configuration for how that secret is created and mounted.
  • install/troubleshooting.mdx — clarify in the "Pods stuck in ContainerCreating" steps that the containerd runtime plugin id is schema-version dependent (io.containerd.grpc.v1.cri for config version = 2, io.containerd.cri.v1.runtime for version = 3/4), cross-referencing self-managed. Prevents misreading a correct config on newer containerd as "missing."

Why

Verifying the demo end-to-end on the released 1.1.0 shim surfaced that the public kind-demo page omitted the FloxHub login step a reader now needs, and the troubleshooting page only showed the legacy CRI key.

Checks

  • vale clean (0 errors/warnings/suggestions) on both files.
  • Internal links use existing routes (/install-flox/install, /man/flox-auth, /imageless-kubernetes/config, /imageless-kubernetes/install/self-managed).

Out of scope

install/eks.mdx registers only under the legacy grpc.v1.cri key; confirming whether EKS needs the cri.v1.runtime key depends on the EKS AMI's containerd config schema. Folded into DEV-349 (validate EKS support with current containerd versions).

Refs DEV-417.

🤖 Generated with Claude Code

…e runtime key

Add a Prerequisites section to the kind demo page — Flox installed plus
`flox auth login` — and explain that `just up` creates the FloxHub-token
secret for you and stops if you are not logged in. Previously the page
jumped straight to `just up`, which now fails fast without a login.

Clarify in troubleshooting that the containerd runtime plugin id depends
on the config schema version (`io.containerd.grpc.v1.cri` for v2,
`io.containerd.cri.v1.runtime` for v3/4), cross-referencing self-managed.

Refs DEV-417.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
flox 🟢 Ready View Preview Oct 26, 2026, 8:44 PM

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

This branch was successfully deployed

1 active deployment
staging — fb09f1a5 Deployed Oct 26, 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