Ship a reference cell image instead of telling everyone to bake one - #9
Merged
Conversation
… one The quickstart's largest prerequisite was "build a cell image" — roughly an hour of baking a 30 GiB disk — while the image this project's own hardware validation ran on was sitting published and, since the packages were made public, pullable by anyone. Nothing pointed at it. config/samples/swiftimage-cell.yaml now does. Verified before documenting rather than after: anonymous pull returns 200 with artifactType application/vnd.kubeswift.vmimage.v1 (11 GiB, 44 layers), and the SwiftImage reaches Ready on a cluster with NO pull secret in the namespace — which mattered, because every earlier import in this project used one and the very first step of the quickstart now depends on that no longer being true. Labelled for what it is, not oversold: driver 580.173.02 from the PROPRIETARY branch because it was chosen for a Pascal card, and k0s node binaries. A kubeadm, RKE2 or k3s user gets the driver and container toolkit they need but not their node binaries, so they install those from the join cloud-init or bake for their distribution. docs/cell-image.md now leads with using the published image and keeps the build path for when it is the wrong image. Also links each tracked gap in docs/limitations.md to its issue (#2 rolling update, #3 outer-drain sequencing, #4 HAMi DRA mode, #5 multi-cell hardware validation), so a reader can see whether something is being worked on instead of only being told it is missing. Signed-off-by: William Rizzo <william.rizzo@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The quickstart's largest prerequisite was "build a cell image" — about an hour of baking a 30 GiB disk — while the image this project's own hardware validation ran on was already published and, since the packages went public, pullable by anyone. Nothing pointed at it.
config/samples/swiftimage-cell.yamlnow does, so the prerequisite becomes:Verified before documenting, not after
artifactType: application/vnd.kubeswift.vmimage.v1, 11 GiB across 44 layers.SwiftImagereaches Ready on a cluster with no pull secret in the namespace —Importing → Validating → Readyin ~7 minutes, prepared as a 30Gi raw artifact.That last check mattered: every earlier import in this project used a
credentialsSecretRef, and the first step of the quickstart now depends on that no longer being necessary. Had it failed, the claim would have come straight back out.Labelled for what it is
Two things pin the image, and either can make it the wrong choice:
docs/cell-image.mdnow leads with using the published image and keeps the build path for when it is the wrong one.Also
docs/limitations.mdlinks each tracked gap to its issue (#2 rolling update, #3 outer-drain sequencing, #4 HAMi DRA mode, #5 multi-cell hardware validation), so a reader can tell whether something is being worked on rather than only that it is missing.🤖 Generated with Claude Code