fix(ko): Default repo for pushing ko:// images
#7010
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #7010 +/- ##
==========================================
- Coverage 70.48% 68.79% -1.70%
==========================================
Files 515 554 +39
Lines 23150 25695 +2545
==========================================
+ Hits 16317 17676 +1359
- Misses 5776 6820 +1044
- Partials 1057 1199 +142
Continue to review full report at Codecov.
|
When using the `ko://` scheme prefix for the Skaffold image name, the rest of the image name, following the prefix, is a Go import path. This import path maps to the Git repository (typically), and won't match an image registry name (e.g., `ko://github.com/org/repo` vs `gcr.io/project_id`). With this change, if _all_ of the following are true, the build results in an error that instructs the user to set the default repo: - the image name in `skaffold.yaml` uses the `ko://` prefix; and - the Skaffold default repo is _not_ set; and - the image is being pushed to a registry (rather than sideloaded to a Docker daemon). Fixes: GoogleContainerTools#6933 Tracking: GoogleContainerTools#6041
| @@ -37,6 +37,9 @@ import ( | |||
| // identifier. The image identifier is the tag or digest for pushed images, or | |||
| // the docker image ID for sideloaded images. | |||
| func (b *Builder) Build(ctx context.Context, out io.Writer, a *latestV1.Artifact, ref string) (string, error) { | |||
| if b.pushImages && strings.HasPrefix(ref, build.StrictScheme) { | |||
| return "", fmt.Errorf("default repo must be set when using the 'ko://' prefix and pushing to a registry: %s, see https://skaffold.dev/docs/environment/image-registries/", a.ImageName) | |||
There was a problem hiding this comment.
nit: perhaps this information should be on the docs page as well - eg: NOTE: the ko builder requires using the default repo flag as ...
There was a problem hiding this comment.
Thanks @aaron-prindle, good point. I just pushed another commit to update the docs.
Document that `ko` builder users who use the `ko://` prefix must set the default repo if pushing images to a registry. Related: GoogleContainerTools#6933 Tracking: GoogleContainerTools#6041
MarlonGamez
approved these changes
Jan 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When using the
ko://scheme prefix for the Skaffold image name, the rest of the image name that follows the prefix, is a Go import path.This import path maps to the Git repository location (typically), and won't match an image registry name (e.g.,
ko://github.com/org/repovsgcr.io/project_id). Currently, the result is a hard-to-understand error resulting from a failed push to the non-existent host calledko(see #6933).With this change, if all of the following are true, the build results in an error that instructs the user to set the default repo:
skaffold.yamluses theko://prefix; andFixes: #6933
Tracking: #6041