Check for docker and kustomizer before dev:up#202
Open
ivanauth wants to merge 1 commit into
Open
Conversation
The dev environment helpers checkDocker and checkKustomizer were defined but never called, so a missing kustomizer binary only surfaced as a raw exec error after the kind cluster had already been provisioned. Run both checks up front so users get the install instructions immediately, and document the prerequisites in the README. Signed-off-by: ivanauth <ivan@authzed.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.
Fixes #177.
mage dev:uppreviously failed deep inside kind with a stack trace when docker or kustomizer was missing, giving no hint about the actual prerequisite. This checks for both up front so it fails fast with a clear install message, and documents the requirement in the README.dev.go: callcheckDocker()/checkKustomizer()at the start ofDev.Up(helpers already exist inutil.go).README.md: document Docker + kustomizer as dev prerequisites.BEFORE:
exec: "docker": executable file not found in $PATHburied under a ~20-line kind stack trace.AFTER:
docker must be installed to run kind - install with: brew install --cask docker.