GoogleContainerTools/skaffold

New flag --repo-prefix to backfill --default-repo functionality

Open

#4,321 opened on Jun 15, 2020

View on GitHub
 (2 comments) (4 reactions) (0 assignees)Go (12,822 stars) (1,416 forks)batch import
area/default-repobugbash/q4-2022fixithelp wantedjuly-chillkind/feature-requestneeds-design-proposalpriority/p2

Description

Expected behavior

Previously I had been using --default-repo more like --repo-prefix this all came to a grinding halt when I attempted to use the below skaffold.yaml. When I ran it with

skaffold build --default-repo=abc.123.com

I expected to see:

building abc.123.com/bases/go/1.13

building abc.123.com/bases/go/1.14

Actual behavior

building abc.123.com/bases_go_1.13

building abc.123.com/bases_go_1.14

Information

  • Skaffold version: v1.10.1
  • Operating system: Linux
  • Contents of skaffold.yaml:
apiVersion: skaffold/v1beta15
kind: Config

build:
  artifacts:
    - image: bases/go/1.13
      context: bases/go/multi
      docker:
        buildArgs:
          GO_VERSION:     "1.13"
          ALPINE_VERSION: "3.12"
    - image: bases/go/1.14
      context: bases/go/multi
      docker:
        buildArgs:
          GO_VERSION:     "1.14"
          ALPINE_VERSION: "3.12"

Proposal

We introduce a new flag --repo-prefix which doesn't mangle the image names for Docker Hub and simply applies the prefix.

Contributor guide

Tech stack
go
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingSkaffold CLI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at how ` default repo` is implemented in Skaffold's command line argument parsing (likely in `cmd/skaffold/app/cmd/build.go`). The new ` repo prefix` flag should apply the prefix to the image name without modifying slashes to underscores. Check the `build` command's flags and the image name handling in `pkg/skaffold/build/...` to ensure the prefix is prepended as is. The proposal is straightforward; verify there are no existing PRs addressing this.