README: clone-free one-command deploy - #16
Merged
Conversation
The deploy section showed 'kubectl apply -k deploy/...' — which requires a clone — and sat at line 422 where nobody scrolls. Now: - Quick start links straight to the deploy section and offers docker run ghcr.io/runcaptain/compass:latest as a zero-build path - The deploy section leads with the clone-free form (kustomize consuming the GitHub URL directly, pinned via ?ref=), verified to build all 14 objects remotely - The minio-dev overlay now pulls the published ghcr image (IfNotPresent, so offline devs importing a local image under the same name keep working) instead of assuming a locally imported image — without this, a remote apply schedules pods that can never pull Signed-off-by: Edgar Babajanyan <bedgar2005@gmail.com>
The deploy story deserves the same prominence as the license and CI badges — a Kubernetes badge jumping to the one-command section, and a ghcr badge linking to the published image. Signed-off-by: Edgar Babajanyan <bedgar2005@gmail.com>
Signed-off-by: Edgar Babajanyan <bedgar2005@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.
Problem
The README's deploy section required a clone (
kubectl apply -k deploy/...), was buried at line 422, and the dev overlay referenced a locally-imported image — so the advertised "one command" did not survive contact with a stranger's cluster.Fix
docker run ghcr.io/runcaptain/compass:latestas the zero-build path.kubectl apply -k "https://github.com/runcaptain/compass//deploy/kubernetes/overlays/minio-dev?ref=main"minio-devoverlay pulls the publishedghcr.io/runcaptain/compass:latest(IfNotPresent, preserving the offline local-import flow) instead of assuming an imported image.Notes
?ref=mainbecomes?ref=v0.4.1in the docs at the next tag, pinning deployments to releases.